Package org.glassfish.admin.amx.base

Interface RuntimeRoot

All Superinterfaces:

AMX_SPI, AMXProxy, Singleton, Utility

@Taxonomy(stability=UNCOMMITTED)
@AMXMBeanMetadata(type="runtime",
                  singleton=true,
                  globalSingleton=true)
public interface RuntimeRoot
extends AMXProxy, Utility, Singleton

Since:

GlassFish V3

Field Summary

Fields

Modifier and Type	Field	Description
static String	DD_CONTENT_KEY	The key to store the deployment descriptor content in the deployment descriptor map.
static String	DD_PATH_KEY	The key to store the deployment descriptor path in the deployment descriptor map.
static String	MODULE_NAME_KEY	The key to store the module name in the deployment descriptor map.

Method Summary

Modifier and Type	Method	Description
String	executeREST(String command)	Execute a REST command.
String	getContextRoot(String applicationName, String moduleName)	Return the context root of a specified module.
List<Map<String,String>>	getDeploymentConfigurations(String applicationName)	Return a list of deployment descriptor maps for the specified application.
String[]	getJMXServiceURLs()
String	getJVMReport(String which)	Which: all | summary | memory| class | thread log
String	getRESTBaseURL()	Return the base URL for use with executeREST(java.lang.String).
Map<String,ServerRuntime>	getServerRuntime()
Map<String,String>	getSubComponentsOfModule(String applicationName, String moduleName)	Return the subcomponents (ejb/web) of a specified module.
String[]	getSupportedCipherSuites()
boolean	isStartedInDebugMode()
void	restartDomain()
void	stopDomain()

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

MODULE_NAME_KEY

static final String MODULE_NAME_KEY

The key to store the module name in the deployment descriptor map.

See Also:

getDeploymentConfigurations(java.lang.String), Constant Field Values

DD_PATH_KEY

static final String DD_PATH_KEY

The key to store the deployment descriptor path in the deployment descriptor map.

See Also:

getDeploymentConfigurations(java.lang.String), Constant Field Values

DD_CONTENT_KEY

static final String DD_CONTENT_KEY

The key to store the deployment descriptor content in the deployment descriptor map.

See Also:

getDeploymentConfigurations(java.lang.String), Constant Field Values

Method Detail

stopDomain

@ManagedOperation(impact=1)
void stopDomain()

restartDomain

@ManagedOperation(impact=1)
void restartDomain()

getDeploymentConfigurations

@ManagedOperation(impact=0)
List<Map<String,String>> getDeploymentConfigurations(@Param(name="applicationName")
                                                           String applicationName)

Return a list of deployment descriptor maps for the specified application. In each map: a. The module name is stored by the MODULE_NAME_KEY. b. The path of the deployment descriptor is stored by the DD_PATH_KEY. c. The content of the deployment descriptor is stored by the DD_CONTENT_KEY.

Parameters:

the - application name

Returns:

the list of deployment descriptor maps

getSubComponentsOfModule

@ManagedOperation(impact=0)
Map<String,String> getSubComponentsOfModule(@Param(name="applicationName")
                                                  String applicationName,
                                                  @Param(name="moduleName")
                                                  String moduleName)

Return the subcomponents (ejb/web) of a specified module.

Parameters:

applicationName - the application name

moduleName - the module name

Returns:

a map of the sub components, where the key is the component name and the value is the component type

getContextRoot

@ManagedOperation(impact=0)
String getContextRoot(@Param(name="applicationName")
                      String applicationName,
                      @Param(name="moduleName")
                      String moduleName)

Return the context root of a specified module.

Parameters:

applicationName - the application name

moduleName - the module name

Returns:

the context root of a specified module

executeREST

@ManagedOperation(impact=1)
String executeREST(@Param(name="command")
                   String command)

Execute a REST command. Do not include a leading "/".

getRESTBaseURL

@ManagedAttribute
String getRESTBaseURL()

Return the base URL for use with executeREST(java.lang.String). Example: http://localhost:4848/__asadmin/ Example only, the host and port are typically different. A trailing "/" is included; simply append the command string and call executeREST(java.lang.String).

getSupportedCipherSuites

@ManagedAttribute
String[] getSupportedCipherSuites()

getJMXServiceURLs

@ManagedAttribute
@Description("Return the available JMXServiceURLs in no particular order")
String[] getJMXServiceURLs()

getJVMReport

@ManagedOperation(impact=0)
@Description("Return a summary report of the specified type")
String getJVMReport(@Param(name="which")
                    String which)

Which: all | summary | memory| class | thread log

getServerRuntime

@ManagedAttribute
Map<String,ServerRuntime> getServerRuntime()

isStartedInDebugMode

@ManagedAttribute
@Description("Whether the server was started with --debug")
boolean isStartedInDebugMode()