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>

Field Summary

Fields

Modifier and Type	Field	Description
static OperationStepHandler	INSTANCE

Constructor Summary

Constructors

Constructor	Description
CredentialReferenceWriteAttributeHandler(AttributeDefinition attribute)	Deprecated, for removal: This API element is subject to removal in a future version. Use INSTANCE instead.
CredentialReferenceWriteAttributeHandler(AttributeDefinition... attributes)	Deprecated, for removal: This API element is subject to removal in a future version. Use INSTANCE instead.

Method Summary

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 final OperationContext.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 in AbstractWriteAttributeHandler.applyUpdateToRuntime(OperationContext, ModelNode, String, ModelNode, ModelNode, HandbackHolder).

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

execute, getAttributeDefinition, recordCapabilitiesAndRequirements, requiresRuntime, validateUpdatedModel

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final OperationStepHandler INSTANCE

Constructor Detail

CredentialReferenceWriteAttributeHandler

@Deprecated(forRemoval=true)
public CredentialReferenceWriteAttributeHandler(AttributeDefinition... attributes)

Deprecated, for removal: This API element is subject to removal in a future version.

Use INSTANCE instead.

CredentialReferenceWriteAttributeHandler

@Deprecated(forRemoval=true)
public CredentialReferenceWriteAttributeHandler(AttributeDefinition attribute)

Deprecated, for removal: This API element is subject to removal in a future version.

Use INSTANCE instead.

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

resource - 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 class ReloadRequiredWriteAttributeHandler

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 any ValueExpression has been resolved

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 resolvedValue,
                                     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).

Overrides:

revertUpdateToRuntime in class ReloadRequiredWriteAttributeHandler

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

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