org.jboss.as.controller.operations

Class MultistepUtil

java.lang.Object

org.jboss.as.controller.operations.MultistepUtil

public final class MultistepUtil
extends Object

Utility code related to multistep operations.

Author:

Brian Stansberry

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MultistepUtil.OperationHandlerResolver Resolves an OperationStepHandler to use given a set of inputs.

Method Summary

Modifier and Type	Method and Description
static void	recordOperationSteps(OperationContext context, List<org.jboss.dmr.ModelNode> operations, List<org.jboss.dmr.ModelNode> responses) Deprecated. Do not use. Will be removed.
static <T> void	recordOperationSteps(OperationContext context, Map<T,org.jboss.dmr.ModelNode> operations, Map<T,org.jboss.dmr.ModelNode> responses) Adds a step to the given OperationContext for each operation included in the given map, either using for each step a response node provided in the responses map, or if the responses map is empty, creating them and storing them in the responses map.
static <T> void	recordOperationSteps(OperationContext context, Map<T,org.jboss.dmr.ModelNode> operations, Map<T,org.jboss.dmr.ModelNode> responses, MultistepUtil.OperationHandlerResolver handlerResolver, boolean adjustAddresses) Deprecated. Do not use. Will be removed.
static <T> void	recordOperationSteps(OperationContext context, Map<T,org.jboss.dmr.ModelNode> operations, Map<T,org.jboss.dmr.ModelNode> responses, MultistepUtil.OperationHandlerResolver handlerResolver, boolean adjustAddresses, boolean rejectPrivateOperations) This is a specialized version of the other variant of this method that allows a pluggable strategy for resolving the OperationStepHandler to use for the added steps.

Methods inherited from class java.lang.Object

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

Method Detail

recordOperationSteps

@Deprecated
public static void recordOperationSteps(OperationContext context,
                                                    List<org.jboss.dmr.ModelNode> operations,
                                                    List<org.jboss.dmr.ModelNode> responses)
                                             throws OperationFailedException

Deprecated. Do not use. Will be removed.

Adds a step to the given OperationContext for each operation included in the given operations list, either using for each step a response node provided in the responses list, or if the responses list is empty, creating them and storing them in the responses list. The response objects are not tied into the overall response to the operation associated with context. It is the responsibility of the caller to do that.

Parameters:

context - the OperationContext. Cannot be null

operations - the list of operations, each element of which must be a proper OBJECT type model node with a structure describing an operation

responses - a list of response nodes to use for each operation, each element of which corresponds to the operation in the equivalent position in the operations list. Cannot be null but may be empty in which case this method will create the response nodes and add them to this list.

Throws:

OperationFailedException - if there is a problem registering a step for any of the operations

recordOperationSteps

public static <T> void recordOperationSteps(OperationContext context,
                                            Map<T,org.jboss.dmr.ModelNode> operations,
                                            Map<T,org.jboss.dmr.ModelNode> responses)
                                     throws OperationFailedException

Adds a step to the given OperationContext for each operation included in the given map, either using for each step a response node provided in the responses map, or if the responses map is empty, creating them and storing them in the responses map. The response objects are not tied into the overall response to the operation associated with context. It is the responsibility of the caller to do that.

NOTE: The given operations map must provide an iterator over its entry set that provides the entries in the order in which the operations should execute. A LinkedHashMap is the typical choice.

Type Parameters:

T - the type of the keys in the maps

Parameters:

context - the OperationContext. Cannot be null

operations - the operations, each value of which must be a proper OBJECT type model node with a structure describing an operation.

responses - a map of the response nodes, the keys for which match the keys in the operations param. Cannot be null but may be empty in which case this method will create the response nodes and store them in this map.

Throws:

OperationFailedException - if there is a problem registering a step for any of the operations

recordOperationSteps

@Deprecated
public static <T> void recordOperationSteps(OperationContext context,
                                                        Map<T,org.jboss.dmr.ModelNode> operations,
                                                        Map<T,org.jboss.dmr.ModelNode> responses,
                                                        MultistepUtil.OperationHandlerResolver handlerResolver,
                                                        boolean adjustAddresses)
                                                 throws OperationFailedException

Deprecated. Do not use. Will be removed.

This is a specialized version of the other variant of this method that allows a pluggable strategy for resolving the OperationStepHandler to use for the added steps. It is not expected to be needed by users outside the WildFly Core kernel.

Type Parameters:

T - the type of the keys in the maps

Parameters:

context - the OperationContext. Cannot be null

operations - the operations, each value of which must be a proper OBJECT type model node with a structure describing an operation.

responses - a map of the response nodes, the keys for which match the keys in the operations param. Cannot be null but may be empty in which case this method will create the response nodes and store them in this map.

handlerResolver - an object that can provide the OperationStepHandler to use for the operation

adjustAddresses - true if the address of each operation should be adjusted to become a child of the context's current address

Throws:

OperationFailedException - if there is a problem registering a step for any of the operations

recordOperationSteps

public static <T> void recordOperationSteps(OperationContext context,
                                            Map<T,org.jboss.dmr.ModelNode> operations,
                                            Map<T,org.jboss.dmr.ModelNode> responses,
                                            MultistepUtil.OperationHandlerResolver handlerResolver,
                                            boolean adjustAddresses,
                                            boolean rejectPrivateOperations)
                                     throws OperationFailedException

This is a specialized version of the other variant of this method that allows a pluggable strategy for resolving the OperationStepHandler to use for the added steps. It is not expected to be needed by users outside the WildFly Core kernel.

Type Parameters:

T - the type of the keys in the maps

Parameters:

context - the OperationContext. Cannot be null

operations - the operations, each value of which must be a proper OBJECT type model node with a structure describing an operation.

responses - a map of the response nodes, the keys for which match the keys in the operations param. Cannot be null but may be empty in which case this method will create the response nodes and store them in this map.

handlerResolver - an object that can provide the OperationStepHandler to use for the operation

adjustAddresses - true if the address of each operation should be adjusted to become a child of the context's current address

rejectPrivateOperations - true if an OperationFailedException should be thrown if the OperationEntry for any of the operations is OperationEntry.EntryType#PRIVATE

Throws:

OperationFailedException - if there is a problem registering a step for any of the operations