org.jboss.as.server.services.net

Class BindingAddHandler

java.lang.Object

org.jboss.as.controller.AbstractAddStepHandler

org.jboss.as.controller.operations.common.SocketBindingAddHandler

org.jboss.as.server.services.net.BindingAddHandler

All Implemented Interfaces:

OperationStepHandler

public class BindingAddHandler
extends SocketBindingAddHandler

Handler for the server socket-binding resource's add operation.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static BindingAddHandler	INSTANCE

Fields inherited from class org.jboss.as.controller.operations.common.SocketBindingAddHandler

OPERATION_NAME

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

attributes

Method Summary

Modifier and Type	Method and Description
static org.jboss.msc.service.ServiceController<SocketBinding>	installBindingService(OperationContext context, org.jboss.dmr.ModelNode config, String name, ServiceVerificationHandler verificationHandler)
static List<ClientMapping>	parseClientMappings(org.jboss.dmr.ModelNode mappings)
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	requiresRuntime(OperationContext context) Gets whether AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List)} should be called.
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.

Methods inherited from class org.jboss.as.controller.operations.common.SocketBindingAddHandler

getOperation, populateModel

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

createResource, execute, populateModel, rollbackRuntime

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final BindingAddHandler INSTANCE

Method Detail

populateModel

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

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

requiresRuntime

protected boolean requiresRuntime(OperationContext context)

Description copied from class: AbstractAddStepHandler

Gets whether 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.

Overrides:

requiresRuntime in class AbstractAddStepHandler

Parameters:

context - operation context

Returns:

true if performRuntime should be invoked; false otherwise.

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.

installBindingService

public static org.jboss.msc.service.ServiceController<SocketBinding> installBindingService(OperationContext context,
                                                                                           org.jboss.dmr.ModelNode config,
                                                                                           String name,
                                                                                           ServiceVerificationHandler verificationHandler)
                                                                                    throws UnknownHostException,
                                                                                           OperationFailedException

Throws:

UnknownHostException

OperationFailedException

parseClientMappings

public static List<ClientMapping> parseClientMappings(org.jboss.dmr.ModelNode mappings)
                                               throws OperationFailedException

Throws:

OperationFailedException