Package org.jboss.as.controller

Class ReloadRequiredAddStepHandler

java.lang.Object

org.jboss.as.controller.AbstractAddStepHandler

org.jboss.as.controller.ReloadRequiredAddStepHandler

All Implemented Interfaces:

OperationDescriptor, OperationStepHandler

public class ReloadRequiredAddStepHandler
extends AbstractAddStepHandler

An handler for an 'add' operation that does nothing in the runtime stage but put the process in reload-required state. It does nothing at all in the runtime stage during boot.

Use case for this handler is for resources that only represent configuration data of their parent. During boot in the runtime stage the parent reads the child model and configures its services accordingly. Thereafter any change to the child model should put the process in reload-required.

The RestartParentResourceAddHandler performs a similar function, but allows restart of the parent resource.

Author:

Brian Stansberry

See Also:

RestartParentResourceAddHandler

Nested Class Summary

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

AbstractAddStepHandler.Parameters

Field Summary

Fields inherited from class org.jboss.as.controller.AbstractAddStepHandler

attributes

Constructor Summary

Constructors

Constructor	Description
ReloadRequiredAddStepHandler(Collection<AttributeDefinition> attributes)
ReloadRequiredAddStepHandler(Set<RuntimeCapability> capabilities, Collection<AttributeDefinition> attributes)	Deprecated.
ReloadRequiredAddStepHandler(AbstractAddStepHandler.Parameters parameters)
ReloadRequiredAddStepHandler(AttributeDefinition... attributes)
ReloadRequiredAddStepHandler(RuntimeCapability capability, AttributeDefinition... attributes)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected void	performRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource)	Make any runtime changes necessary to effect the changes indicated by the given operation.
protected boolean	requiresRuntime(OperationContext context)	Gets whether a OperationContext.Stage.RUNTIME step should be added to call AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource)}.
protected void	rollbackRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource)	Rollback runtime changes made in AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource).

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

createResource, createResource, execute, getAttributes, performRuntime, populateModel, populateModel, populateModel, recordCapabilitiesAndRequirements, rollbackRuntime

Methods inherited from class java.lang.Object

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

Constructor Detail

ReloadRequiredAddStepHandler

public ReloadRequiredAddStepHandler(AttributeDefinition... attributes)

ReloadRequiredAddStepHandler

public ReloadRequiredAddStepHandler(Collection<AttributeDefinition> attributes)

ReloadRequiredAddStepHandler

@Deprecated
public ReloadRequiredAddStepHandler(RuntimeCapability capability,
                                    AttributeDefinition... attributes)

Deprecated.

ReloadRequiredAddStepHandler

@Deprecated
public ReloadRequiredAddStepHandler(Set<RuntimeCapability> capabilities,
                                    Collection<AttributeDefinition> attributes)

Deprecated.

ReloadRequiredAddStepHandler

public ReloadRequiredAddStepHandler(AbstractAddStepHandler.Parameters parameters)

Method Detail

requiresRuntime

protected boolean requiresRuntime(OperationContext context)

Description copied from class: AbstractAddStepHandler

Gets whether a OperationContext.Stage.RUNTIME step should be added to call AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource)}. This default implementation will return true for a normal server running in normal (non admin-only) mode. If running on a host controller, it will return true if it is the active copy of the host controller subsystem. Subclasses that perform no runtime update could override and return false. This method is invoked during OperationContext.Stage.MODEL.

Overrides:

requiresRuntime in class AbstractAddStepHandler

Parameters:

context - operation context

Returns:

true if performRuntime should be invoked; false otherwise.

performRuntime

protected void performRuntime(OperationContext context,
                              org.jboss.dmr.ModelNode operation,
                              Resource resource)

Description copied from class: AbstractAddStepHandler

Make any runtime changes necessary to effect the changes indicated by the given operation. Executes after AbstractAddStepHandler.populateModel(org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode), so the given resource parameter will reflect any changes made in that method. This method is invoked during OperationContext.Stage.RUNTIME. Subclasses that wish to make changes to runtime services should override either this method or the AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode) variant. Override this one if you wish to make use of the resource parameter beyond simply accessing its model property.

This default implementation simply calls the AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode) variant. Subclasses that override this method should not call super.performRuntime(...).

Overrides:

performRuntime in class AbstractAddStepHandler

Parameters:

context - the operation context

operation - the operation being executed

resource - persistent configuration resource that corresponds to the address of operation

rollbackRuntime

protected void rollbackRuntime(OperationContext context,
                               org.jboss.dmr.ModelNode operation,
                               Resource resource)

Description copied from class: AbstractAddStepHandler

Rollback runtime changes made in AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource). Any services that were added in OperationContext.Stage.RUNTIME will be automatically removed after this method executes. Called from the OperationContext.ResultHandler or OperationContext.RollbackHandler passed to OperationContext.completeStep(...).

To provide compatible behavior with previous releases, this default implementation calls the deprecated AbstractAddStepHandler.rollbackRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, java.util.List) variant, passing in an empty list for the controllers parameter. Subclasses that overrode that method are encouraged to instead override this one. Subclasses that override this method should not call super.rollbackRuntime(...).

Overrides:

rollbackRuntime in class AbstractAddStepHandler

Parameters:

context - the operation context

operation - the operation being executed

resource - persistent configuration model node that corresponds to the address of operation