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 class AbstractAddStepHandler
extends Object
implements OperationStepHandler, OperationDescriptor

Base class for OperationStepHandler implementations that add managed resource.

Author:

John Bailey

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractAddStepHandler.Parameters

Field Summary

Fields

Modifier and Type	Field	Description
protected Collection<? extends AttributeDefinition>	attributes

Constructor Summary

Constructors

Constructor	Description
AbstractAddStepHandler()	Constructs an add handler.
AbstractAddStepHandler(Collection<? extends AttributeDefinition> attributes)	Constructs an add handler
AbstractAddStepHandler(Set<RuntimeCapability> capabilities, Collection<? extends AttributeDefinition> attributes)	Deprecated. Use instead. {@link RuntimeCapability} should be registered with {@link ManagementResourceRegistration}
AbstractAddStepHandler(Set<RuntimeCapability> capabilities, AttributeDefinition... attributes)	Deprecated. Use instead. {@link RuntimeCapability} should be registered with {@link ManagementResourceRegistration}
AbstractAddStepHandler(AbstractAddStepHandler.Parameters parameters)
AbstractAddStepHandler(AttributeDefinition... attributes)	Constructs an add handler
AbstractAddStepHandler(RuntimeCapability capability, Collection<? extends AttributeDefinition> attributes)	Deprecated. Use instead. {@link RuntimeCapability} should be registered with {@link ManagementResourceRegistration}
AbstractAddStepHandler(RuntimeCapability capability, AttributeDefinition... attributes)	Deprecated. Use instead. {@link RuntimeCapability} should be registered with {@link ManagementResourceRegistration}

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)	{@inheritDoc
Collection<? extends AttributeDefinition>	getAttributes()
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)	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, org.jboss.dmr.ModelNode model)	Populate the given node in the persistent configuration model based on the values in the given operation.
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).
protected void	rollbackRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model, List<org.jboss.msc.service.ServiceController<?>> controllers)	Deprecated. instead override rollbackRuntime(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 Detail

attributes

protected final Collection<? extends AttributeDefinition> attributes

Constructor Detail

AbstractAddStepHandler

public AbstractAddStepHandler()

Constructs an add handler.

AbstractAddStepHandler

public AbstractAddStepHandler(Collection<? extends AttributeDefinition> attributes)

Constructs an add handler

Parameters:

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

AbstractAddStepHandler

@Deprecated
public AbstractAddStepHandler(RuntimeCapability capability,
                              Collection<? extends AttributeDefinition> attributes)

Deprecated.

Use instead. {@link RuntimeCapability} should be registered with {@link ManagementResourceRegistration}

Constructs an add handler

Parameters:

capability - capability to register in recordCapabilitiesAndRequirements(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource) null is allowed

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

AbstractAddStepHandler

@Deprecated
public AbstractAddStepHandler(Set<RuntimeCapability> capabilities,
                              Collection<? extends AttributeDefinition> attributes)

Deprecated.

Use instead. {@link RuntimeCapability} should be registered with {@link ManagementResourceRegistration}

Constructs an add handler.

Parameters:

capabilities - capabilities to register in recordCapabilitiesAndRequirements(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource) null is allowed

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

AbstractAddStepHandler

@Deprecated
public AbstractAddStepHandler(RuntimeCapability capability,
                              AttributeDefinition... attributes)

Deprecated.

Use instead. {@link RuntimeCapability} should be registered with {@link ManagementResourceRegistration}

Constructs an add handler

Parameters:

capability - capability to register in recordCapabilitiesAndRequirements(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource) null is allowed

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

AbstractAddStepHandler

public AbstractAddStepHandler(AttributeDefinition... attributes)

Constructs an add handler

Parameters:

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

AbstractAddStepHandler

@Deprecated
public AbstractAddStepHandler(Set<RuntimeCapability> capabilities,
                              AttributeDefinition... attributes)

Deprecated.

Use instead. {@link RuntimeCapability} should be registered with {@link ManagementResourceRegistration}

Constructs an add handler

Parameters:

capabilities - capabilities to register in recordCapabilitiesAndRequirements(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource) null is allowed

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

AbstractAddStepHandler

public AbstractAddStepHandler(AbstractAddStepHandler.Parameters parameters)

Method Detail

getAttributes

public Collection<? extends AttributeDefinition> getAttributes()

Specified by:

getAttributes in interface OperationDescriptor

execute

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

{@inheritDoc

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

protected void populateModel(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 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

protected void populateModel(org.jboss.dmr.ModelNode operation,
                             org.jboss.dmr.ModelNode model)
                      throws OperationFailedException

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(...).

To provide compatible behavior with previous releases, this default implementation calls the deprecated rollbackRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, java.util.List) variant, passing in an empty list for the controllers parameter. Subclasses that overrode that method are encouraged to instead override this one. Subclasses that override this method should not call super.rollbackRuntime(...).

Parameters:

context - the operation context

operation - the operation being executed

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

rollbackRuntime

@Deprecated
protected void rollbackRuntime(OperationContext context,
                               org.jboss.dmr.ModelNode operation,
                               org.jboss.dmr.ModelNode model,
                               List<org.jboss.msc.service.ServiceController<?>> controllers)

Deprecated.

instead override rollbackRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource)

Deprecated. Subclasses wishing for custom rollback behavior should instead override rollbackRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource).

This default implementation does nothing. Subclasses that override this method should not call super.performRuntime(...).

Parameters:

context - the operation context

operation - the operation being executed

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

controllers - will always be an empty list