public class Operations extends Object
final ModelControllerClient client = ModelControllerClient.Factory.create(hostname, port);
final ModelNode address = new ModelNode().setEmptyList();
// Read the server state
final ModelNode op = Operations.createReadAttributeOperation(address, "server-state");
final ModelNode result = client.execute(op);
if (Operations.isSuccessfulOutcome(result)) {
System.out.printf("Server state: %s%n", Operations.readResult(result));
} else {
System.out.printf("Failure! %s%n", Operations.getFailureDescription(result));
}
Modifier and Type | Class and Description |
---|---|
static class |
Operations.CompositeOperationBuilder
A builder for building composite operations.
|
Constructor and Description |
---|
Operations() |
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(Iterable<String> pairs)
Creates an address that can be used as the address for an operation.
|
static org.jboss.dmr.ModelNode |
createAddress(String... pairs)
Creates an address that can be used as the address for an operation.
|
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 |
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 |
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 |
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 |
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.ModelNode |
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 String |
getOperationName(org.jboss.dmr.ModelNode op)
Returns the name of the operation.
|
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.
|
public static boolean isSuccessfulOutcome(org.jboss.dmr.ModelNode outcome)
outcome
- the result of executing an operationtrue
if the operation was successful, otherwise false
public static org.jboss.dmr.ModelNode getFailureDescription(org.jboss.dmr.ModelNode result)
result
- the result of executing an operationIllegalArgumentException
- if the outcome of the operation was successfulpublic static org.jboss.dmr.ModelNode createAddress(String... pairs)
ModelNode
of type ModelType.LIST
.
The string is split into key/value pairs. If the final key does not have a value an *
is used to
indicate a wildcard for the address.
pairs
- the key/value pairs to usepublic static org.jboss.dmr.ModelNode createAddress(Iterable<String> pairs)
ModelNode
of type ModelType.LIST
.
The string is split into key/value pairs. If the final key does not have a value an *
is used to
indicate a wildcard for the address.
pairs
- the key/value pairs to usepublic static org.jboss.dmr.ModelNode getOperationAddress(org.jboss.dmr.ModelNode op)
op
- the operationpublic static String getOperationName(org.jboss.dmr.ModelNode op)
op
- the operationIllegalArgumentException
- if the operation was not defined.public static org.jboss.dmr.ModelNode createAddOperation(org.jboss.dmr.ModelNode address)
address
- the address for the operationpublic static org.jboss.dmr.ModelNode createRemoveOperation(org.jboss.dmr.ModelNode address)
address
- the address for the operationpublic static org.jboss.dmr.ModelNode createCompositeOperation()
ClientConstants.ROLLBACK_ON_RUNTIME_FAILURE
is set to true
to rollback all
operations if one fails.public static org.jboss.dmr.ModelNode createReadAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName)
attributeName
parameter.address
- the address to create the read attribute forattributeName
- the name of the parameter to readpublic static org.jboss.dmr.ModelNode createReadResourceOperation(org.jboss.dmr.ModelNode address)
address
- the address to create the read forpublic static org.jboss.dmr.ModelNode createReadResourceOperation(org.jboss.dmr.ModelNode address, boolean recursive)
address
- the address to create the read forrecursive
- whether to search recursively or notpublic static org.jboss.dmr.ModelNode createUndefineAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName)
attributeName
parameter.address
- the address to create the write attribute forattributeName
- the name attribute to undefinepublic static org.jboss.dmr.ModelNode createWriteAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName, boolean value)
attributeName
parameter.address
- the address to create the write attribute forattributeName
- the name of the attribute to writevalue
- the value to set the attribute topublic static org.jboss.dmr.ModelNode createWriteAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName, int value)
attributeName
parameter.address
- the address to create the write attribute forattributeName
- the name of the attribute to writevalue
- the value to set the attribute topublic static org.jboss.dmr.ModelNode createWriteAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName, long value)
attributeName
parameter.address
- the address to create the write attribute forattributeName
- the name of the attribute to writevalue
- the value to set the attribute topublic static org.jboss.dmr.ModelNode createWriteAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName, String value)
attributeName
parameter.address
- the address to create the write attribute forattributeName
- the name of the attribute to writevalue
- the value to set the attribute topublic static org.jboss.dmr.ModelNode createWriteAttributeOperation(org.jboss.dmr.ModelNode address, String attributeName, org.jboss.dmr.ModelNode value)
attributeName
parameter.address
- the address to create the write attribute forattributeName
- the name of the attribute to writevalue
- the value to set the attribute topublic static org.jboss.dmr.ModelNode createOperation(String operation)
operation
- the operation to createpublic static org.jboss.dmr.ModelNode createOperation(String operation, org.jboss.dmr.ModelNode address)
operation
- the operation nameaddress
- the address for the operationIllegalArgumentException
- if the address is not of type ModelType.LIST
public static org.jboss.dmr.ModelNode readResult(org.jboss.dmr.ModelNode result)
ClientConstants.RESULT
attribute, a new undefined ModelNode
is returned.result
- the result of executing an operationCopyright © 2023 JBoss by Red Hat. All rights reserved.