Package org.jboss.as.controller

Class ModelOnlyWriteAttributeHandler

java.lang.Object

org.jboss.as.controller.AbstractWriteAttributeHandler<Void>

org.jboss.as.controller.ModelOnlyWriteAttributeHandler

All Implemented Interfaces:

OperationStepHandler

public class ModelOnlyWriteAttributeHandler
extends AbstractWriteAttributeHandler<Void>

A write-attribute handler that simply validates the attribute value and stores it in the model.

Author:

Brian Stansberry (c) 2012 Red Hat Inc.

Nested Class Summary

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

AbstractWriteAttributeHandler.HandbackHolder<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final OperationStepHandler	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ModelOnlyWriteAttributeHandler()
	ModelOnlyWriteAttributeHandler(Collection<AttributeDefinition> attributeDefinitions)	Deprecated, for removal: This API element is subject to removal in a future version. Use INSTANCE instead.
	ModelOnlyWriteAttributeHandler(AttributeDefinition... attributeDefinitions)	Deprecated, for removal: This API element is subject to removal in a future version. Use INSTANCE instead.

Method Summary

Modifier and Type	Method	Description
protected boolean	applyUpdateToRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode resolvedValue, org.jboss.dmr.ModelNode currentValue, AbstractWriteAttributeHandler.HandbackHolder<Void> handbackHolder)	Hook to allow subclasses to make runtime changes to effect the attribute value change.
protected final boolean	requiresRuntime(OperationContext context)	Gets whether a OperationContext.Stage.RUNTIME handler should be added.
protected void	revertUpdateToRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode valueToRestore, org.jboss.dmr.ModelNode valueToRevert, Void handback)	Hook to allow subclasses to revert runtime changes made in AbstractWriteAttributeHandler.applyUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, HandbackHolder).

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

execute, finishModelStage, getAttributeDefinition, recordCapabilitiesAndRequirements, validateUpdatedModel

Methods inherited from class java.lang.Object

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

Field Details

INSTANCE

public static final OperationStepHandler INSTANCE

Constructor Details

ModelOnlyWriteAttributeHandler

protected ModelOnlyWriteAttributeHandler()

ModelOnlyWriteAttributeHandler

@Deprecated(forRemoval=true)
public ModelOnlyWriteAttributeHandler(AttributeDefinition... attributeDefinitions)

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

Use INSTANCE instead.

ModelOnlyWriteAttributeHandler

@Deprecated(forRemoval=true)
public ModelOnlyWriteAttributeHandler(Collection<AttributeDefinition> attributeDefinitions)

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

Use INSTANCE instead.

Method Details

requiresRuntime

protected final boolean requiresRuntime(OperationContext context)

Description copied from class: AbstractWriteAttributeHandler

Gets whether a OperationContext.Stage.RUNTIME handler should be added. This default implementation returns true if the process is a normal server and the process is not booting. The rationale for the latter check is if the process is booting, the resource being modified will have been added as a previous step in the same context, and the Stage.RUNTIME handling for that add will see a model the reflects the changes made by this handler and will apply them to the runtime.

Overrides:

requiresRuntime in class AbstractWriteAttributeHandler<Void>

Parameters:

context - operation context

Returns:

true if a runtime stage handler should be added; false otherwise.

applyUpdateToRuntime

protected boolean applyUpdateToRuntime(OperationContext context,
 org.jboss.dmr.ModelNode operation,
 String attributeName,
 org.jboss.dmr.ModelNode resolvedValue,
 org.jboss.dmr.ModelNode currentValue,
 AbstractWriteAttributeHandler.HandbackHolder<Void> handbackHolder)
                                throws OperationFailedException

Description copied from class: AbstractWriteAttributeHandler

Hook to allow subclasses to make runtime changes to effect the attribute value change.

Specified by:

applyUpdateToRuntime in class AbstractWriteAttributeHandler<Void>

Parameters:

context - the context of the operation

operation - the operation

attributeName - the name of the attribute being modified

resolvedValue - the new value for the attribute, after any ValueExpression has been resolved

currentValue - the existing value for the attribute

handbackHolder - holder for an arbitrary object to pass to AbstractWriteAttributeHandler.revertUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, Object) if the operation needs to be rolled back

Returns:

true if the server requires reload to effect the attribute value change; false if not

Throws:

OperationFailedException

revertUpdateToRuntime

protected void revertUpdateToRuntime(OperationContext context,
 org.jboss.dmr.ModelNode operation,
 String attributeName,
 org.jboss.dmr.ModelNode valueToRestore,
 org.jboss.dmr.ModelNode valueToRevert,
 Void handback)
                              throws OperationFailedException

Description copied from class: AbstractWriteAttributeHandler

Hook to allow subclasses to revert runtime changes made in AbstractWriteAttributeHandler.applyUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, HandbackHolder).

Specified by:

revertUpdateToRuntime in class AbstractWriteAttributeHandler<Void>

Parameters:

context - the context of the operation

operation - the operation

attributeName - the name of the attribute being modified

valueToRestore - the previous value for the attribute, before this operation was executed

valueToRevert - the new value for the attribute that should be reverted

handback - an object, if any, passed in to the handbackHolder by the applyUpdateToRuntime implementation

Throws:

OperationFailedException