org.rhq.common.jbossas.client.controller

Class JBossASClient

java.lang.Object

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

Direct Known Subclasses:

CoreJBossASClient, DatasourceJBossASClient, DeploymentJBossASClient, InfinispanJBossASClient, LoggingJBossASClient, MessagingJBossASClient, SecurityDomainJBossASClient, SocketBindingJBossASClient, TransactionsJBossASClient, WebJBossASClient

public class JBossASClient
extends Object

A client that can be used to talk to a JBossAS server via the DMR/ModelControllerClient API.

Author:

John Mazzitelli

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD
static String	ADDRESS
static String	BATCH
static String	BATCH_STEPS
static String	FAILURE_DESCRIPTION
protected org.apache.commons.logging.Log	log
static String	NAME
static String	OPERATION
static String	OUTCOME
static String	OUTCOME_SUCCESS
static String	PERSISTENT
static String	READ_ATTRIBUTE
static String	READ_RESOURCE
static String	REMOVE
static String	RESULT
static String	SUBSYSTEM
static String	SYSTEM_PROPERTY
static String	VALUE
static String	WRITE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
JBossASClient(org.jboss.as.controller.client.ModelControllerClient client) Constructs a new JBoss AS Client that talks to the model through the provided client.

Method Summary

Methods

Modifier and Type	Method and Description
static org.jboss.dmr.ModelNode	createBatchRequest(org.jboss.dmr.ModelNode... steps) Creates a batch of operations that can be atomically invoked.
static org.jboss.dmr.ModelNode	createReadAttributeRequest(boolean runtime, String attributeName, Address address) Convienence method that allows you to create request that reads a single attribute value to a resource.
static org.jboss.dmr.ModelNode	createReadAttributeRequest(String attributeName, Address address) Convienence method that allows you to create request that reads a single attribute value to a resource.
static org.jboss.dmr.ModelNode	createRequest(String operation, Address address) Convienence method that builds a partial operation request node.
static org.jboss.dmr.ModelNode	createRequest(String operation, Address address, org.jboss.dmr.ModelNode extra) Convienence method that builds a partial operation request node, with additional node properties supplied by the given node.
static org.jboss.dmr.ModelNode	createWriteAttributeRequest(String attributeName, String attributeValue, Address address) Convienence method that allows you to create request that writes a single attribute's string value to a resource.
org.jboss.dmr.ModelNode	execute(org.jboss.dmr.ModelNode request) Convienence method that executes the request.
org.jboss.dmr.ModelNode	findNodeInList(Address addr, String haystack, String needle) This tries to find specific node within a list of nodes.
static String	getFailureDescription(org.jboss.dmr.ModelNode operationResult) If the operation result was a failure, this returns the failure description if there is one.
org.jboss.as.controller.client.ModelControllerClient	getModelControllerClient()
static List<String>	getResultListAsStrings(org.jboss.dmr.ModelNode operationResult) If the given node has a result list, that list will be returned with the values as Strings.
static org.jboss.dmr.ModelNode	getResults(org.jboss.dmr.ModelNode operationResult) If the given node has results, those results are returned in a ModelNode.
String	getStringAttribute(boolean runtime, String attributeName, Address address) Convienence method that allows you to obtain a single attribute's string value from a resource.
String	getStringAttribute(String attributeName, Address address) Convienence method that allows you to obtain a single attribute's string value from a resource.
static boolean	isSuccess(org.jboss.dmr.ModelNode operationResult) Returns true if the operation was a success; false otherwise.
org.jboss.dmr.ModelNode	readResource(Address addr) This returns information on the resource at the given address.
org.jboss.dmr.ModelNode	readResource(Address addr, boolean recursive) This returns information on the resource at the given address, recursively returning child nodes with the result if recursive argument is set to true.
void	remove(Address doomedAddr) Removes the resource at the given address.
static org.jboss.dmr.ModelNode	setPossibleExpression(org.jboss.dmr.ModelNode node, String name, String value) This sets the given node's named attribute to the given value.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.apache.commons.logging.Log log

BATCH

public static final String BATCH

See Also:

Constant Field Values

BATCH_STEPS

public static final String BATCH_STEPS

See Also:

Constant Field Values

OPERATION

public static final String OPERATION

See Also:

Constant Field Values

ADDRESS

public static final String ADDRESS

See Also:

Constant Field Values

RESULT

public static final String RESULT

See Also:

Constant Field Values

OUTCOME

public static final String OUTCOME

See Also:

Constant Field Values

OUTCOME_SUCCESS

public static final String OUTCOME_SUCCESS

See Also:

Constant Field Values

SUBSYSTEM

public static final String SUBSYSTEM

See Also:

Constant Field Values

FAILURE_DESCRIPTION

public static final String FAILURE_DESCRIPTION

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

READ_ATTRIBUTE

public static final String READ_ATTRIBUTE

See Also:

Constant Field Values

READ_RESOURCE

public static final String READ_RESOURCE

See Also:

Constant Field Values

WRITE_ATTRIBUTE

public static final String WRITE_ATTRIBUTE

See Also:

Constant Field Values

ADD

public static final String ADD

See Also:

Constant Field Values

REMOVE

public static final String REMOVE

See Also:

Constant Field Values

SYSTEM_PROPERTY

public static final String SYSTEM_PROPERTY

See Also:

Constant Field Values

PERSISTENT

public static final String PERSISTENT

See Also:

Constant Field Values

Constructor Detail

JBossASClient

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

Constructs a new JBoss AS Client that talks to the model through the provided client.

Note that the caller is responsible to correctly close the client instance!!!

Parameters:

client - the client to use

Method Detail

createReadAttributeRequest

public static org.jboss.dmr.ModelNode createReadAttributeRequest(String attributeName,
                                                 Address address)

Convienence method that allows you to create request that reads a single attribute value to a resource.

Parameters:

attributeName - the name of the attribute whose value is to be read

address - identifies the resource

Returns:

the request

createReadAttributeRequest

public static org.jboss.dmr.ModelNode createReadAttributeRequest(boolean runtime,
                                                 String attributeName,
                                                 Address address)

Convienence method that allows you to create request that reads a single attribute value to a resource.

Parameters:

runtime - if true, the attribute is a runtime attribute

attributeName - the name of the attribute whose value is to be read

address - identifies the resource

Returns:

the request

createWriteAttributeRequest

public static org.jboss.dmr.ModelNode createWriteAttributeRequest(String attributeName,
                                                  String attributeValue,
                                                  Address address)

Convienence method that allows you to create request that writes a single attribute's string value to a resource.

Parameters:

attributeName - the name of the attribute whose value is to be written

attributeValue - the attribute value that is to be written

address - identifies the resource

Returns:

the request

createRequest

public static org.jboss.dmr.ModelNode createRequest(String operation,
                                    Address address)

Convienence method that builds a partial operation request node.

Parameters:

operation - the operation to be requested

address - identifies the target resource

Returns:

the partial operation request node - caller should fill this in further to complete the node

createRequest

public static org.jboss.dmr.ModelNode createRequest(String operation,
                                    Address address,
                                    org.jboss.dmr.ModelNode extra)

Convienence method that builds a partial operation request node, with additional node properties supplied by the given node.

Parameters:

operation - the operation to be requested

address - identifies the target resource

extra - provides additional properties to add to the returned request node.

Returns:

the partial operation request node - caller can fill this in further to complete the node

createBatchRequest

public static org.jboss.dmr.ModelNode createBatchRequest(org.jboss.dmr.ModelNode... steps)

Creates a batch of operations that can be atomically invoked.

Parameters:

steps - the different operation steps of the batch

Returns:

the batch operation node

getResultListAsStrings

public static List<String> getResultListAsStrings(org.jboss.dmr.ModelNode operationResult)

If the given node has a result list, that list will be returned with the values as Strings. Otherwise, an empty list is returned.

Parameters:

operationResult - the node to examine

Returns:

the result list as Strings if there is a list, empty otherwise

getResults

public static org.jboss.dmr.ModelNode getResults(org.jboss.dmr.ModelNode operationResult)

If the given node has results, those results are returned in a ModelNode. Otherwise, an empty node is returned.

Parameters:

operationResult - the node to examine

Returns:

the results as a ModelNode

isSuccess

public static boolean isSuccess(org.jboss.dmr.ModelNode operationResult)

Returns true if the operation was a success; false otherwise.

Parameters:

operationResult - the operation result to test

Returns:

the success or failure flag of the result

getFailureDescription

public static String getFailureDescription(org.jboss.dmr.ModelNode operationResult)

If the operation result was a failure, this returns the failure description if there is one. A generic failure message will be returned if the operation was a failure but has no failure description. A null is returned if the operation was a success.

Parameters:

operationResult - the operation whose failure description is to be returned

Returns:

the failure description of null if the operation was a success

setPossibleExpression

public static org.jboss.dmr.ModelNode setPossibleExpression(org.jboss.dmr.ModelNode node,
                                            String name,
                                            String value)

This sets the given node's named attribute to the given value. If the value appears to be an expression (that is, contains "${" somewhere in it), this will set the value as an expression on the node.

Parameters:

node - the node whose attribute is to be set

name - the name of the attribute whose value is to be set

value - the value, possibly an expression

Returns:

returns the node

getModelControllerClient

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

execute

public org.jboss.dmr.ModelNode execute(org.jboss.dmr.ModelNode request)
                                throws Exception

Convienence method that executes the request.

Parameters:

request -

Returns:

results

Throws:

Exception

readResource

public org.jboss.dmr.ModelNode readResource(Address addr)
                                     throws Exception

This returns information on the resource at the given address. This will not return an exception if the address points to a non-existent resource, rather, it will just return null. You can use this as a test for resource existence.

Parameters:

addr -

Returns:

the found item or null if not found

Throws:

Exception - if some error prevented the lookup from even happening

readResource

public org.jboss.dmr.ModelNode readResource(Address addr,
                                   boolean recursive)
                                     throws Exception

This returns information on the resource at the given address, recursively returning child nodes with the result if recursive argument is set to true. This will not return an exception if the address points to a non-existent resource, rather, it will just return null. You can use this as a test for resource existence.

Parameters:

addr -

recursive - if true, return all child data within the resource node

Returns:

the found item or null if not found

Throws:

Exception - if some error prevented the lookup from even happening

remove

public void remove(Address doomedAddr)
            throws Exception

Removes the resource at the given address.

Parameters:

doomedAddr - the address of the resource to remove

Throws:

Exception

getStringAttribute

public String getStringAttribute(String attributeName,
                        Address address)
                          throws Exception

Convienence method that allows you to obtain a single attribute's string value from a resource.

Parameters:

attributeName - the attribute whose value is to be returned

address - identifies the resource

Returns:

the attribute value

Throws:

Exception - if failed to obtain the attribute value

getStringAttribute

public String getStringAttribute(boolean runtime,
                        String attributeName,
                        Address address)
                          throws Exception

Convienence method that allows you to obtain a single attribute's string value from a resource.

Parameters:

runtime - if true, the attribute to be retrieved is a runtime attribute

attributeName - the attribute whose value is to be returned

address - identifies the resource

Returns:

the attribute value

Throws:

Exception - if failed to obtain the attribute value

findNodeInList

public org.jboss.dmr.ModelNode findNodeInList(Address addr,
                                     String haystack,
                                     String needle)
                                       throws Exception

This tries to find specific node within a list of nodes. Given an address and a named node at that address (the "haystack"), it is assumed that haystack is actually a list of other nodes. This method looks in the haystack and tries to find the named needle. If it finds it, that list item is returned. If it does not find the needle in the haystack, it returns null. For example, if you want to find a specific datasource in the list of datasources, you can pass in the address for the datasource subsystem, and ask to look in the data-source node list (the haystack) and return the named datasource (the needle).

Parameters:

addr -

haystack -

needle -

Returns:

the found item or null if not found

Throws:

Exception - if the lookup fails for some reason