public abstract class AbstractRemoveStepHandler extends Object implements OperationStepHandler
Modifier | Constructor and Description |
---|---|
protected |
AbstractRemoveStepHandler() |
protected |
AbstractRemoveStepHandler(RuntimeCapability... capabilities) |
protected |
AbstractRemoveStepHandler(Set<RuntimeCapability> capabilities) |
Modifier and Type | Method and Description |
---|---|
void |
execute(OperationContext context,
org.jboss.dmr.ModelNode operation)
Execute this step.
|
protected void |
performRemove(OperationContext context,
org.jboss.dmr.ModelNode operation,
org.jboss.dmr.ModelNode model) |
protected void |
performRuntime(OperationContext context,
org.jboss.dmr.ModelNode operation,
org.jboss.dmr.ModelNode model) |
protected void |
recordCapabilitiesAndRequirements(OperationContext context,
org.jboss.dmr.ModelNode operation,
Resource resource)
Record any new
capabilities that are no longer available as
a result of this operation, as well as any requirements for other capabilities that no longer exist. |
protected void |
recoverServices(OperationContext context,
org.jboss.dmr.ModelNode operation,
org.jboss.dmr.ModelNode model) |
protected boolean |
removeChildRecursively(PathElement child)
Gets whether a child resource should be removed via the addition of a step to invoke
the "remove" operation for its address.
|
protected boolean |
requireNoChildResources()
Deprecated.
never called; this handler now always removes child resources
|
protected boolean |
requiresRuntime(OperationContext context) |
protected AbstractRemoveStepHandler()
protected AbstractRemoveStepHandler(RuntimeCapability... capabilities)
protected AbstractRemoveStepHandler(Set<RuntimeCapability> capabilities)
public void execute(OperationContext context, org.jboss.dmr.ModelNode operation) throws OperationFailedException
OperationStepHandler
context.getFailureDescription()
must be called, or an OperationFailedException
must be thrown.
If the operation succeeded and the operation provides a return value, context.getResult()
should
be called and the result populated with the outcome. If the handler wishes to take further action once the result
of the overall operation execution is known, one of the
context.completeStep variants
should be called to register a callback. The callback will not be invoked if this method throws an exception.
When this method is invoked the thread context classloader
will
be set to be the defining class loader of the class that implements this interface.
execute
in interface OperationStepHandler
context
- the operation contextoperation
- the operation being executedOperationFailedException
- if the operation failed before calling context.completeStep()
protected void performRemove(OperationContext context, org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model) throws OperationFailedException
OperationFailedException
protected void recordCapabilitiesAndRequirements(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource) throws OperationFailedException
capabilities
that are no longer available as
a result of this operation, as well as any requirements for other capabilities that no longer exist. This method is
invoked during OperationContext.Stage.MODEL
.
Any changes made by this method will automatically be discarded if the operation rolls back.
This default implementation deregisters any capabilities passed to the constructor.
context
- the context. Will not be null
operation
- the operation that is executing Will not be null
resource
- the resource that will be removed. Will not reflect any updates made by
performRemove(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode)
as this method
is invoked before that method is. Will not be null
OperationFailedException
@Deprecated protected boolean requireNoChildResources()
true
if the operation should fail in the presence of child resourcesprotected boolean removeChildRecursively(PathElement child)
false
then the child resource will simply be discarded along with their parent.
false
from this method, it must ensure that it itself
will make any necessary changes to the capability registry and the service container associated with
the child resource. Generally, returning false
would only be appropriate for parent resources whose
children only represent configuration details of the parent, and are not independent entities.
This default implementation returns true
child
- the path element pointing to the child resourcetrue
if separate steps should be added to remove children; false
if any children can simply be discarded along with the parentprotected void performRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model) throws OperationFailedException
OperationFailedException
protected void recoverServices(OperationContext context, org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model) throws OperationFailedException
OperationFailedException
protected boolean requiresRuntime(OperationContext context)
Copyright © 2023 JBoss by Red Hat. All rights reserved.