org.jboss.as.logging.handlers

Class AbstractLogHandlerWriteAttributeHandler<T extends Handler>

java.lang.Object

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

org.jboss.as.logging.handlers.AbstractLogHandlerWriteAttributeHandler<T>

All Implemented Interfaces:

OperationStepHandler

Direct Known Subclasses:

AbstractFileHandlerWriteAttributeHandler, AsyncHandlerWriteAttributeHandler, ConsoleHandlerWriteAttributeHandler, CustomHandlerWriteAttributeHandler

public abstract class AbstractLogHandlerWriteAttributeHandler<T extends Handler>
extends AbstractWriteAttributeHandler<T>

Date: 12.10.2011

Author:

James R. Perkins

Nested Class Summary

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

AbstractWriteAttributeHandler.HandbackHolder<T>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractLogHandlerWriteAttributeHandler(AttributeDefinition... attributes)
protected	AbstractLogHandlerWriteAttributeHandler(Collection<AttributeDefinition> attributes)

Method Summary

Methods

Modifier and Type	Method and 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<T> handbackHolder) Hook to allow subclasses to make runtime changes to effect the attribute value change.
protected abstract boolean	doApplyUpdateToRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode resolvedValue, org.jboss.dmr.ModelNode currentValue, String handlerName, T handler) Applies additional runtime attributes for the handler.
protected abstract void	doRevertUpdateToRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode valueToRestore, org.jboss.dmr.ModelNode valueToRevert, String handlerName, T handler) Reverts updates to the handler.
protected AttributeDefinition	getAttributeDefinition(String attributeName)
Collection<AttributeDefinition>	getAttributes() Returns a collection of attributes used for the write attribute.
protected void	revertUpdateToRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode valueToRestore, org.jboss.dmr.ModelNode valueToRevert, T handler) Hook to allow subclasses to revert runtime changes made in AbstractWriteAttributeHandler.applyUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, HandbackHolder).
protected void	validateResolvedValue(String name, org.jboss.dmr.ModelNode value) If a resolved value validator was passed to the constructor, uses it to validate the value.
protected void	validateUnresolvedValue(String name, org.jboss.dmr.ModelNode value) If an unresolved value validator was passed to the constructor, uses it to validate the value.

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

execute, requiresRuntime

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractLogHandlerWriteAttributeHandler

protected AbstractLogHandlerWriteAttributeHandler(AttributeDefinition... attributes)

AbstractLogHandlerWriteAttributeHandler

protected AbstractLogHandlerWriteAttributeHandler(Collection<AttributeDefinition> attributes)

Method Detail

applyUpdateToRuntime

protected final 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

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<T extends Handler>

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 AbstractWriteAttributeHandler.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 final void revertUpdateToRuntime(OperationContext context,
                         org.jboss.dmr.ModelNode operation,
                         String attributeName,
                         org.jboss.dmr.ModelNode valueToRestore,
                         org.jboss.dmr.ModelNode valueToRevert,
                         T handler)
                                    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<T extends Handler>

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

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

Throws:

OperationFailedException

doApplyUpdateToRuntime

protected abstract boolean doApplyUpdateToRuntime(OperationContext context,
                             org.jboss.dmr.ModelNode operation,
                             String attributeName,
                             org.jboss.dmr.ModelNode resolvedValue,
                             org.jboss.dmr.ModelNode currentValue,
                             String handlerName,
                             T handler)
                                           throws OperationFailedException

Applies additional runtime attributes for the handler.

Parameters:

context - the context for 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

handlerName - the name of the handler.

handler - the handler to apply the changes to.

Returns:

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

Throws:

OperationFailedException - if the operation fails.

doRevertUpdateToRuntime

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

Reverts updates to the handler.

Parameters:

context - the context for 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

handlerName - the name of the handler.

handler - the handler to apply the changes to.

Throws:

OperationFailedException - if the operation fails.

validateResolvedValue

protected final void validateResolvedValue(String name,
                         org.jboss.dmr.ModelNode value)
                                    throws OperationFailedException

Description copied from class: AbstractWriteAttributeHandler

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

Overrides:

validateResolvedValue in class AbstractWriteAttributeHandler<T extends Handler>

Parameters:

name - the name of the attribute being updated

value - the resolved value

Throws:

OperationFailedException

validateUnresolvedValue

protected final void validateUnresolvedValue(String name,
                           org.jboss.dmr.ModelNode value)
                                      throws OperationFailedException

Description copied from class: AbstractWriteAttributeHandler

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

Overrides:

validateUnresolvedValue in class AbstractWriteAttributeHandler<T extends Handler>

Parameters:

name - the name of the attribute being updated

value - the unresolved value

Throws:

OperationFailedException

getAttributeDefinition

protected AttributeDefinition getAttributeDefinition(String attributeName)

Overrides:

getAttributeDefinition in class AbstractWriteAttributeHandler<T extends Handler>

getAttributes

public final Collection<AttributeDefinition> getAttributes()

Returns a collection of attributes used for the write attribute.

Returns:

a collection of attributes.