org.jboss.as.domain.management.audit

Class FileAuditLogHandlerResourceDefinition.HandlerWriteAttributeHandler

java.lang.Object

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

org.jboss.as.domain.management.audit.FileAuditLogHandlerResourceDefinition.HandlerWriteAttributeHandler

All Implemented Interfaces:

OperationStepHandler

Direct Known Subclasses:

PeriodicRotatingFileAuditLogHandlerResourceDefinition.PeriodicRotatingHandlerWriteAttributeHandler, SizeRotatingFileAuditLogHandlerResourceDefinition.SizeRotatingHandlerWriteAttributeHandler

Enclosing class:

FileAuditLogHandlerResourceDefinition

protected static class FileAuditLogHandlerResourceDefinition.HandlerWriteAttributeHandler
extends AbstractWriteAttributeHandler<Void>

Nested Class Summary

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

AbstractWriteAttributeHandler.HandbackHolder<T>

Constructor Summary

Constructors

Constructor and Description
HandlerWriteAttributeHandler(ManagedAuditLogger auditLogger, PathManagerService pathManager, AttributeDefinition... attributeDefinitions)

Method Summary

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<Void> handbackHolder) Hook to allow subclasses to make runtime changes to effect the attribute value change.
protected AbstractFileAuditLogHandler	createHandler(PathManagerService pathManager, OperationContext context, org.jboss.dmr.ModelNode operation)
protected void	finishModelStage(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode newValue, org.jboss.dmr.ModelNode oldValue, Resource model) Hook to allow subclasses to do any final OperationContext.Stage.MODEL processing following the application of the new attribute value.
protected 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, getAttributeDefinition, recordCapabilitiesAndRequirements, validateUpdatedModel

Methods inherited from class java.lang.Object

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

Constructor Detail

HandlerWriteAttributeHandler

public HandlerWriteAttributeHandler(ManagedAuditLogger auditLogger,
                                    PathManagerService pathManager,
                                    AttributeDefinition... attributeDefinitions)

Method Detail

requiresRuntime

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

createHandler

protected AbstractFileAuditLogHandler createHandler(PathManagerService pathManager,
                                                    OperationContext context,
                                                    org.jboss.dmr.ModelNode operation)
                                             throws OperationFailedException

Throws:

OperationFailedException

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

finishModelStage

protected void finishModelStage(OperationContext context,
                                org.jboss.dmr.ModelNode operation,
                                String attributeName,
                                org.jboss.dmr.ModelNode newValue,
                                org.jboss.dmr.ModelNode oldValue,
                                Resource model)
                         throws OperationFailedException

Description copied from class: AbstractWriteAttributeHandler

Hook to allow subclasses to do any final OperationContext.Stage.MODEL processing following the application of the new attribute value. This default implementation calls AbstractWriteAttributeHandler.validateUpdatedModel(OperationContext, Resource).

NOTE: Implementations must not call OperationContext.completeStep(OperationContext.ResultHandler) or any of its variants. The method that calls this one handles step completion.

Overrides:

finishModelStage in class AbstractWriteAttributeHandler<Void>

Parameters:

context - the operation context

operation - the operation

attributeName - the name of the attribute being modified

newValue - the new value for the attribute

oldValue - the previous value for the attribute

model - the updated model resource

Throws:

OperationFailedException