org.jboss.as.host.controller.operations

Class HttpManagementAddHandler

java.lang.Object

org.jboss.as.controller.AbstractAddStepHandler

org.jboss.as.host.controller.operations.HttpManagementAddHandler

All Implemented Interfaces:

OperationStepHandler

public class HttpManagementAddHandler
extends AbstractAddStepHandler

A handler that activates the HTTP management API.

Author:

Jason T. Greene, Darran Lofthouse

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPERATION_NAME

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

attributes

Constructor Summary

Constructors

Constructor and Description
HttpManagementAddHandler(LocalHostControllerInfoImpl hostControllerInfo, HostControllerEnvironment environment)

Method Summary

Modifier and Type	Method and Description
static void	installHttpManagementServices(RunningMode runningMode, org.jboss.msc.service.ServiceTarget serviceTarget, LocalHostControllerInfo hostControllerInfo, HostControllerEnvironment environment, ServiceVerificationHandler verificationHandler, boolean onDemand, boolean httpUpgrade, org.jboss.msc.service.ServiceRegistry serviceRegistry, List<org.jboss.msc.service.ServiceController<?>> newControllers)
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) Gets whether AbstractAddStepHandler.performRuntime(OperationContext, org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode, ServiceVerificationHandler, java.util.List)} should be called.
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

createResource, execute, populateModel, populateModel, requiresRuntimeVerification

Methods inherited from class java.lang.Object

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

Field Detail

OPERATION_NAME

public static final String OPERATION_NAME

See Also:

Constant Field Values

Constructor Detail

HttpManagementAddHandler

public HttpManagementAddHandler(LocalHostControllerInfoImpl hostControllerInfo,
                                HostControllerEnvironment environment)

Method Detail

populateModel

protected void populateModel(org.jboss.dmr.ModelNode operation,
                             org.jboss.dmr.ModelNode model)
                      throws OperationFailedException

Description copied from class: AbstractAddStepHandler

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

Overrides:

populateModel in class AbstractAddStepHandler

Parameters:

operation - the operation

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

Throws:

OperationFailedException - if operation is invalid or populating the model 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.

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

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)

installHttpManagementServices

public static void installHttpManagementServices(RunningMode runningMode,
                                                 org.jboss.msc.service.ServiceTarget serviceTarget,
                                                 LocalHostControllerInfo hostControllerInfo,
                                                 HostControllerEnvironment environment,
                                                 ServiceVerificationHandler verificationHandler,
                                                 boolean onDemand,
                                                 boolean httpUpgrade,
                                                 org.jboss.msc.service.ServiceRegistry serviceRegistry,
                                                 List<org.jboss.msc.service.ServiceController<?>> newControllers)