org.jboss.as.controller

Class AbstractWriteAttributeHandler<T>

java.lang.Object

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

Type Parameters:

T - the type of an object that, if stored by the applyUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, HandbackHolder) implementation, will be passed to revertUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, Object).

All Implemented Interfaces:

OperationStepHandler

Direct Known Subclasses:

AbstractLoggerWriteAttributeHandler, AbstractLogHandlerWriteAttributeHandler, BindingFixedPortHandler, BindingInterfaceHandler, BindingMulticastAddressHandler, BindingMulticastPortHandler, BindingPortHandler, ClientMappingsHandler, ConnectionFactoryWriteAttributeHandler, DefaultResourceAdapterWriteHandler, DefaultSessionBeanAccessTimeoutWriteHandler, DisableRequiredWriteAttributeHandler, EeWriteAttributeHandler, EJB3SubsystemDefaultCacheWriteHandler, EJB3SubsystemDefaultEntityBeanOptimisticLockingWriteHandler, EJB3SubsystemDefaultPoolWriteHandler, HornetQServerControlWriteHandler, HttpManagementWriteAttributeHandler, HttpManagementWriteAttributeHandler, JAXRPropertyWrite, JAXRWriteAttributeHandler, JPADefaultDatasourceWriteHandler, LdapConnectionWriteAttributeHandler, NativeManagementWriteAttributeHandler, NativeManagementWriteAttributeHandler, OSGiFrameworkPropertyWrite, PassivationStoreWriteHandler, PoolConfigurationRWHandler.PoolConfigurationWriteHandler, ReloadRequiredWriteAttributeHandler, RestartParentWriteAttributeHandler, StrictMaxPoolWriteHandler, ThreadsWriteAttributeOperationHandler, UserWriteAttributeHandler, WriteDeploymentTimeoutAttributeHandler

public abstract class AbstractWriteAttributeHandler<T>
extends Object
implements OperationStepHandler

Abstract handler for the write aspect of a read-write attribute.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractWriteAttributeHandler.HandbackHolder<T> Holder subclasses can use to pass an object between applyUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, HandbackHolder) and revertUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, Object).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWriteAttributeHandler()
protected	AbstractWriteAttributeHandler(AttributeDefinition... definitions)
protected	AbstractWriteAttributeHandler(ParameterValidator validator)
protected	AbstractWriteAttributeHandler(ParameterValidator unresolvedValidator, ParameterValidator resolvedValidator)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	applyUpdateToRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode resolvedValue, org.jboss.dmr.ModelNode currentValue, AbstractWriteAttributeHandler.HandbackHolder<T> handbackHolder) Hook to allow subclasses to make runtime changes to effect the attribute value change.
void	execute(OperationContext context, org.jboss.dmr.ModelNode operation) Execute this step.
protected AttributeDefinition	getAttributeDefinition(String attributeName)
protected boolean	requiresRuntime(OperationContext context) Gets whether a OperationContext.Stage.RUNTIME handler should be added.
protected abstract void	revertUpdateToRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode valueToRestore, org.jboss.dmr.ModelNode valueToRevert, T handback) Hook to allow subclasses to revert runtime changes made in applyUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, HandbackHolder).
protected void	validateResolvedValue(String attributeName, org.jboss.dmr.ModelNode resolvedValue) If a resolved value validator was passed to the constructor, uses it to validate the value.
protected void	validateUnresolvedValue(String attributeName, org.jboss.dmr.ModelNode unresolvedValue) If an unresolved value validator was passed to the constructor, uses it to validate the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractWriteAttributeHandler

protected AbstractWriteAttributeHandler()

AbstractWriteAttributeHandler

protected AbstractWriteAttributeHandler(ParameterValidator validator)

AbstractWriteAttributeHandler

protected AbstractWriteAttributeHandler(AttributeDefinition... definitions)

AbstractWriteAttributeHandler

protected AbstractWriteAttributeHandler(ParameterValidator unresolvedValidator,
                             ParameterValidator resolvedValidator)

Method Detail

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.getFailureDescroption() must be called, or OperationFailedException must be thrown, before calling context.completeStep(). If the operation succeeded, context.getResult() should be called and the result populated with the outcome, after which context.completeStep() must be called.

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

applyUpdateToRuntime

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

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

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 ModelNode.resolve() has been called on it

currentValue - the existing value for the attribute

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

Returns:

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

Throws:

OperationFailedException

revertUpdateToRuntime

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

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

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

validateUnresolvedValue

protected void validateUnresolvedValue(String attributeName,
                           org.jboss.dmr.ModelNode unresolvedValue)
                                throws OperationFailedException

If an unresolved value validator was passed to the constructor, uses it to validate the value. Subclasses can alter this behavior.

Parameters:

attributeName - the name of the attribute being updated

unresolvedValue - the unresolved value

Throws:

OperationFailedException

validateResolvedValue

protected void validateResolvedValue(String attributeName,
                         org.jboss.dmr.ModelNode resolvedValue)
                              throws OperationFailedException

If a resolved value validator was passed to the constructor, uses it to validate the value. Subclasses can alter this behavior.

Parameters:

attributeName - the name of the attribute being updated

resolvedValue - the resolved value

Throws:

OperationFailedException

requiresRuntime

protected boolean requiresRuntime(OperationContext context)

Gets whether a OperationContext.Stage.RUNTIME handler should be added.

Parameters:

context - operation context

Returns:

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

getAttributeDefinition

protected AttributeDefinition getAttributeDefinition(String attributeName)