Package org.jboss.as.logging

Class LoggingOperations.LoggingWriteAttributeHandler

java.lang.Object

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

org.jboss.as.logging.LoggingOperations.LoggingWriteAttributeHandler

All Implemented Interfaces:

OperationStepHandler

Enclosing class:

LoggingOperations

public abstract static class LoggingOperations.LoggingWriteAttributeHandler
extends AbstractWriteAttributeHandler<ConfigurationPersistence>

A default log handler write attribute step handler.

Nested Class Summary

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

AbstractWriteAttributeHandler.HandbackHolder<T extends Object>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LoggingWriteAttributeHandler(AttributeDefinition[] attributes)

Method Summary

Modifier and Type	Method	Description
protected OperationStepHandler	afterPrepare(org.jboss.logmanager.config.LogContextConfiguration logContextConfiguration, String attributeName, org.jboss.dmr.ModelNode resolvedValue, org.jboss.dmr.ModelNode currentValue)	An OperationStepHandler o register after the prepare has been executed.
protected abstract boolean	applyUpdate(OperationContext context, String attributeName, String addressName, org.jboss.dmr.ModelNode value, org.jboss.logmanager.config.LogContextConfiguration logContextConfiguration)	Applies the update to the runtime.
protected boolean	applyUpdateToRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode resolvedValue, org.jboss.dmr.ModelNode currentValue, AbstractWriteAttributeHandler.HandbackHolder<ConfigurationPersistence> handbackHolder)
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, ConfigurationPersistence configurationPersistence)
protected void	validateUpdatedModel(OperationContext context, Resource model)

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

execute, finishModelStage, getAttributeDefinition, recordCapabilitiesAndRequirements, requiresRuntime

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggingWriteAttributeHandler

protected LoggingWriteAttributeHandler(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<ConfigurationPersistence> handbackHolder)
                                      throws OperationFailedException

Specified by:

applyUpdateToRuntime in class AbstractWriteAttributeHandler<ConfigurationPersistence>

Throws:

OperationFailedException

afterPrepare

protected OperationStepHandler afterPrepare(org.jboss.logmanager.config.LogContextConfiguration logContextConfiguration,
                                            String attributeName,
                                            org.jboss.dmr.ModelNode resolvedValue,
                                            org.jboss.dmr.ModelNode currentValue)

An OperationStepHandler o register after the prepare has been executed.

If applyUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, HandbackHolder) returns true this step will not be registered.

Parameters:

logContextConfiguration - the log context configuration used

attributeName - the name of the attribute being written

currentValue - the current value of the attribute

resolvedValue - the resolved value of the attribute

Returns:

an operation step handler to register or null to not register a step

applyUpdate

protected abstract boolean applyUpdate(OperationContext context,
                                       String attributeName,
                                       String addressName,
                                       org.jboss.dmr.ModelNode value,
                                       org.jboss.logmanager.config.LogContextConfiguration logContextConfiguration)
                                throws OperationFailedException

Applies the update to the runtime.

Parameters:

context - the operation context

attributeName - the name of the attribute being written

addressName - the name of the handler or logger

value - the value to set the attribute to

logContextConfiguration - the log context configuration

Returns:

true if a restart is required, otherwise false

Throws:

OperationFailedException - if an error occurs

revertUpdateToRuntime

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

Specified by:

revertUpdateToRuntime in class AbstractWriteAttributeHandler<ConfigurationPersistence>

Throws:

OperationFailedException

validateUpdatedModel

protected void validateUpdatedModel(OperationContext context,
                                    Resource model)
                             throws OperationFailedException

Overrides:

validateUpdatedModel in class AbstractWriteAttributeHandler<ConfigurationPersistence>

Throws:

OperationFailedException

getAttributes

public final AttributeDefinition[] getAttributes()

Returns a collection of attributes used for the write attribute.

Returns:

a collection of attributes