Package org.jboss.as.controller.security
Class CredentialReferenceWriteAttributeHandler
- java.lang.Object
-
- org.jboss.as.controller.AbstractWriteAttributeHandler<Void>
-
- org.jboss.as.controller.ReloadRequiredWriteAttributeHandler
-
- org.jboss.as.controller.security.CredentialReferenceWriteAttributeHandler
-
- All Implemented Interfaces:
OperationStepHandler
public class CredentialReferenceWriteAttributeHandler extends ReloadRequiredWriteAttributeHandler
A write attribute handler that is capable of handling automatic updates of credential stores via credential reference attributes.- Author:
- Farah Juma
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.jboss.as.controller.AbstractWriteAttributeHandler
AbstractWriteAttributeHandler.HandbackHolder<T>
-
-
Constructor Summary
Constructors Constructor Description CredentialReferenceWriteAttributeHandler(AttributeDefinition attribute)
CredentialReferenceWriteAttributeHandler(AttributeDefinition... attributes)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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 void
finishModelStage(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode newValue, org.jboss.dmr.ModelNode oldValue, Resource resource)
Hook to allow subclasses to do any finalOperationContext.Stage.MODEL
processing following the application of the new attribute value.protected void
revertUpdateToRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode valueToRestore, org.jboss.dmr.ModelNode resolvedValue, Void handback)
Hook to allow subclasses to revert runtime changes made inAbstractWriteAttributeHandler.applyUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, HandbackHolder)
.-
Methods inherited from class org.jboss.as.controller.AbstractWriteAttributeHandler
execute, getAttributeDefinition, recordCapabilitiesAndRequirements, requiresRuntime, validateUpdatedModel
-
-
-
-
Constructor Detail
-
CredentialReferenceWriteAttributeHandler
public CredentialReferenceWriteAttributeHandler(AttributeDefinition... attributes)
-
CredentialReferenceWriteAttributeHandler
public CredentialReferenceWriteAttributeHandler(AttributeDefinition attribute)
-
-
Method Detail
-
finishModelStage
protected void finishModelStage(OperationContext context, org.jboss.dmr.ModelNode operation, String attributeName, org.jboss.dmr.ModelNode newValue, org.jboss.dmr.ModelNode oldValue, Resource resource) throws OperationFailedException
Description copied from class:AbstractWriteAttributeHandler
Hook to allow subclasses to do any finalOperationContext.Stage.MODEL
processing following the application of the new attribute value. This default implementation callsAbstractWriteAttributeHandler.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 classAbstractWriteAttributeHandler<Void>
- Parameters:
context
- the operation contextoperation
- the operationattributeName
- the name of the attribute being modifiednewValue
- the new value for the attributeoldValue
- the previous value for the attributeresource
- the updated model resource- 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.- Overrides:
applyUpdateToRuntime
in classReloadRequiredWriteAttributeHandler
- Parameters:
context
- the context of the operationoperation
- the operationattributeName
- the name of the attribute being modifiedresolvedValue
- the new value for the attribute, after anyValueExpression
has been resolvedcurrentValue
- the existing value for the attributehandbackHolder
- holder for an arbitrary object to pass toAbstractWriteAttributeHandler.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 resolvedValue, Void handback) throws OperationFailedException
Description copied from class:AbstractWriteAttributeHandler
Hook to allow subclasses to revert runtime changes made inAbstractWriteAttributeHandler.applyUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, HandbackHolder)
.- Overrides:
revertUpdateToRuntime
in classReloadRequiredWriteAttributeHandler
- Parameters:
context
- the context of the operationoperation
- the operationattributeName
- the name of the attribute being modifiedvalueToRestore
- the previous value for the attribute, before this operation was executedresolvedValue
- the new value for the attribute that should be revertedhandback
- an object, if any, passed in to thehandbackHolder
by theapplyUpdateToRuntime
implementation- Throws:
OperationFailedException
-
-