Package org.jboss.as.controller.management

Class BaseHttpInterfaceAddStepHandler

java.lang.Object

org.jboss.as.controller.AbstractAddStepHandler

org.jboss.as.controller.management.ManagementInterfaceAddStepHandler

org.jboss.as.controller.management.BaseHttpInterfaceAddStepHandler

All Implemented Interfaces:

OperationDescriptor, OperationStepHandler

public abstract class BaseHttpInterfaceAddStepHandler
extends ManagementInterfaceAddStepHandler

The base add handler for the HTTP Management Interface.

Author:

Darran Lofthouse

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.as.controller.AbstractAddStepHandler

AbstractAddStepHandler.Parameters

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	HTTP_AUTHENTICATION_FACTORY_CAPABILITY
protected static String	SASL_AUTHENTICATION_FACTORY_CAPABILITY
protected static String	SSL_CONTEXT_CAPABILITY

Fields inherited from class org.jboss.as.controller.management.ManagementInterfaceAddStepHandler

MANAGEMENT_INTERFACE_KEY

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

attributes

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseHttpInterfaceAddStepHandler(AttributeDefinition[] attributeDefinitions)

Method Summary

Modifier and Type	Method	Description
protected abstract List<org.jboss.msc.service.ServiceName>	installServices(OperationContext context, HttpInterfaceCommonPolicy commonPolicy, org.jboss.dmr.ModelNode model)
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(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.

Methods inherited from class org.jboss.as.controller.management.ManagementInterfaceAddStepHandler

addVerifyInstallationStep, asStringIfDefined, requiresRuntime

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

createResource, createResource, execute, getAttributes, performRuntime, populateModel, populateModel, recordCapabilitiesAndRequirements, rollbackRuntime

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_AUTHENTICATION_FACTORY_CAPABILITY

protected static final String HTTP_AUTHENTICATION_FACTORY_CAPABILITY

See Also:

Constant Field Values

SASL_AUTHENTICATION_FACTORY_CAPABILITY

protected static final String SASL_AUTHENTICATION_FACTORY_CAPABILITY

See Also:

Constant Field Values

SSL_CONTEXT_CAPABILITY

protected static final String SSL_CONTEXT_CAPABILITY

See Also:

Constant Field Values

Constructor Detail

BaseHttpInterfaceAddStepHandler

protected BaseHttpInterfaceAddStepHandler(AttributeDefinition[] attributeDefinitions)

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. This method is invoked during OperationContext.Stage.MODEL.

This default implementation invokes AttributeDefinition.validateAndSet(org.jboss.dmr.ModelNode, org.jboss.dmr.ModelNode) on any attributes passed to the constructor.

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

performRuntime

public void performRuntime(OperationContext context,
                           org.jboss.dmr.ModelNode operation,
                           org.jboss.dmr.ModelNode model)
                    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 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.

Overrides:

performRuntime in class AbstractAddStepHandler

Parameters:

context - the operation context

operation - the operation being executed

model - persistent configuration model from the resource that corresponds to the address of operation

Throws:

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

installServices

protected abstract List<org.jboss.msc.service.ServiceName> installServices(OperationContext context,
                                                                           HttpInterfaceCommonPolicy commonPolicy,
                                                                           org.jboss.dmr.ModelNode model)
                                                                    throws OperationFailedException

Throws:

OperationFailedException