org.jboss.as.logging.handlers

Class HandlerUpdateProperties<T extends Handler>

java.lang.Object

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

All Implemented Interfaces:

OperationStepHandler

Direct Known Subclasses:

AsyncHandlerUpdateProperties, ConsoleHandlerUpdateProperties, CustomHandlerUpdateProperties, FileHandlerUpdateProperties, PeriodicHandlerUpdateProperties, SizeRotatingHandlerUpdateProperties

public abstract class HandlerUpdateProperties<T extends Handler>
extends Object
implements OperationStepHandler

Parent operation responsible for updating the common attributes of logging handlers.

Author:

John Bailey, James R. Perkins

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HandlerUpdateProperties(AttributeDefinition... attributeDefinitions)
protected	HandlerUpdateProperties(String... attributes)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	applyUpdateToRuntime(OperationContext context, String handlerName, org.jboss.dmr.ModelNode model, org.jboss.dmr.ModelNode originalModel, T handler) Hook to allow subclasses to make runtime changes to effect the attribute value change.
protected void	copy(String name, org.jboss.dmr.ModelNode from, org.jboss.dmr.ModelNode to) Copies the attribute, represented by the name parameter, from one ModelNode to another if the from parameter has the attributed defined.
void	execute(OperationContext context, org.jboss.dmr.ModelNode operation) {@inheritDoc
Collection<AttributeDefinition>	getAttributes() Returns a collection of attributes used for the write attribute.
protected boolean	requiresRuntime(OperationContext context) Gets whether a OperationContext.Stage#RUNTIME handler should be added.
protected abstract void	revertUpdateToRuntime(OperationContext context, String handlerName, org.jboss.dmr.ModelNode model, org.jboss.dmr.ModelNode originalModel, T handler) Hook to allow subclasses to revert runtime changes made in #applyUpdateToRuntime(OperationContext, String, ModelNode, ModelNode, T).
protected void	updateModel(org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model) Update the given node in the persistent configuration model based on the values in the given operation.

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

See Also:

Constant Field Values

Constructor Detail

HandlerUpdateProperties

protected HandlerUpdateProperties(AttributeDefinition... attributeDefinitions)

HandlerUpdateProperties

protected HandlerUpdateProperties(String... attributes)

Method Detail

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

updateModel

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

Update the given node in the persistent configuration model based on the values in the given operation.

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

applyUpdateToRuntime

protected abstract boolean applyUpdateToRuntime(OperationContext context,
                           String handlerName,
                           org.jboss.dmr.ModelNode model,
                           org.jboss.dmr.ModelNode originalModel,
                           T handler)
                                         throws OperationFailedException

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

Parameters:

context - the context of the operation

model - the model

originalModel - the original model

handler - the log handler

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,
                         String handlerName,
                         org.jboss.dmr.ModelNode model,
                         org.jboss.dmr.ModelNode originalModel,
                         T handler)
                                       throws OperationFailedException

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

Parameters:

context - the context of the operation

model - the model

originalModel - the original model

handler - the log handler

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.

copy

protected void copy(String name,
        org.jboss.dmr.ModelNode from,
        org.jboss.dmr.ModelNode to)

Copies the attribute, represented by the name parameter, from one ModelNode to another if the from parameter has the attributed defined. If the attribute was not defined, nothing happens.

Parameters:

name - the name of the attribute to copy.

from - the model node to copy the value from.

to - the model node to copy the value to.

getAttributes

public final Collection<AttributeDefinition> getAttributes()

Returns a collection of attributes used for the write attribute.

Returns:

a collection of attributes.