org.rhq.common.jbossas.client.controller

Class CoreJBossASClient

java.lang.Object

org.rhq.common.jbossas.client.controller.JBossASClient

org.rhq.common.jbossas.client.controller.CoreJBossASClient

public class CoreJBossASClient
extends JBossASClient

Provides information to some core services.

Author:

John Mazzitelli

Field Summary

Fields

Modifier and Type	Field and Description
static String	CORE_SERVICE
static String	CORE_SERVICE_MGMT
static String	DEPLOYMENT_SCANNER
static String	EXTENSION
static String	MGMT_INTERFACE
static String	MGMT_INTERFACE_HTTP
static String	MODULE
static String	PLATFORM_MBEAN
static String	SCANNER
static String	SERVER_ENVIRONMENT

Fields inherited from class org.rhq.common.jbossas.client.controller.JBossASClient

ADD, ADDRESS, BATCH, BATCH_STEPS, FAILURE_DESCRIPTION, log, NAME, OPERATION, OUTCOME, OUTCOME_SUCCESS, PERSISTENT, READ_ATTRIBUTE, READ_RESOURCE, REMOVE, RESULT, SUBSYSTEM, SYSTEM_PROPERTY, VALUE, WRITE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
CoreJBossASClient(org.jboss.as.controller.client.ModelControllerClient client)

Method Summary

Methods

Modifier and Type	Method and Description
void	addExtension(String name) Adds a new module extension to the core system.
void	addSubsystem(String name) Adds a new subsystem to the core system.
void	addSubsystem(String name, org.jboss.dmr.ModelNode settings) Adds a new subsystem (along with some optional settings for that subsystem) to the core system If settings is null, the subsystem will be created with no additional settings associated with it.
String	getAppServerBaseDir()
String	getAppServerConfigDir()
String	getAppServerDataDir()
String	getAppServerDefaultDeploymentDir() Returns the location where the default deployment scanner is pointing to.
String	getAppServerHomeDir()
String	getAppServerLogDir()
String	getAppServerTmpDir()
String	getAppServerVersion()
String	getOperatingSystem()
String	getServerProductName()
String	getServerProductVersion()
Properties	getSystemProperties() This returns the system properties that are set in the AS JVM.
boolean	isExtension(String name) Returns true if the given extension is already in existence.
boolean	isSubsystem(String name) Returns true if the given subsystem is already in existence.
void	reload() Invokes the management "reload" operation which will shut down all the app server services and restart them again.
void	reload(boolean adminOnly) Invokes the management "reload" operation which will shut down all the app server services and restart them again potentially in admin-only mode.
String	resolveExpression(String expression) Given a string with possible ${x} expressions in it, this will resolve that expression using system property values that are set within the AS JVM itself.
void	restart() Invokes the management "shutdown" operation with the restart option set to true (see shutdown(boolean)).
void	setAppServerDefaultDeploymentScanEnabled(boolean enabled) Enabled or disables the default deployment scanner.
void	setAppServerDefaultDeploymentScanInterval(long millis) Sets the interval of the default deployment scanner.
void	setAppServerDefaultDeploymentTimeout(long secs) Sets the deployment timeout of the default deployment scanner.
void	setEnableAdminConsole(boolean enableFlag) Allows the caller to turn on or off complete access for the app server's admin console.
void	setSystemProperty(String name, String value) Set a runtime system property in the JVM that is managed by JBossAS.
void	shutdown(boolean restart) Invokes the management "shutdown" operation that kills the JVM completely with System.exit.

Methods inherited from class org.rhq.common.jbossas.client.controller.JBossASClient

createBatchRequest, createReadAttributeRequest, createReadAttributeRequest, createRequest, createRequest, createWriteAttributeRequest, execute, findNodeInList, getFailureDescription, getModelControllerClient, getResultListAsStrings, getResults, getStringAttribute, getStringAttribute, isSuccess, readResource, readResource, remove, setPossibleExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CORE_SERVICE

public static final String CORE_SERVICE

See Also:

Constant Field Values

SERVER_ENVIRONMENT

public static final String SERVER_ENVIRONMENT

See Also:

Constant Field Values

PLATFORM_MBEAN

public static final String PLATFORM_MBEAN

See Also:

Constant Field Values

DEPLOYMENT_SCANNER

public static final String DEPLOYMENT_SCANNER

See Also:

Constant Field Values

SCANNER

public static final String SCANNER

See Also:

Constant Field Values

EXTENSION

public static final String EXTENSION

See Also:

Constant Field Values

MODULE

public static final String MODULE

See Also:

Constant Field Values

CORE_SERVICE_MGMT

public static final String CORE_SERVICE_MGMT

See Also:

Constant Field Values

MGMT_INTERFACE

public static final String MGMT_INTERFACE

See Also:

Constant Field Values

MGMT_INTERFACE_HTTP

public static final String MGMT_INTERFACE_HTTP

See Also:

Constant Field Values

Constructor Detail

CoreJBossASClient

public CoreJBossASClient(org.jboss.as.controller.client.ModelControllerClient client)

Method Detail

setEnableAdminConsole

public void setEnableAdminConsole(boolean enableFlag)
                           throws Exception

Allows the caller to turn on or off complete access for the app server's admin console.

Parameters:

enableFlag - true if the admin console enabled and visible; false if you want to prohibit all access to the admin console

Throws:

Exception

resolveExpression

public String resolveExpression(String expression)
                         throws Exception

Given a string with possible ${x} expressions in it, this will resolve that expression using system property values that are set within the AS JVM itself. If the string to resolve has no expressions, or has no expressions that are resolveable, the expression string itself is returned as-is (this includes if expression is null).

Parameters:

expression - string containing zero, one or more ${x} expressions to be resolved

Returns:

the expression with the expressions resolved using system properties of the AS JVM

Throws:

Exception - if failed to resolve the expression.

getSystemProperties

public Properties getSystemProperties()
                               throws Exception

This returns the system properties that are set in the AS JVM. This is not the system properties in the JVM of this client object - it is actually the system properties in the remote JVM of the AS instance that the client is talking to.

Returns:

the AS JVM's system properties

Throws:

Exception

getOperatingSystem

public String getOperatingSystem()
                          throws Exception

Throws:

Exception

getAppServerVersion

public String getAppServerVersion()
                           throws Exception

Throws:

Exception

getServerProductVersion

public String getServerProductVersion()
                               throws Exception

Throws:

Exception

getServerProductName

public String getServerProductName()
                            throws Exception

Throws:

Exception

getAppServerHomeDir

public String getAppServerHomeDir()
                           throws Exception

Throws:

Exception

getAppServerDataDir

public String getAppServerDataDir()
                           throws Exception

Throws:

Exception

getAppServerBaseDir

public String getAppServerBaseDir()
                           throws Exception

Throws:

Exception

getAppServerConfigDir

public String getAppServerConfigDir()
                             throws Exception

Throws:

Exception

getAppServerLogDir

public String getAppServerLogDir()
                          throws Exception

Throws:

Exception

getAppServerTmpDir

public String getAppServerTmpDir()
                          throws Exception

Throws:

Exception

setAppServerDefaultDeploymentScanEnabled

public void setAppServerDefaultDeploymentScanEnabled(boolean enabled)
                                              throws Exception

Enabled or disables the default deployment scanner.

Parameters:

enabled - the new status to be set

Throws:

Exception

getAppServerDefaultDeploymentDir

public String getAppServerDefaultDeploymentDir()
                                        throws Exception

Returns the location where the default deployment scanner is pointing to. This is where EARs, WARs and the like are deployed to.

Returns:

the default deployments directory - null if there is no deployment scanner

Throws:

Exception

setAppServerDefaultDeploymentScanInterval

public void setAppServerDefaultDeploymentScanInterval(long millis)
                                               throws Exception

Sets the interval of the default deployment scanner. If the value is less than 1 millisecond, the scanner will scan only one time at server startup.

Parameters:

millis - number of milliseconds to periodically scan the deployment directory

Throws:

Exception

setAppServerDefaultDeploymentTimeout

public void setAppServerDefaultDeploymentTimeout(long secs)
                                          throws Exception

Sets the deployment timeout of the default deployment scanner. If a deployment takes longer than this value, it will fail.

Parameters:

secs - number of seconds the app server will wait for a deployment to finish

Throws:

Exception

setSystemProperty

public void setSystemProperty(String name,
                     String value)
                       throws Exception

Set a runtime system property in the JVM that is managed by JBossAS.

Parameters:

name -

value -

Throws:

Exception

addExtension

public void addExtension(String name)
                  throws Exception

Adds a new module extension to the core system.

Parameters:

name - the name of the new module extension

Throws:

Exception

isExtension

public boolean isExtension(String name)
                    throws Exception

Returns true if the given extension is already in existence.

Parameters:

name - the name of the extension to check

Returns:

true if the extension already exists; false if not

Throws:

Exception

addSubsystem

public void addSubsystem(String name)
                  throws Exception

Adds a new subsystem to the core system.

Parameters:

name - the name of the new subsystem

Throws:

Exception

addSubsystem

public void addSubsystem(String name,
                org.jboss.dmr.ModelNode settings)
                  throws Exception

Adds a new subsystem (along with some optional settings for that subsystem) to the core system If settings is null, the subsystem will be created with no additional settings associated with it.

Parameters:

name - the name of the new subsystem

settings - a node with some additional settings used to initialize the subsystem

Throws:

Exception

isSubsystem

public boolean isSubsystem(String name)
                    throws Exception

Returns true if the given subsystem is already in existence.

Parameters:

name - the name of the subsystem to check

Returns:

true if the subsystem already exists; false if not

Throws:

Exception

reload

public void reload()
            throws Exception

Invokes the management "reload" operation which will shut down all the app server services and restart them again. This is required for certain configuration changes to take effect. This does not shutdown the JVM itself. NOTE: once this method returns, the client is probably unusable since the server side will probably shutdown the connection. You will need to throw away this object and rebuild another one with a newly reconnected client.

Throws:

Exception

reload

public void reload(boolean adminOnly)
            throws Exception

Invokes the management "reload" operation which will shut down all the app server services and restart them again potentially in admin-only mode. This does not shutdown the JVM itself. NOTE: once this method returns, the client is probably unusable since the server side will probably shutdown the connection. You will need to throw away this object and rebuild another one with a newly reconnected client.

Parameters:

adminOnly - if true, reloads the server in admin-only mode

Throws:

Exception

restart

public void restart()
             throws Exception

Invokes the management "shutdown" operation with the restart option set to true (see shutdown(boolean)). This means the app server JVM will shutdown but immediately be restarted. Note that the caller may not be returned to since the JVM in which this call is made will be killed and if the client is co-located with the server JVM, this client will also die. NOTE: even if this method returns, the client is unusable since the server side will shutdown the connection. You will need to throw away this object and rebuild another one with a newly reconnected client.

Throws:

Exception

shutdown

public void shutdown(boolean restart)
              throws Exception

Invokes the management "shutdown" operation that kills the JVM completely with System.exit. If restart is set to true, the JVM will immediately be restarted again. If restart is false, the JVM is killed and will stay down. Note that in either case, the caller may not be returned to since the JVM in which this call is made will be killed and if the client is co-located with the server JVM, this client will also die. NOTE: even if this method returns, the client is unusable since the server side will shutdown the connection. You will need to throw away this object and rebuild another one with a newly reconnected client.

Parameters:

restart - if true, the JVM will be restarted

Throws:

Exception