Package org.jboss.as.controller

Class ModelOnlyAddStepHandler

java.lang.Object

org.jboss.as.controller.AbstractAddStepHandler

org.jboss.as.controller.ModelOnlyAddStepHandler

All Implemented Interfaces:

OperationDescriptor, OperationStepHandler

public class ModelOnlyAddStepHandler
extends AbstractAddStepHandler

A handler for the add operation that only manipulates the model. The original expected use is for resources that have been dropped from recent versions, but for which configuration manageablity is retained in order to allow use on legacy hosts in a managed domain. This handler would be used on the host controllers for the newer version nodes (particularly the master host controller.)

Author:

Brian Stansberry (c) 2012 Red Hat Inc.

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.as.controller.AbstractAddStepHandler

AbstractAddStepHandler.Parameters

Field Summary

Fields inherited from class org.jboss.as.controller.AbstractAddStepHandler

attributes

Constructor Summary

Constructors

Constructor	Description
ModelOnlyAddStepHandler(AbstractAddStepHandler.Parameters parameters)
ModelOnlyAddStepHandler(AttributeDefinition... attributes)	Creates a new ModelOnlyStepHandler that stores the given attributes to the model.

Method Summary

Modifier and Type	Method	Description
protected void	performRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource)	Throws UnsupportedOperationException.
protected boolean	requiresRuntime(OperationContext context)	Returns false.
protected void	rollbackRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource)	Throws UnsupportedOperationException.

Methods inherited from class org.jboss.as.controller.AbstractAddStepHandler

createResource, createResource, execute, getAttributes, performRuntime, populateModel, populateModel, populateModel, recordCapabilitiesAndRequirements, rollbackRuntime

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelOnlyAddStepHandler

public ModelOnlyAddStepHandler(AttributeDefinition... attributes)

Creates a new ModelOnlyStepHandler that stores the given attributes to the model.

Parameters:

attributes - the attributes

ModelOnlyAddStepHandler

public ModelOnlyAddStepHandler(AbstractAddStepHandler.Parameters parameters)

Method Detail

requiresRuntime

protected final boolean requiresRuntime(OperationContext context)

Returns false. Gets whether a OperationContext.Stage.RUNTIME step should be added to call AbstractAddStepHandler.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.

Overrides:

requiresRuntime in class AbstractAddStepHandler

Parameters:

context - operation context

Returns:

true if performRuntime should be invoked; false otherwise.

performRuntime

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

Throws UnsupportedOperationException. Make any runtime changes necessary to effect the changes indicated by the given operation. Executes after AbstractAddStepHandler.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 AbstractAddStepHandler.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 AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode) variant. Subclasses that override this method should not call super.performRuntime(...).

Overrides:

performRuntime in class AbstractAddStepHandler

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

rollbackRuntime

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

Throws UnsupportedOperationException. Rollback runtime changes made in AbstractAddStepHandler.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 AbstractAddStepHandler.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(...).

Overrides:

rollbackRuntime in class AbstractAddStepHandler

Parameters:

context - the operation context

operation - the operation being executed

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