org.jboss.as.controller.operations.common

Class PathAddHandler

java.lang.Object

org.jboss.as.controller.AbstractAddStepHandler

org.jboss.as.controller.operations.common.PathAddHandler

All Implemented Interfaces:

DescriptionProvider, OperationStepHandler

Direct Known Subclasses:

SpecifiedPathAddHandler

public class PathAddHandler
extends AbstractAddStepHandler
implements DescriptionProvider

Handler for the path resource add operation.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static PathAddHandler	NAMED_INSTANCE
static String	OPERATION_NAME
static PathAddHandler	SPECIFIED_INSTANCE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PathAddHandler(boolean specified) Create the PathAddHandler

Method Summary

Methods

Modifier and Type	Method and Description
static org.jboss.dmr.ModelNode	getAddPathOperation(org.jboss.dmr.ModelNode address, org.jboss.dmr.ModelNode path, org.jboss.dmr.ModelNode relativeTo)
org.jboss.dmr.ModelNode	getModelDescription(Locale locale) Gets the descriptive information (human-friendly description, list of attributes, list of children) describing a single model node or 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.AbstractAddStepHandler

execute, performRuntime, populateModel, populateModel, requiresRuntime, requiresRuntimeVerification, rollbackRuntime

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

NAMED_INSTANCE

public static final PathAddHandler NAMED_INSTANCE

SPECIFIED_INSTANCE

public static final PathAddHandler SPECIFIED_INSTANCE

Constructor Detail

PathAddHandler

protected PathAddHandler(boolean specified)

Create the PathAddHandler

Method Detail

getAddPathOperation

public static org.jboss.dmr.ModelNode getAddPathOperation(org.jboss.dmr.ModelNode address,
                                          org.jboss.dmr.ModelNode path,
                                          org.jboss.dmr.ModelNode relativeTo)

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.

Specified by:

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

getModelDescription

public org.jboss.dmr.ModelNode getModelDescription(Locale locale)

Description copied from interface: DescriptionProvider

Gets the descriptive information (human-friendly description, list of attributes, list of children) describing a single model node or operation.

The implementation must assume that the caller intends to modify the returned ModelNode so it should not hand out a reference to any internal data structures.

Specified by:

getModelDescription in interface DescriptionProvider

Parameters:

locale - the locale to use to generate any localized text used in the description. May be null, in which case Locale.getDefault() should be used

Returns:

ModelNode describing the model node's structure