public class ModelOnlyAddStepHandler extends AbstractAddStepHandler
add
operation that only manipulates the model. The original expected use is for
resources that have been dropped from recent versions, but for which configuration manageablity is retained in
order to allow use on legacy hosts in a managed domain. This handler would be used on the host controllers for
the newer version nodes (particularly the master host controller.)AbstractAddStepHandler.Parameters
attributes
Constructor and Description |
---|
ModelOnlyAddStepHandler(AbstractAddStepHandler.Parameters parameters) |
ModelOnlyAddStepHandler(AttributeDefinition... attributes)
Creates a new
ModelOnlyStepHandler that stores the given attributes to the model. |
Modifier and Type | Method and Description |
---|---|
protected void |
performRuntime(OperationContext context,
org.jboss.dmr.ModelNode operation,
Resource resource)
Throws
UnsupportedOperationException . |
protected boolean |
requiresRuntime(OperationContext context)
Returns
false . |
protected void |
rollbackRuntime(OperationContext context,
org.jboss.dmr.ModelNode operation,
Resource resource)
Throws
UnsupportedOperationException . |
createResource, createResource, execute, performRuntime, performRuntime, populateModel, populateModel, populateModel, recordCapabilitiesAndRequirements, requiresRuntimeVerification, rollbackRuntime
public ModelOnlyAddStepHandler(AttributeDefinition... attributes)
ModelOnlyStepHandler
that stores the given attributes to the model.attributes
- the attributespublic ModelOnlyAddStepHandler(AbstractAddStepHandler.Parameters parameters)
protected final boolean requiresRuntime(OperationContext context)
false
.
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
.requiresRuntime
in class AbstractAddStepHandler
context
- operation contexttrue
if performRuntime
should be invoked; false
otherwise.protected final void performRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource) throws OperationFailedException
UnsupportedOperationException
.
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(...)
.
performRuntime
in class AbstractAddStepHandler
context
- the operation contextoperation
- the operation being executedresource
- persistent configuration resource that corresponds to the address of operation
OperationFailedException
- if operation
is invalid or updating the runtime otherwise failsprotected final void rollbackRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource)
UnsupportedOperationException
.
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(...).
rollbackRuntime
in class AbstractAddStepHandler
context
- the operation contextoperation
- the operation being executedresource
- persistent configuration model node that corresponds to the address of operation
Copyright © 2023 JBoss by Red Hat. All rights reserved.