org.jboss.as.controller.descriptions

Class DefaultOperationDescriptionProvider

java.lang.Object

org.jboss.as.controller.descriptions.DefaultOperationDescriptionProvider

All Implemented Interfaces:

DescriptionProvider

Direct Known Subclasses:

DefaultResourceRemoveDescriptionProvider

public class DefaultOperationDescriptionProvider
extends Object
implements DescriptionProvider

Provides a default description of an operation.

Author:

Brian Stansberry (c) 2011 Red Hat Inc., Tomaz Cerar (c) 2012 Red Hat Inc.

Constructor Summary

Constructors

Constructor and Description
DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, AttributeDefinition... parameters)
DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, DeprecationData deprecationData, AttributeDefinition... parameters)
DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, org.jboss.dmr.ModelType replyType, AttributeDefinition... parameters)
DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, org.jboss.dmr.ModelType replyType, org.jboss.dmr.ModelType replyValueType, AttributeDefinition... parameters)
DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, org.jboss.dmr.ModelType replyType, org.jboss.dmr.ModelType replyValueType, DeprecationData deprecationData, AttributeDefinition... parameters)
DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, ResourceDescriptionResolver attributeDescriptionResolver, org.jboss.dmr.ModelType replyType, org.jboss.dmr.ModelType replyValueType, boolean replyAllowNull, DeprecationData deprecationData, AttributeDefinition[] replyParameters, AttributeDefinition... parameters)
DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, ResourceDescriptionResolver attributeDescriptionResolver, org.jboss.dmr.ModelType replyType, org.jboss.dmr.ModelType replyValueType, boolean replyAllowNull, DeprecationData deprecationData, AttributeDefinition[] replyParameters, AttributeDefinition[] parameters, List<AccessConstraintDefinition> accessConstraints)
DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, ResourceDescriptionResolver attributeDescriptionResolver, org.jboss.dmr.ModelType replyType, org.jboss.dmr.ModelType replyValueType, DeprecationData deprecationData, AttributeDefinition[] replyParameters, AttributeDefinition... parameters)

Method Summary

Modifier and Type	Method and Description
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 org.jboss.dmr.ModelNode	getReplyValueTypeDescription(ResourceDescriptionResolver descriptionResolver, Locale locale, ResourceBundle bundle) Hook for subclasses to provide a description object for any complex "value-type" description of the operation reply.
protected boolean	isAddAccessConstraints() Hook for subclasses like DefaultResourceRemoveDescriptionProvider to not add the access constraints

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOperationDescriptionProvider

public DefaultOperationDescriptionProvider(String operationName,
                                           ResourceDescriptionResolver descriptionResolver,
                                           AttributeDefinition... parameters)

DefaultOperationDescriptionProvider

public DefaultOperationDescriptionProvider(String operationName,
                                           ResourceDescriptionResolver descriptionResolver,
                                           DeprecationData deprecationData,
                                           AttributeDefinition... parameters)

DefaultOperationDescriptionProvider

public DefaultOperationDescriptionProvider(String operationName,
                                           ResourceDescriptionResolver descriptionResolver,
                                           org.jboss.dmr.ModelType replyType,
                                           AttributeDefinition... parameters)

DefaultOperationDescriptionProvider

public DefaultOperationDescriptionProvider(String operationName,
                                           ResourceDescriptionResolver descriptionResolver,
                                           org.jboss.dmr.ModelType replyType,
                                           org.jboss.dmr.ModelType replyValueType,
                                           AttributeDefinition... parameters)

DefaultOperationDescriptionProvider

public DefaultOperationDescriptionProvider(String operationName,
                                           ResourceDescriptionResolver descriptionResolver,
                                           org.jboss.dmr.ModelType replyType,
                                           org.jboss.dmr.ModelType replyValueType,
                                           DeprecationData deprecationData,
                                           AttributeDefinition... parameters)

DefaultOperationDescriptionProvider

public DefaultOperationDescriptionProvider(String operationName,
                                           ResourceDescriptionResolver descriptionResolver,
                                           ResourceDescriptionResolver attributeDescriptionResolver,
                                           org.jboss.dmr.ModelType replyType,
                                           org.jboss.dmr.ModelType replyValueType,
                                           DeprecationData deprecationData,
                                           AttributeDefinition[] replyParameters,
                                           AttributeDefinition... parameters)

DefaultOperationDescriptionProvider

public DefaultOperationDescriptionProvider(String operationName,
                                           ResourceDescriptionResolver descriptionResolver,
                                           ResourceDescriptionResolver attributeDescriptionResolver,
                                           org.jboss.dmr.ModelType replyType,
                                           org.jboss.dmr.ModelType replyValueType,
                                           boolean replyAllowNull,
                                           DeprecationData deprecationData,
                                           AttributeDefinition[] replyParameters,
                                           AttributeDefinition... parameters)

DefaultOperationDescriptionProvider

public DefaultOperationDescriptionProvider(String operationName,
                                           ResourceDescriptionResolver descriptionResolver,
                                           ResourceDescriptionResolver attributeDescriptionResolver,
                                           org.jboss.dmr.ModelType replyType,
                                           org.jboss.dmr.ModelType replyValueType,
                                           boolean replyAllowNull,
                                           DeprecationData deprecationData,
                                           AttributeDefinition[] replyParameters,
                                           AttributeDefinition[] parameters,
                                           List<AccessConstraintDefinition> accessConstraints)

Method Detail

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

isAddAccessConstraints

protected boolean isAddAccessConstraints()

Hook for subclasses like DefaultResourceRemoveDescriptionProvider to not add the access constraints

Returns:

whether to add the access constraints

getReplyValueTypeDescription

protected org.jboss.dmr.ModelNode getReplyValueTypeDescription(ResourceDescriptionResolver descriptionResolver,
                                                               Locale locale,
                                                               ResourceBundle bundle)

Hook for subclasses to provide a description object for any complex "value-type" description of the operation reply.

This default implementation throws an IllegalStateException; it is the responsibility of subclasses to override this method if a complex "value-type" description is required.

Parameters:

descriptionResolver - resolver for localizing any text in the description

locale - locale for any text description

bundle - resource bundle previously obtained from the description resolver

Returns:

a node describing the reply's "value-type"

Throws:

IllegalStateException - if not overridden by an implementation that does not