org.jboss.as.plugin.common

Class Operations

java.lang.Object

org.jboss.as.controller.client.helpers.ClientConstants

org.jboss.as.plugin.common.Operations

public class Operations
extends org.jboss.as.controller.client.helpers.ClientConstants

A helper for creating operations.

Author:

James R. Perkins

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Operations.CompositeOperationBuilder A builder for building composite operations.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHILD_TYPE
static String	ENABLE
static String	LAUNCH_TYPE
static String	PROFILE
static String	READ_ATTRIBUTE_OPERATION
static String	READ_CHILDREN_NAMES
static String	READ_RESOURCE
static String	READ_RESOURCE_OPERATION
static String	RECURSIVE
static String	RELOAD
static String	REMOVE_OPERATION
static String	SERVER_STATE
static String	SHUTDOWN
static String	UNDEFINE_ATTRIBUTE_OPERATION
static String	VALUE
static String	WRITE_ATTRIBUTE_OPERATION

Fields inherited from class org.jboss.as.controller.client.helpers.ClientConstants

ADD, COMPOSITE, CONTENT, DEPLOYMENT, DEPLOYMENT_DEPLOY_OPERATION, DEPLOYMENT_FULL_REPLACE_OPERATION, DEPLOYMENT_REDEPLOY_OPERATION, DEPLOYMENT_REMOVE_OPERATION, DEPLOYMENT_REPLACE_OPERATION, DEPLOYMENT_UNDEPLOY_OPERATION, EXTENSION, FAILURE_DESCRIPTION, INPUT_STREAM_INDEX, NAME, OP, OP_ADDR, OPERATION_HEADERS, OUTCOME, RESULT, ROLLBACK_ON_RUNTIME_FAILURE, ROLLOUT_PLAN, RUNTIME_NAME, STEPS, SUCCESS, TO_REPLACE

Constructor Summary

Constructors

Constructor and Description
Operations()

Method Summary

Methods

Modifier and Type	Method and Description
static org.jboss.dmr.ModelNode	createAddOperation(org.jboss.dmr.ModelNode address) Creates an add operation.
static org.jboss.dmr.ModelNode	createAddress(String key, String name)
static org.jboss.dmr.ModelNode	createCompositeOperation() Creates a composite operation with an empty address and empty steps that will rollback on a runtime failure.
static org.jboss.dmr.ModelNode	createListDeploymentsOperation() Creates an operation to list the deployments.
static org.jboss.dmr.ModelNode	createOperation(String operation) Creates a generic operation with an empty (root) address.
static org.jboss.dmr.ModelNode	createOperation(String operation, org.jboss.dmr.ModelNode address) Creates an operation.
static org.jboss.dmr.ModelNode	createOperation(String operation, org.jboss.dmr.ModelNode address, boolean recursive) Creates an operation.
static org.jboss.dmr.ModelNode	createReadAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName) Creates an operation to read the attribute represented by the attributeName parameter.
static org.jboss.dmr.ModelNode	createReadAttributeOperation(String attributeName) Creates an operation to read the attribute represented by the attributeName parameter.
static org.jboss.dmr.ModelNode	createReadResourceOperation(org.jboss.dmr.ModelNode address) Creates a non-recursive operation to read a resource.
static org.jboss.dmr.ModelNode	createReadResourceOperation(org.jboss.dmr.ModelNode address, boolean recursive) Creates an operation to read a resource.
static org.jboss.dmr.ModelNode	createRemoveOperation(org.jboss.dmr.ModelNode address) Creates a remove operation.
static org.jboss.dmr.ModelNode	createRemoveOperation(org.jboss.dmr.ModelNode address, boolean recursive) Creates a remove operation.
static org.jboss.dmr.ModelNode	createUndefineAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName) Creates an operation to undefine an attribute value represented by the attributeName parameter.
static org.jboss.dmr.ModelNode	createWriteAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName, boolean value) Creates an operation to write an attribute value represented by the attributeName parameter.
static org.jboss.dmr.ModelNode	createWriteAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName, int value) Creates an operation to write an attribute value represented by the attributeName parameter.
static org.jboss.dmr.ModelNode	createWriteAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName, long value) Creates an operation to write an attribute value represented by the attributeName parameter.
static org.jboss.dmr.ModelNode	createWriteAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName, org.jboss.dmr.ModelNode value) Creates an operation to write an attribute value represented by the attributeName parameter.
static org.jboss.dmr.ModelNode	createWriteAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName, String value) Creates an operation to write an attribute value represented by the attributeName parameter.
static org.jboss.dmr.Property	getChildAddress(org.jboss.dmr.ModelNode address) Finds the last entry of the address list and returns it as a property.
static String	getFailureDescription(org.jboss.dmr.ModelNode result) Parses the result and returns the failure description.
static org.jboss.dmr.ModelNode	getOperationAddress(org.jboss.dmr.ModelNode op) Returns the address for the operation.
static org.jboss.dmr.ModelNode	getParentAddress(org.jboss.dmr.ModelNode address) Finds the parent address, everything before the last address part.
static boolean	isSuccessfulOutcome(org.jboss.dmr.ModelNode outcome) Checks the result for a successful operation outcome.
static org.jboss.dmr.ModelNode	readResult(org.jboss.dmr.ModelNode result) Reads the result of an operation and returns the result.
static String	readResultAsString(org.jboss.dmr.ModelNode result) Reads the result of an operation and returns the result as a string.
static boolean	successful(org.jboss.dmr.ModelNode result) Checks the result for a successful operation.

Methods inherited from class java.lang.Object

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

Field Detail

CHILD_TYPE

public static final String CHILD_TYPE

See Also:

Constant Field Values

ENABLE

public static final String ENABLE

See Also:

Constant Field Values

LAUNCH_TYPE

public static final String LAUNCH_TYPE

See Also:

Constant Field Values

PROFILE

public static final String PROFILE

See Also:

Constant Field Values

READ_ATTRIBUTE_OPERATION

public static final String READ_ATTRIBUTE_OPERATION

See Also:

Constant Field Values

READ_CHILDREN_NAMES

public static final String READ_CHILDREN_NAMES

See Also:

Constant Field Values

READ_RESOURCE

public static final String READ_RESOURCE

See Also:

Constant Field Values

READ_RESOURCE_OPERATION

public static final String READ_RESOURCE_OPERATION

See Also:

Constant Field Values

RECURSIVE

public static final String RECURSIVE

See Also:

Constant Field Values

RELOAD

public static final String RELOAD

See Also:

Constant Field Values

REMOVE_OPERATION

public static final String REMOVE_OPERATION

See Also:

Constant Field Values

SERVER_STATE

public static final String SERVER_STATE

See Also:

Constant Field Values

SHUTDOWN

public static final String SHUTDOWN

See Also:

Constant Field Values

UNDEFINE_ATTRIBUTE_OPERATION

public static final String UNDEFINE_ATTRIBUTE_OPERATION

See Also:

Constant Field Values

VALUE

public static final String VALUE

See Also:

Constant Field Values

WRITE_ATTRIBUTE_OPERATION

public static final String WRITE_ATTRIBUTE_OPERATION

See Also:

Constant Field Values

Constructor Detail

Operations

public Operations()

Method Detail

isSuccessfulOutcome

public static boolean isSuccessfulOutcome(org.jboss.dmr.ModelNode outcome)

Checks the result for a successful operation outcome.

Parameters:

outcome - the result of executing an operation

Returns:

true if the operation was successful, otherwise false

successful

public static boolean successful(org.jboss.dmr.ModelNode result)

Checks the result for a successful operation.

Parameters:

result - the result of executing an operation

Returns:

true if the operation was successful, otherwise false

getFailureDescription

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

Parses the result and returns the failure description. If the result was successful, an empty string is returned.

Parameters:

result - the result of executing an operation

Returns:

the failure message or an empty string

getOperationAddress

public static org.jboss.dmr.ModelNode getOperationAddress(org.jboss.dmr.ModelNode op)

Returns the address for the operation.

Parameters:

op - the operation

Returns:

the operation address or a new undefined model node

createAddOperation

public static org.jboss.dmr.ModelNode createAddOperation(org.jboss.dmr.ModelNode address)

Creates an add operation.

Parameters:

address - the address for the operation

Returns:

the operation

createRemoveOperation

public static org.jboss.dmr.ModelNode createRemoveOperation(org.jboss.dmr.ModelNode address)

Creates a remove operation.

Parameters:

address - the address for the operation

Returns:

the operation

createRemoveOperation

public static org.jboss.dmr.ModelNode createRemoveOperation(org.jboss.dmr.ModelNode address,
                                            boolean recursive)

Creates a remove operation.

Parameters:

address - the address for the operation

Returns:

the operation

createListDeploymentsOperation

public static org.jboss.dmr.ModelNode createListDeploymentsOperation()

Creates an operation to list the deployments.

Returns:

the operation

createCompositeOperation

public static org.jboss.dmr.ModelNode createCompositeOperation()

Creates a composite operation with an empty address and empty steps that will rollback on a runtime failure.

By default the ClientConstants.ROLLBACK_ON_RUNTIME_FAILURE is set to true to rollback all operations if one fails.

Returns:

the operation

createReadAttributeOperation

public static org.jboss.dmr.ModelNode createReadAttributeOperation(String attributeName)

Creates an operation to read the attribute represented by the attributeName parameter.

Parameters:

attributeName - the name of the parameter to read

Returns:

the operation

createReadAttributeOperation

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

Creates an operation to read the attribute represented by the attributeName parameter.

Parameters:

address - the address to create the read attribute for

attributeName - the name of the parameter to read

Returns:

the operation

createReadResourceOperation

public static org.jboss.dmr.ModelNode createReadResourceOperation(org.jboss.dmr.ModelNode address)

Creates a non-recursive operation to read a resource.

Parameters:

address - the address to create the read for

Returns:

the operation

createReadResourceOperation

public static org.jboss.dmr.ModelNode createReadResourceOperation(org.jboss.dmr.ModelNode address,
                                                  boolean recursive)

Creates an operation to read a resource.

Parameters:

address - the address to create the read for

recursive - whether to search recursively or not

Returns:

the operation

createUndefineAttributeOperation

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

Creates an operation to undefine an attribute value represented by the attributeName parameter.

Parameters:

address - the address to create the write attribute for

attributeName - the name attribute to undefine

Returns:

the operation

createWriteAttributeOperation

public static org.jboss.dmr.ModelNode createWriteAttributeOperation(org.jboss.dmr.ModelNode address,
                                                    String attributeName,
                                                    boolean value)

Creates an operation to write an attribute value represented by the attributeName parameter.

Parameters:

address - the address to create the write attribute for

attributeName - the name of the attribute to write

value - the value to set the attribute to

Returns:

the operation

createWriteAttributeOperation

public static org.jboss.dmr.ModelNode createWriteAttributeOperation(org.jboss.dmr.ModelNode address,
                                                    String attributeName,
                                                    int value)

Creates an operation to write an attribute value represented by the attributeName parameter.

Parameters:

address - the address to create the write attribute for

attributeName - the name of the attribute to write

value - the value to set the attribute to

Returns:

the operation

createWriteAttributeOperation

public static org.jboss.dmr.ModelNode createWriteAttributeOperation(org.jboss.dmr.ModelNode address,
                                                    String attributeName,
                                                    long value)

Creates an operation to write an attribute value represented by the attributeName parameter.

Parameters:

address - the address to create the write attribute for

attributeName - the name of the attribute to write

value - the value to set the attribute to

Returns:

the operation

createWriteAttributeOperation

public static org.jboss.dmr.ModelNode createWriteAttributeOperation(org.jboss.dmr.ModelNode address,
                                                    String attributeName,
                                                    String value)

Creates an operation to write an attribute value represented by the attributeName parameter.

Parameters:

address - the address to create the write attribute for

attributeName - the name of the attribute to write

value - the value to set the attribute to

Returns:

the operation

createWriteAttributeOperation

public static org.jboss.dmr.ModelNode createWriteAttributeOperation(org.jboss.dmr.ModelNode address,
                                                    String attributeName,
                                                    org.jboss.dmr.ModelNode value)

Creates an operation to write an attribute value represented by the attributeName parameter.

Parameters:

address - the address to create the write attribute for

attributeName - the name of the attribute to write

value - the value to set the attribute to

Returns:

the operation

createAddress

public static org.jboss.dmr.ModelNode createAddress(String key,
                                    String name)

createOperation

public static org.jboss.dmr.ModelNode createOperation(String operation)

Creates a generic operation with an empty (root) address.

Parameters:

operation - the operation to create

Returns:

the operation

createOperation

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

Creates an operation.

Parameters:

operation - the operation name

address - the address for the operation

Returns:

the operation

Throws:

IllegalArgumentException - if the address is not of type ModelType.LIST

createOperation

public static org.jboss.dmr.ModelNode createOperation(String operation,
                                      org.jboss.dmr.ModelNode address,
                                      boolean recursive)

Creates an operation.

Parameters:

operation - the operation name

address - the address for the operation

recursive - whether the operation is recursive or not

Returns:

the operation

Throws:

IllegalArgumentException - if the address is not of type ModelType.LIST

getChildAddress

public static org.jboss.dmr.Property getChildAddress(org.jboss.dmr.ModelNode address)

Finds the last entry of the address list and returns it as a property.

Parameters:

address - the address to get the last part of

Returns:

the last part of the address

Throws:

IllegalArgumentException - if the address is not of type ModelType.LIST or is empty

getParentAddress

public static org.jboss.dmr.ModelNode getParentAddress(org.jboss.dmr.ModelNode address)

Finds the parent address, everything before the last address part.

Parameters:

address - the address to get the parent

Returns:

the parent address

Throws:

IllegalArgumentException - if the address is not of type ModelType.LIST or is empty

readResultAsString

public static String readResultAsString(org.jboss.dmr.ModelNode result)

Reads the result of an operation and returns the result as a string. If the operation does not have a ClientConstants.RESULT attribute and empty string is returned.

Parameters:

result - the result of executing an operation

Returns:

the result of the operation or an empty string

readResult

public static org.jboss.dmr.ModelNode readResult(org.jboss.dmr.ModelNode result)

Reads the result of an operation and returns the result. If the operation does not have a ClientConstants.RESULT attribute, a new undefined ModelNode is returned.

Parameters:

result - the result of executing an operation

Returns:

the result of the operation or a new undefined model node