public class PathAddHandler extends AbstractAddStepHandler implements DescriptionProvider
Modifier and Type | Field and Description |
---|---|
static PathAddHandler |
NAMED_INSTANCE |
static String |
OPERATION_NAME |
static PathAddHandler |
SPECIFIED_INSTANCE |
static PathAddHandler |
SPECIFIED_NO_SERVICES_INSTANCE |
Modifier | Constructor and Description |
---|---|
protected |
PathAddHandler(boolean specified,
boolean services)
Create the PathAddHandler
|
Modifier and Type | Method and Description |
---|---|
static org.jboss.dmr.ModelNode |
getAddPathOperation(org.jboss.dmr.ModelNode address,
org.jboss.dmr.ModelNode path,
org.jboss.dmr.ModelNode relativeTo) |
org.jboss.dmr.ModelNode |
getModelDescription(Locale locale)
Gets the descriptive information (human-friendly description, list of attributes,
list of children) describing a single model node or operation.
|
protected void |
performRuntime(OperationContext context,
org.jboss.dmr.ModelNode operation,
org.jboss.dmr.ModelNode model,
ServiceVerificationHandler verificationHandler,
List<org.jboss.msc.service.ServiceController<?>> newControllers)
Make any runtime changes necessary to effect the changes indicated by the given
operation . |
protected void |
populateModel(org.jboss.dmr.ModelNode operation,
org.jboss.dmr.ModelNode model)
Populate the given node in the persistent configuration model based on the values in the given operation.
|
protected boolean |
requiresRuntime(OperationContext context)
|
protected boolean |
requiresRuntimeVerification()
Gets whether the
ServiceVerificationHandler parameter passed to
AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List)
should be added to the operation context as a step. |
execute, populateModel, populateModel, rollbackRuntime
public static final String OPERATION_NAME
public static final PathAddHandler NAMED_INSTANCE
public static final PathAddHandler SPECIFIED_INSTANCE
public static final PathAddHandler SPECIFIED_NO_SERVICES_INSTANCE
protected PathAddHandler(boolean specified, boolean services)
public static org.jboss.dmr.ModelNode getAddPathOperation(org.jboss.dmr.ModelNode address, org.jboss.dmr.ModelNode path, org.jboss.dmr.ModelNode relativeTo)
protected void populateModel(org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model) throws OperationFailedException
AbstractAddStepHandler
populateModel
in class AbstractAddStepHandler
operation
- the operationmodel
- persistent configuration model node that corresponds to the address of operation
OperationFailedException
- if operation
is invalid or populating the model otherwise failsprotected boolean requiresRuntime(OperationContext context)
AbstractAddStepHandler
AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List)
}
should be called. This default implementation always returns true
. Subclasses that perform no runtime
update could override and return false
.requiresRuntime
in class AbstractAddStepHandler
context
- operation contexttrue
if performRuntime
should be invoked; false
otherwise.protected void performRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model, ServiceVerificationHandler verificationHandler, List<org.jboss.msc.service.ServiceController<?>> newControllers)
AbstractAddStepHandler
operation
. Executes
after AbstractAddStepHandler.populateModel(org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode)
, so the given model
parameter will reflect any changes made in that method.
This default implementation does nothing.
performRuntime
in class AbstractAddStepHandler
context
- the operation contextoperation
- the operation being executedmodel
- persistent configuration model node that corresponds to the address of operation
verificationHandler
- step handler that can be added as a listener to any new services installed in order to
validate the services installed correctly during the
VERIFY stage
newControllers
- holder for the ServiceController
for any new services installed by the method. The
method should add the ServiceController
for any new services to this list. If the
overall operation needs to be rolled back, the list will be used in
AbstractAddStepHandler.rollbackRuntime(OperationContext, ModelNode, ModelNode, java.util.List)
to automatically removed
the newly added servicesprotected boolean requiresRuntimeVerification()
AbstractAddStepHandler
ServiceVerificationHandler
parameter passed to
AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List)
should be added to the operation context as a step.
This default implementation always returns true
.
requiresRuntimeVerification
in class AbstractAddStepHandler
true
if the service verification step should be added; false
if it's not necessary.public org.jboss.dmr.ModelNode getModelDescription(Locale locale)
DescriptionProvider
The implementation must assume that the caller intends to modify the
returned ModelNode
so it should not hand out a reference to any internal data structures.
getModelDescription
in interface DescriptionProvider
locale
- the locale to use to generate any localized text used in the description.
May be null
, in which case Locale.getDefault()
should be usedModelNode
describing the model node's structureCopyright © 2013 JBoss, a division of Red Hat, Inc.. All Rights Reserved.