Package org.glassfish.admin.amx.base
Interface DomainRoot
-
@Taxonomy(stability=UNCOMMITTED) @AMXMBeanMetadata(singleton=true, globalSingleton=true) public interface DomainRoot extends AMXProxy
The top-level interface for an appserver domain. Access to all otherAMXProxy
begins here.Not all children of DomainRoot have getter method; they could be added dynamically.
The 'name' property in the ObjectName of DomainRoot is the name of the appserver domain. For example, appserver domains 'domain' and 'domain2' would have ObjectNames for DomainRoot as follows:
amx:type=DomainRoot:name=domain1 amx:type=DomainRoot:name=domain2
Of course, these two MBeans would normally be found in different MBeanServers.
-
-
Field Summary
Fields Modifier and Type Field Description static String
AMX_READY_NOTIFICATION_TYPE
Notification type for JMX Notification issued when AMX MBeans are loaded and ready for use.static String
PARENT_PATH
static String
PATH
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
getAMXReady()
Poll to see if AMX is ready for use.String
getApplicationServerFullVersion()
String
getAppserverDomainName()
Return the name of this appserver domain.BulkAccess
getBulkAccess()
Map<ObjectName,List<String>>
getComplianceFailures()
Return a Map of all non-compliant MBeans (MBeans might no longer be registered).String
getConfigDir()
String
getDebugPort()
AMXConfigProxy
getDomain()
Get the DomainConfig.String
getDomainDir()
Ext
getExt()
Return theExt
MBean, parent of top-level utility and specialty MBeans.String
getInstallDir()
String
getInstanceRoot()
AMXProxy
getJ2EEDomain()
For module dependency reasons, the returned object must be cast to the appropriate type, as it cannot be used here.Logging
getLogging()
MonitoringRoot
getMonitoringRoot()
Pathnames
getPathnames()
Query
getQueryMgr()
RuntimeRoot
getRuntime()
Sample
getSample()
SystemInfo
getSystemInfo()
Tools
getTools()
Return theTools
MBean.Object[]
getUptimeMillis()
Return the time the domain admin server has been running.void
stopDomain()
void
waitAMXReady()
Wait (block) until AMX is ready for use.-
Methods inherited from interface org.glassfish.admin.amx.core.AMX_SPI
getChildren, getName, getParent
-
Methods inherited from interface org.glassfish.admin.amx.core.AMXProxy
as, attributeNames, attributesMap, attributesMap, child, child, childrenMap, childrenMap, childrenMaps, childrenSet, extra, invokeOp, invokeOp, java, nameProp, objectName, parent, parentPath, path, type, valid
-
-
-
-
Field Detail
-
PARENT_PATH
static final String PARENT_PATH
- See Also:
- Constant Field Values
-
PATH
static final String PATH
- 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
-
stopDomain
@ManagedOperation(impact=1) @Description("Stop the domain immediately") void stopDomain()
-
getExt
@ManagedAttribute @Description("Get the primary extension point for AMX MBeans other than monitoring") Ext getExt()
Return theExt
MBean, parent of top-level utility and specialty MBeans.
-
getTools
@ManagedAttribute @Description("Get the Tools MBean") Tools getTools()
Return theTools
MBean.
-
getQueryMgr
@ManagedAttribute @Description("Get the Query MBean") Query getQueryMgr()
- Returns:
- the singleton
Query
.
-
getLogging
@ManagedAttribute @Description("Get the Logging MBean") Logging getLogging()
- Returns:
- the singleton
Logging
.
-
getBulkAccess
@ManagedAttribute @Description("Get the BulkAccess MBean") BulkAccess getBulkAccess()
- Returns:
- the singleton
BulkAccess
.
-
getPathnames
@ManagedAttribute Pathnames getPathnames()
- Returns:
- the singleton
Pathnames
.
-
getSample
@ManagedAttribute Sample getSample()
- Returns:
- the singleton
Sample
.
-
getAppserverDomainName
@ManagedAttribute 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 callingUtil#getObjectName
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
@ManagedAttribute AMXProxy getJ2EEDomain()
For module dependency reasons, the returned object must be cast to the appropriate type, as it cannot be used here.- Returns:
- the JSR 77 J2EEDomain.
-
getDomain
@ManagedAttribute AMXConfigProxy getDomain()
Get the DomainConfig. For module dependency reasons, the returned object must be converted (if desired) to DomainConfig using getDomain().as(DomainConfig.class).- Returns:
- the singleton DomainConfig
-
getMonitoringRoot
@ManagedAttribute @Description("Get the root MBean of all monitoring MBeans") MonitoringRoot getMonitoringRoot()
- Returns:
- the singleton
MonitoringRoot
.
-
getRuntime
@ManagedAttribute @Description("Get the root MBean of all runtime MBeans") RuntimeRoot getRuntime()
-
getSystemInfo
@ManagedAttribute SystemInfo getSystemInfo()
- Returns:
- the singleton SystemInfo
-
getAMXReady
@ManagedAttribute boolean getAMXReady()
Poll to see if AMX is ready for use. It is more efficient to instead listen for a Notification of typeAMX_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
@ManagedOperation(impact=0) void waitAMXReady()
Wait (block) until AMX is ready for use. Upon return, AMX is ready for use.
-
getDebugPort
@ManagedAttribute String getDebugPort()
- Since:
- Glassfish V3
-
getApplicationServerFullVersion
@ManagedAttribute String getApplicationServerFullVersion()
- Since:
- Glassfish V3
-
getInstanceRoot
@ManagedAttribute String getInstanceRoot()
- Since:
- Glassfish V3
-
getDomainDir
@ManagedAttribute String getDomainDir()
- Returns:
- the directory for the domain
- Since:
- Glassfish V3
-
getConfigDir
@ManagedAttribute String getConfigDir()
- Returns:
- the configuration directory, typically 'config' subdirectory of
getDomainDir()
- Since:
- Glassfish V3
-
getInstallDir
@ManagedAttribute @Description("the installation directory") String getInstallDir()
- Returns:
- the installation directory
- Since:
- Glassfish V3
-
getUptimeMillis
@ManagedAttribute @Description("Return the time the domain admin server has been running. uptime[0] contains the time in milliseconds. uptime[1] contains a human-readable string describing the duration.") Object[] getUptimeMillis()
Return the time the domain admin server has been running. uptime[0] contains the time in milliseconds. uptime[1] contains a human-readable string describing the duration.
-
getComplianceFailures
@ManagedAttribute @Description("Return a Map of all non-compliant MBeans (MBeans might no longer be registered). The List<String> contains all issues with that MBean") Map<ObjectName,List<String>> getComplianceFailures()
Return a Map of all non-compliant MBeans (MBeans might no longer be registered). The List<String> contains all issues with that MBean.- Since:
- Glassfish V3
-
-