org.jboss.as.remoting

Class RemotingEndpointAdd

java.lang.Object

org.jboss.as.controller.AbstractAddStepHandler

org.jboss.as.remoting.RemotingEndpointAdd

All Implemented Interfaces:

OperationStepHandler

public class RemotingEndpointAdd
extends AbstractAddStepHandler

Author:

Tomaz Cerar (c) 2014 Red Hat Inc.

Field Summary

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

attributes

Constructor Summary

Constructors

Constructor and Description
RemotingEndpointAdd()

Method Summary

Modifier and Type	Method and Description
protected Resource	createResource(OperationContext context) Create the Resource that the AbstractAddStepHandler.execute(OperationContext, ModelNode) method operates on.
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(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	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.
protected void	rollbackRuntime(OperationContext context, org.jboss.dmr.ModelNode operation, org.jboss.dmr.ModelNode model, List<org.jboss.msc.service.ServiceController<?>> controllers) Rollback runtime changes made in AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List).

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

execute, populateModel, populateModel, requiresRuntime

Methods inherited from class java.lang.Object

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

Constructor Detail

RemotingEndpointAdd

public RemotingEndpointAdd()

Method Detail

createResource

protected Resource createResource(OperationContext context)

Description copied from class: AbstractAddStepHandler

Create the Resource that the AbstractAddStepHandler.execute(OperationContext, ModelNode) method operates on.

Overrides:

createResource in class AbstractAddStepHandler

Parameters:

context - the operation context

populateModel

protected void populateModel(OperationContext context,
                             org.jboss.dmr.ModelNode operation,
                             Resource resource)
                      throws OperationFailedException

Description copied from class: AbstractAddStepHandler

Populate the given resource in the persistent configuration model based on the values in the given operation.

This default implementation simply calls AbstractAddStepHandler.populateModel(ModelNode, Resource).

Overrides:

populateModel in class AbstractAddStepHandler

Parameters:

context - the operation context

operation - the operation

resource - the resource that corresponds to the address of operation

Throws:

OperationFailedException - if operation is invalid or populating the model otherwise fails

performRuntime

protected void performRuntime(OperationContext context,
                              org.jboss.dmr.ModelNode operation,
                              org.jboss.dmr.ModelNode model,
                              ServiceVerificationHandler verificationHandler,
                              List<org.jboss.msc.service.ServiceController<?>> newControllers)
                       throws OperationFailedException

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 model parameter will reflect any changes made in that method.

This default implementation does nothing.

Overrides:

performRuntime in class AbstractAddStepHandler

Parameters:

context - the operation context

operation - the operation being executed

model - 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 services

Throws:

OperationFailedException - if operation is invalid or updating the runtime otherwise fails

requiresRuntimeVerification

protected boolean requiresRuntimeVerification()

Description copied from class: AbstractAddStepHandler

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.

This default implementation always returns true.

Overrides:

requiresRuntimeVerification in class AbstractAddStepHandler

Returns:

true if the service verification step should be added; false if it's not necessary.

rollbackRuntime

protected void rollbackRuntime(OperationContext context,
                               org.jboss.dmr.ModelNode operation,
                               org.jboss.dmr.ModelNode model,
                               List<org.jboss.msc.service.ServiceController<?>> controllers)

Description copied from class: AbstractAddStepHandler

Rollback runtime changes made in AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List).

This default implementation removes all services in the given list of controllers. The contents of controllers is the same as what was in the newControllers parameter passed to performRuntime() when that method returned.

Overrides:

rollbackRuntime in class AbstractAddStepHandler

Parameters:

context - the operation context

operation - the operation being executed

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

controllers - holder for the ServiceController for any new services installed by AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List)