Package org.jboss.as.controller.management

Class ManagementInterfaceAddStepHandler

java.lang.Object

org.jboss.as.controller.AbstractAddStepHandler

org.jboss.as.controller.management.ManagementInterfaceAddStepHandler

All Implemented Interfaces:

OperationDescriptor, OperationStepHandler

Direct Known Subclasses:

BaseHttpInterfaceAddStepHandler, BaseNativeInterfaceAddStepHandler

public abstract class ManagementInterfaceAddStepHandler
extends AbstractAddStepHandler

The base add handler for management interfaces.

Author:

Emmanuel Hugonnet (c) 2016 Red Hat, inc.

Nested Class Summary

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

AbstractAddStepHandler.Parameters

Field Summary

Fields

Modifier and Type	Field	Description
static OperationContext.AttachmentKey<Boolean>	MANAGEMENT_INTERFACE_KEY

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

attributes

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ManagementInterfaceAddStepHandler()
protected	ManagementInterfaceAddStepHandler(AttributeDefinition[] attributeDefinitions)

Method Summary

Modifier and Type	Method	Description
protected void	addVerifyInstallationStep(OperationContext context, List<org.jboss.msc.service.ServiceName> requiredServices)
protected String	asStringIfDefined(OperationContext context, AttributeDefinition attribute, org.jboss.dmr.ModelNode model)
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)}.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

MANAGEMENT_INTERFACE_KEY

public static final OperationContext.AttachmentKey<Boolean> MANAGEMENT_INTERFACE_KEY

Constructor Detail

ManagementInterfaceAddStepHandler

protected ManagementInterfaceAddStepHandler(AttributeDefinition[] attributeDefinitions)

ManagementInterfaceAddStepHandler

protected ManagementInterfaceAddStepHandler()

Method Detail

requiresRuntime

protected boolean requiresRuntime(OperationContext context)

Description copied from class: AbstractAddStepHandler

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)}. 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.

Overrides:

requiresRuntime in class AbstractAddStepHandler

Parameters:

context - operation context

Returns:

true if performRuntime should be invoked; false otherwise.

addVerifyInstallationStep

protected void addVerifyInstallationStep(OperationContext context,
                                         List<org.jboss.msc.service.ServiceName> requiredServices)

asStringIfDefined

protected String asStringIfDefined(OperationContext context,
                                   AttributeDefinition attribute,
                                   org.jboss.dmr.ModelNode model)
                            throws OperationFailedException

Throws:

OperationFailedException