public class BindingAddHandler extends SocketBindingAddHandler
AbstractAddStepHandler.Parameters
Modifier and Type | Field and Description |
---|---|
static BindingAddHandler |
INSTANCE |
OPERATION_NAME
attributes
Modifier and Type | Method and Description |
---|---|
static void |
installBindingService(OperationContext context,
org.jboss.dmr.ModelNode config,
String name) |
static List<ClientMapping> |
parseClientMappings(OperationContext context,
org.jboss.dmr.ModelNode mappings) |
protected void |
performRuntime(OperationContext context,
org.jboss.dmr.ModelNode operation,
org.jboss.dmr.ModelNode model)
Make any runtime changes necessary to effect the changes indicated by the given
operation . |
protected void |
populateModel(OperationContext context,
org.jboss.dmr.ModelNode operation,
Resource resource)
Populate the given resource in the persistent configuration model based on the values in 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) }. |
getOperation
createResource, createResource, execute, performRuntime, performRuntime, populateModel, populateModel, recordCapabilitiesAndRequirements, requiresRuntimeVerification, rollbackRuntime, rollbackRuntime
public static final BindingAddHandler INSTANCE
protected void populateModel(OperationContext context, org.jboss.dmr.ModelNode operation, Resource resource) throws OperationFailedException
OperationContext.Stage.MODEL
.
This default implementation simply calls AbstractAddStepHandler.populateModel(ModelNode, org.jboss.as.controller.registry.Resource)
.
populateModel
in class SocketBindingAddHandler
context
- the operation contextoperation
- the operationresource
- the resource that corresponds to the address of operation
OperationFailedException
- if operation
is invalid or populating the model otherwise failsprotected void performRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model) throws OperationFailedException
AbstractAddStepHandler
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 this method or the
AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource)
variant.
To provide compatible behavior with previous releases, this default implementation calls the deprecated
AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List)
method. It then does nothing with the objects referenced by the verificationHandler
and
controllers
parameters passed to that method. Subclasses that overrode that method are encouraged to
instead override this one or the AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.as.controller.registry.Resource)
variant. Subclasses that override this method should not callsuper.performRuntime(...)
.
performRuntime
in class AbstractAddStepHandler
context
- the operation contextoperation
- the operation being executedmodel
- persistent configuration model from the resource that corresponds to the address of operation
OperationFailedException
- if operation
is invalid or updating the runtime otherwise failsprotected boolean requiresRuntime(OperationContext context)
AbstractAddStepHandler
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.public static void installBindingService(OperationContext context, org.jboss.dmr.ModelNode config, String name) throws UnknownHostException, OperationFailedException
public static List<ClientMapping> parseClientMappings(OperationContext context, org.jboss.dmr.ModelNode mappings) throws OperationFailedException
OperationFailedException
Copyright © 2023 JBoss by Red Hat. All rights reserved.