com.sun.appserv.management
Interface DomainRoot

All Superinterfaces:

AMX, AMXMBeanLogging, Container, NotificationBroadcaster, NotificationEmitter

public interface DomainRoot
extends Container

The top-level interface for an appserver domain. Access to all other AMX begins here.

Field Summary

static String	AMX_READY_NOTIFICATION_TYPE Notification type for JMX Notification issued when AMX MBeans are loaded and ready for use.
static String	J2EE_TYPE

Fields inherited from interface com.sun.appserv.management.base.Container

ATTR_CONTAINEE_J2EE_TYPES

Fields inherited from interface com.sun.appserv.management.base.AMX

FULL_TYPE_DELIM, GROUP_CONFIGURATION, GROUP_JSR77, GROUP_MONITORING, GROUP_OTHER, GROUP_UTILITY, J2EE_TYPE_KEY, JMX_DOMAIN, NAME_KEY, NO_NAME, NOTIFICATION_PREFIX, NULL_NAME

Method Summary

boolean	getAMXReady() Poll to see if AMX is ready for use.
String	getAppserverDomainName() Return the name of this appserver domain.
BulkAccess	getBulkAccess()
ConfigDottedNames	getConfigDottedNames()
DeploymentMgr	getDeploymentMgr()
DomainConfig	getDomainConfig()
NotificationEmitterService	getDomainNotificationEmitterService() Get the NotificationEmitterService whose name is NotificationEmitterServiceKeys.DOMAIN_KEY.
J2EEDomain	getJ2EEDomain()
JMXMonitorMgr	getJMXMonitorMgr()
Map<String,LoadBalancer>	getLoadBalancerMap() Get all the LoadBalancer instances
MonitoringDottedNames	getMonitoringDottedNames()
MonitoringRoot	getMonitoringRoot()
Map<String,NotificationEmitterService>	getNotificationEmitterServiceMap() Get all NotificationEmitterService instances.
NotificationServiceMgr	getNotificationServiceMgr() Get the NotificationServiceMgr
QueryMgr	getQueryMgr()
SystemInfo	getSystemInfo()
UploadDownloadMgr	getUploadDownloadMgr()
WebServiceMgr	getWebServiceMgr()
void	waitAMXReady() Wait (block) until AMX is ready for use.

Methods inherited from interface com.sun.appserv.management.base.Container

getByNameContaineeSet, getContainee, getContainee, getContaineeJ2EETypes, getContaineeMap, getContaineeSet, getContaineeSet, getContaineeSet, getMultiContaineeMap

Methods inherited from interface com.sun.appserv.management.base.AMX

getContainer, getDomainRoot, getFullType, getGroup, getJ2EEType, getName, isDAS

Methods inherited from interface javax.management.NotificationEmitter

removeNotificationListener

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface com.sun.appserv.management.base.AMXMBeanLogging

getMBeanLoggerName, getMBeanLogLevel, setMBeanLogLevel

Field Detail

J2EE_TYPE

static final String J2EE_TYPE

See Also:

Constant Field Values

AMX_READY_NOTIFICATION_TYPE

static final String AMX_READY_NOTIFICATION_TYPE

Notification type for JMX Notification issued when AMX MBeans are loaded and ready for use.

See Also:

getAMXReady(), Constant Field Values

Method Detail

getAppserverDomainName

String getAppserverDomainName()

Return the name of this appserver domain. Not to be confused with the JMX domain name, which may be derived from this name and is available from any ObjectName in AMX by calling Util.getObjectName(T) The domain name is equivalent to the name of the directory containing the domain configuration. This name is not part of the configuration and can only be changed by using a different directory to house the configuration for the domain.

Returns:

the name of the Appserver domain

getJ2EEDomain

J2EEDomain getJ2EEDomain()

Returns:

the JSR 77 J2EEDomain.

getDomainConfig

DomainConfig getDomainConfig()

Returns:

the singleton DomainConfig

getJMXMonitorMgr

JMXMonitorMgr getJMXMonitorMgr()

Returns:

the singleton JMXMonitorMgr

getNotificationServiceMgr

NotificationServiceMgr getNotificationServiceMgr()

Get the NotificationServiceMgr

getSystemInfo

SystemInfo getSystemInfo()

Returns:

the singleton SystemInfo

getWebServiceMgr

WebServiceMgr getWebServiceMgr()

Returns:

the singleton WebServiceMgr for this domain.

Since:

AppServer 9.0

getNotificationEmitterServiceMap

Map<String,NotificationEmitterService> getNotificationEmitterServiceMap()

Get all NotificationEmitterService instances. Possible kinds include those defined in NotificationEmitterServiceKeys.

Since:

AppServer 9.0

getDomainNotificationEmitterService

NotificationEmitterService getDomainNotificationEmitterService()

Get the NotificationEmitterService whose name is NotificationEmitterServiceKeys.DOMAIN_KEY. Same as calling getNotificationEmitterServiceMap().get( DOMAIN_KEY ).

Returns:

the singleton NotificationEmitterService.

getQueryMgr

QueryMgr getQueryMgr()

Returns:

the singleton QueryMgr.

getBulkAccess

BulkAccess getBulkAccess()

Returns:

the singleton BulkAccess.

getUploadDownloadMgr

UploadDownloadMgr getUploadDownloadMgr()

Returns:

the singleton UploadDownloadMgr.

getConfigDottedNames

ConfigDottedNames getConfigDottedNames()

Returns:

the singleton ConfigDottedNames.

getMonitoringDottedNames

MonitoringDottedNames getMonitoringDottedNames()

Returns:

the singleton MonitoringDottedNames

getMonitoringRoot

MonitoringRoot getMonitoringRoot()

Returns:

the singleton MonitoringRoot.

getDeploymentMgr

DeploymentMgr getDeploymentMgr()

Returns:

the singleton DeploymentMgr.

getLoadBalancerMap

Map<String,LoadBalancer> getLoadBalancerMap()

Get all the LoadBalancer instances

Returns:

Map of items, keyed by name.

Since:

AppServer 9.0

See Also:

LoadBalancer, LoadBalancerConfig

getAMXReady

boolean getAMXReady()

Poll to see if AMX is ready for use. It is more efficient to instead listen for a Notification of type AMX_READY_NOTIFICATION_TYPE. That should be done by first registering the listener, then checking just after registration in case the Notification was issued in the ensuing interval just before the listener became registered.

Returns:

true if AMX is ready for use, false otherwise.

See Also:

AMX_READY_NOTIFICATION_TYPE

waitAMXReady

void waitAMXReady()

Wait (block) until AMX is ready for use. Upon return, AMX is ready for use.