Package org.jboss.as.controller

Class AbstractAddStepHandler

java.lang.Object

org.jboss.as.controller.AbstractAddStepHandler

All Implemented Interfaces:

OperationDescriptor, OperationStepHandler

Direct Known Subclasses:

AbstractBoottimeAddStepHandler, InterfaceAddHandler, ManagementInterfaceAddStepHandler, ModelOnlyAddStepHandler, ReloadRequiredAddStepHandler

public abstract class AbstractAddStepHandler
extends Object
implements OperationStepHandler, OperationDescriptor

Base class for OperationStepHandler implementations that add managed resource.

Author:

John Bailey, Paul Ferraro

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractAddStepHandler.Parameters	Deprecated, for removal: This API element is subject to removal in a future version. Use default constructor instead.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Collection<? extends AttributeDefinition>	attributes	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
AbstractAddStepHandler()	Constructs an add handler.
AbstractAddStepHandler(Collection<? extends AttributeDefinition> attributes)	Deprecated, for removal: This API element is subject to removal in a future version. Use default constructor instead.
AbstractAddStepHandler(AbstractAddStepHandler.Parameters parameters)	Deprecated, for removal: This API element is subject to removal in a future version. Use default constructor instead.
AbstractAddStepHandler(AttributeDefinition... attributes)	Deprecated, for removal: This API element is subject to removal in a future version. Use default constructor instead.

Method Summary

Modifier and Type	Method	Description
protected Resource	createResource(OperationContext context)	Create the Resource that the execute(OperationContext, ModelNode) method operates on.
protected Resource	createResource(OperationContext context, org.jboss.dmr.ModelNode operation)	Create the Resource that the execute(OperationContext, ModelNode) method operates on.
void	execute(OperationContext context, org.jboss.dmr.ModelNode operation)	Execute this step.
Collection<? extends AttributeDefinition>	getAttributes()	Deprecated, for removal: This API element is subject to removal in a future version. Use the OperationDefinition.getParameters() method of the operation definition with which this handler was registered instead.
protected void	performRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource)	Make any runtime changes necessary to effect the changes indicated by the given operation.
protected void	performRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model)	Make any runtime changes necessary to effect the changes indicated by the given operation.
protected void	populateModel(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource)	Populate the given resource in the persistent configuration model based on the values in the given operation.
protected void	populateModel(org.jboss.dmr.ModelNode operation, Resource resource)	Deprecated, for removal: This API element is subject to removal in a future version. Override populateModel(OperationContext, ModelNode, Resource) if necessary
protected void	populateModel(org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model)	Deprecated, for removal: This API element is subject to removal in a future version. Override populateModel(OperationContext, ModelNode, Resource) if necessary
protected void	recordCapabilitiesAndRequirements(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource)	Record any new capabilities that are available as a result of this operation, as well as any requirements for other capabilities that now exist.
protected boolean	requiresRuntime(OperationContext context)	Gets whether a OperationContext.Stage.RUNTIME step should be added to call performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource)}.
protected void	rollbackRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource)	Rollback runtime changes made in performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource).

Methods inherited from class java.lang.Object

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

Field Details

attributes

@Deprecated(forRemoval=true)
protected final Collection<? extends AttributeDefinition> attributes

Deprecated, for removal: This API element is subject to removal in a future version.

This is only retained to support getAttributes() and for those subclasses that reference this protected attribute directly.

Constructor Details

AbstractAddStepHandler

public AbstractAddStepHandler()

Constructs an add handler.

AbstractAddStepHandler

@Deprecated(forRemoval=true)
public AbstractAddStepHandler(Collection<? extends AttributeDefinition> attributes)

Deprecated, for removal: This API element is subject to removal in a future version.

Use default constructor instead. Resource model auto-population logic relies on the OperationDefinition.getParameters() method of the operation definition with which this handler was registered.

Constructs an add handler

Parameters:

attributes - attributes to use in populateModel(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource)

AbstractAddStepHandler

@Deprecated(forRemoval=true)
public AbstractAddStepHandler(AttributeDefinition... attributes)

Deprecated, for removal: This API element is subject to removal in a future version.

Use default constructor instead. Resource model auto-population logic relies on the OperationDefinition.getParameters() method of the operation definition with which this handler was registered.

Constructs an add handler

Parameters:

attributes - attributes to use in populateModel(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource)

AbstractAddStepHandler

@Deprecated(forRemoval=true)
public AbstractAddStepHandler(AbstractAddStepHandler.Parameters parameters)

Deprecated, for removal: This API element is subject to removal in a future version.

Use default constructor instead. Resource model auto-population logic relies on the OperationDefinition.getParameters() method of the operation definition with which this handler was registered.

Constructs an add handler

Parameters:

attributes - attributes to use in populateModel(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource)

Method Details

getAttributes

@Deprecated(forRemoval=true)
public Collection<? extends AttributeDefinition> getAttributes()

Deprecated, for removal: This API element is subject to removal in a future version.

Use the OperationDefinition.getParameters() method of the operation definition with which this handler was registered instead.

Returns the attributes with which this handler was constructed.

Specified by:

getAttributes in interface OperationDescriptor

execute

public void execute(OperationContext context,
 org.jboss.dmr.ModelNode operation)
             throws OperationFailedException

Description copied from interface: OperationStepHandler

Execute this step. If the operation fails, context.getFailureDescription() must be called, or an OperationFailedException must be thrown. If the operation succeeded and the operation provides a return value, context.getResult() should be called and the result populated with the outcome. If the handler wishes to take further action once the result of the overall operation execution is known, one of the context.completeStep variants should be called to register a callback. The callback will not be invoked if this method throws an exception.

When this method is invoked the thread context classloader will be set to be the defining class loader of the class that implements this interface.

Specified by:

execute in interface OperationStepHandler

Parameters:

context - the operation context

operation - the operation being executed

Throws:

OperationFailedException - if the operation failed before calling context.completeStep()

createResource

protected Resource createResource(OperationContext context,
 org.jboss.dmr.ModelNode operation)

Create the Resource that the execute(OperationContext, ModelNode) method operates on. This method is invoked during OperationContext.Stage.MODEL.

This default implementation uses the default resource creation facility exposed by the context. Subclasses wishing to create a custom resource type can override this method.

Parameters:

context - the operation context

operation - the operation

createResource

protected Resource createResource(OperationContext context)

Create the Resource that the execute(OperationContext, ModelNode) method operates on. This method is invoked during OperationContext.Stage.MODEL.

This default implementation uses the default resource creation facility exposed by the context. Subclasses wishing to create a custom resource type can override this method.

Parameters:

context - the operation context

populateModel

protected void populateModel(OperationContext context,
 org.jboss.dmr.ModelNode operation,
 Resource resource)
                      throws OperationFailedException

Populate the given resource in the persistent configuration model based on the values in the given operation. This method isinvoked during OperationContext.Stage.MODEL.

This default implementation simply calls populateModel(ModelNode, org.jboss.as.controller.registry.Resource).

Parameters:

context - the operation context

operation - the operation

resource - the resource that corresponds to the address of operation

Throws:

OperationFailedException - if operation is invalid or populating the model otherwise fails

populateModel

@Deprecated(forRemoval=true)
protected void populateModel(org.jboss.dmr.ModelNode operation,
 Resource resource)
                      throws OperationFailedException

Deprecated, for removal: This API element is subject to removal in a future version.

Override populateModel(OperationContext, ModelNode, Resource) if necessary

Populate the given resource in the persistent configuration model based on the values in the given operation. This method is invoked during OperationContext.Stage.MODEL.

This default implementation simply calls populateModel(ModelNode, org.jboss.dmr.ModelNode).

Parameters:

operation - the operation

resource - the resource that corresponds to the address of operation

Throws:

OperationFailedException - if operation is invalid or populating the model otherwise fails

populateModel

@Deprecated(forRemoval=true)
protected void populateModel(org.jboss.dmr.ModelNode operation,
 org.jboss.dmr.ModelNode model)
                      throws OperationFailedException

Deprecated, for removal: This API element is subject to removal in a future version.

Override populateModel(OperationContext, ModelNode, Resource) if necessary

Populate the given node in the persistent configuration model based on the values in the given operation. This method is invoked during OperationContext.Stage.MODEL.

This default implementation invokes AttributeDefinition.validateAndSet(org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode) on any attributes passed to the constructor.

Parameters:

operation - the operation

model - persistent configuration model node that corresponds to the address of operation

Throws:

OperationFailedException - if operation is invalid or populating the model otherwise fails

recordCapabilitiesAndRequirements

protected void recordCapabilitiesAndRequirements(OperationContext context,
 org.jboss.dmr.ModelNode operation,
 Resource resource)
                                          throws OperationFailedException

Record any new capabilities that are available as a result of this operation, as well as any requirements for other capabilities that now exist. This method is invoked during OperationContext.Stage.MODEL.

Any changes made by this method will automatically be discarded if the operation rolls back.

This default implementation registers any capabilities provided to the constructor and asks any AttributeDefinition provided to the constructor to add capability requirements.

Parameters:

context - the context. Will not be null

operation - the operation that is executing Will not be null

resource - the resource that has been added. Will reflect any updates made by populateModel(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource). Will not be null

Throws:

OperationFailedException

requiresRuntime

protected boolean requiresRuntime(OperationContext context)

Gets whether a OperationContext.Stage.RUNTIME step should be added to call performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource)}. This default implementation will return true for a normal server running in normal (non admin-only) mode. If running on a host controller, it will return true if it is the active copy of the host controller subsystem. Subclasses that perform no runtime update could override and return false. This method is invoked during OperationContext.Stage.MODEL.

Parameters:

context - operation context

Returns:

true if performRuntime should be invoked; false otherwise.

performRuntime

protected void performRuntime(OperationContext context,
 org.jboss.dmr.ModelNode operation,
 Resource resource)
                       throws OperationFailedException

Make any runtime changes necessary to effect the changes indicated by the given operation. Executes after populateModel(org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode), so the given resource parameter will reflect any changes made in that method. This method is invoked during OperationContext.Stage.RUNTIME. Subclasses that wish to make changes to runtime services should override either this method or the performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode) variant. Override this one if you wish to make use of the resource parameter beyond simply accessing its model property.

This default implementation simply calls the performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode) variant. Subclasses that override this method should not call super.performRuntime(...).

Parameters:

context - the operation context

operation - the operation being executed

resource - persistent configuration resource that corresponds to the address of operation

Throws:

OperationFailedException - if operation is invalid or updating the runtime otherwise fails

performRuntime

protected void performRuntime(OperationContext context,
 org.jboss.dmr.ModelNode operation,
 org.jboss.dmr.ModelNode model)
                       throws OperationFailedException

Make any runtime changes necessary to effect the changes indicated by the given operation. Executes after populateModel(org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode), so the given resource parameter will reflect any changes made in that method. This method is invoked during OperationContext.Stage.RUNTIME. Subclasses that wish to make changes to runtime services should override this method or the performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource) variant.

Parameters:

context - the operation context

operation - the operation being executed

model - persistent configuration model from the resource that corresponds to the address of operation

Throws:

OperationFailedException - if operation is invalid or updating the runtime otherwise fails

rollbackRuntime

protected void rollbackRuntime(OperationContext context,
 org.jboss.dmr.ModelNode operation,
 Resource resource)

Rollback runtime changes made in performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource). Any services that were added in OperationContext.Stage.RUNTIME will be automatically removed after this method executes. Called from the OperationContext.ResultHandler or OperationContext.RollbackHandler passed to OperationContext.completeStep(...).

Parameters:

context - the operation context

operation - the operation being executed

resource - persistent configuration model node that corresponds to the address of operation