org.rhq.modules.plugins.jbossas7

Class ASConnection

java.lang.Object

org.rhq.modules.plugins.jbossas7.ASConnection

public class ASConnection
extends Object

Provide management connections to an AS7 instance and reading/writing data from/to it.

Author:

Heiko W. Rupp, Ian Springer, Thomas Segismont

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_SCHEME
static String	HTTPS_SCHEME
static String	MANAGEMENT Deprecated. as of 4.7. Use MANAGEMENT_URI constant instead
static String	MANAGEMENT_URI
static boolean	verbose

Constructor Summary

Constructors

Constructor and Description
ASConnection(ASConnectionParams params)
ASConnection(String host, int port, String user, String password) Deprecated. as of RHQ 4.10, use ASConnection(ASConnectionParams) instead
ASConnection(String host, int port, String user, String password, Long managementConnectionTimeout) Deprecated. as of RHQ 4.10, use ASConnection(ASConnectionParams) instead

Method Summary

Methods

Modifier and Type	Method and Description
Result	execute(Operation op) Execute the passed Operation and return its Result.
Result	execute(Operation op, boolean isComplex) Execute the passed Operation and return its Result.
Result	execute(Operation op, boolean isComplex, int timeoutSec) Execute the passed Operation and return its Result.
Result	execute(Operation op, int timeoutSec) Execute the passed Operation and return its Result.
ComplexResult	executeComplex(Operation op) Execute the passed Operation and return its ComplexResult.
ComplexResult	executeComplex(Operation op, int timeoutSec) Execute the passed Operation and return its ComplexResult.
org.codehaus.jackson.JsonNode	executeRaw(Operation operation) Execute an operation against the domain api.
org.codehaus.jackson.JsonNode	executeRaw(Operation operation, int timeoutSec) Execute an operation against the domain api.
ASConnectionParams	getAsConnectionParams()
String	getHost() Deprecated. as of RHQ 4.10, use getAsConnectionParams() instead
String	getPassword() Deprecated. as of RHQ 4.10, use getAsConnectionParams() instead
int	getPort() Deprecated. as of RHQ 4.10, use getAsConnectionParams() instead
String	getUser() Deprecated. as of RHQ 4.10, use getAsConnectionParams() instead
static ASConnection	newInstanceForServerPluginConfiguration(ServerPluginConfiguration serverPluginConfig) Deprecated. as of RHQ 4.10, use ASConnection(ASConnectionParams) instead
void	shutdown()
static void	shutdownConnectionCleaner() Called from PluginLifecycleListener to shutdown the thread pool for cleaning out the stale connections.

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_SCHEME

public static final String HTTP_SCHEME

See Also:

Constant Field Values

HTTPS_SCHEME

public static final String HTTPS_SCHEME

See Also:

Constant Field Values

MANAGEMENT_URI

public static final String MANAGEMENT_URI

See Also:

Constant Field Values

verbose

public static boolean verbose

MANAGEMENT

@Deprecated
public static final String MANAGEMENT

Deprecated. as of 4.7. Use MANAGEMENT_URI constant instead

See Also:

Constant Field Values

Constructor Detail

ASConnection

@Deprecated
public ASConnection(String host,
                       int port,
                       String user,
                       String password)

Deprecated. as of RHQ 4.10, use ASConnection(ASConnectionParams) instead

ASConnection

@Deprecated
public ASConnection(String host,
                       int port,
                       String user,
                       String password,
                       Long managementConnectionTimeout)

Deprecated. as of RHQ 4.10, use ASConnection(ASConnectionParams) instead

ASConnection

public ASConnection(ASConnectionParams params)

Method Detail

shutdownConnectionCleaner

public static void shutdownConnectionCleaner()

Called from PluginLifecycleListener to shutdown the thread pool for cleaning out the stale connections.

This is needed so that the thread(s) in the pool don't leak the current plugin class loader across the plugin container restarts. The plugin classloader is the threads' context class loader and the threads live until JVM exits (unless the thread pool is explicitly shut down). Because all the plugin classes are reloaded on plugin container restart, the thread pool is created anew, leaving the threads from the old thread pool running and still referencing the previous plugin class loader.

This then leads to a wonderful sneaky memory leak leading to eventual OOMEs due to depleted perm gen (which has to keep references to all the classes from all the plugin container "runs").

Therefore we need to make sure to shut down the thread pool explicitly when it is no longer needed (which is at the plugin container shutdown).

newInstanceForServerPluginConfiguration

@Deprecated
public static ASConnection newInstanceForServerPluginConfiguration(ServerPluginConfiguration serverPluginConfig)

Deprecated. as of RHQ 4.10, use ASConnection(ASConnectionParams) instead

shutdown

public void shutdown()

executeRaw

public org.codehaus.jackson.JsonNode executeRaw(Operation operation)

Execute an operation against the domain api. This method is doing the real work by talking to the remote server and sending JSON data, that is obtained by serializing the operation. Please do not use this API , but execute()

Parameters:

operation - an Operation that should be run on the domain controller

Returns:

JsonNode that describes the result

See Also:

execute(org.rhq.modules.plugins.jbossas7.json.Operation), execute(org.rhq.modules.plugins.jbossas7.json.Operation, boolean), executeComplex(org.rhq.modules.plugins.jbossas7.json.Operation)

executeRaw

public org.codehaus.jackson.JsonNode executeRaw(Operation operation,
                                       int timeoutSec)

Execute an operation against the domain api. This method is doing the real work by talking to the remote server and sending JSON data, that is obtained by serializing the operation. Please do not use this API, but rather use execute(Operation).

Parameters:

operation - an Operation that should be run on the domain controller

timeoutSec - Timeout on connect and read in seconds

Returns:

JsonNode that describes the result

See Also:

execute(org.rhq.modules.plugins.jbossas7.json.Operation), execute(org.rhq.modules.plugins.jbossas7.json.Operation, boolean), executeComplex(org.rhq.modules.plugins.jbossas7.json.Operation)

execute

public Result execute(Operation op)

Execute the passed Operation and return its Result. This is a shortcut of #execute(Operation, false)

Parameters:

op - Operation to execute

Returns:

Result of the execution

See Also:

execute(org.rhq.modules.plugins.jbossas7.json.Operation, boolean)

execute

public Result execute(Operation op,
             int timeoutSec)

Execute the passed Operation and return its Result. This is a shortcut of #execute(Operation, false)

Parameters:

op - Operation to execute

timeoutSec - Timeout to wait in seconds. Default is 10 sec

Returns:

Result of the execution

See Also:

execute(org.rhq.modules.plugins.jbossas7.json.Operation, boolean)

executeComplex

public ComplexResult executeComplex(Operation op)

Execute the passed Operation and return its ComplexResult. This is a shortcut of #execute(Operation, true)

Parameters:

op - Operation to execute

Returns:

ComplexResult of the execution

See Also:

execute(org.rhq.modules.plugins.jbossas7.json.Operation, boolean)

executeComplex

public ComplexResult executeComplex(Operation op,
                           int timeoutSec)

Execute the passed Operation and return its ComplexResult. This is a shortcut of #execute(Operation, true)

Parameters:

op - Operation to execute

timeoutSec - Timeout to wait in seconds. Default is 10 sec

Returns:

ComplexResult of the execution

See Also:

execute(org.rhq.modules.plugins.jbossas7.json.Operation, boolean)

execute

public Result execute(Operation op,
             boolean isComplex)

Execute the passed Operation and return its Result. Depending on isComplex the return type is a simple Result or a ComplexResult. Default timeout here is 10sec

Parameters:

op - Operation to execute

isComplex - should a complex result be returned?

Returns:

ComplexResult of the execution

execute

public Result execute(Operation op,
             boolean isComplex,
             int timeoutSec)

Execute the passed Operation and return its Result. Depending on isComplex the return type is a simple Result or a ComplexResult

Parameters:

op - Operation to execute

isComplex - should a complex result be returned?

timeoutSec -

Returns:

ComplexResult of the execution

getHost

@Deprecated
public String getHost()

Deprecated. as of RHQ 4.10, use getAsConnectionParams() instead

getPort

@Deprecated
public int getPort()

Deprecated. as of RHQ 4.10, use getAsConnectionParams() instead

getUser

@Deprecated
public String getUser()

Deprecated. as of RHQ 4.10, use getAsConnectionParams() instead

getPassword

@Deprecated
public String getPassword()

Deprecated. as of RHQ 4.10, use getAsConnectionParams() instead

getAsConnectionParams

public ASConnectionParams getAsConnectionParams()