Package org.jboss.as.controller.descriptions

Class DefaultResourceAddDescriptionProvider

java.lang.Object

org.jboss.as.controller.descriptions.DefaultResourceAddDescriptionProvider

All Implemented Interfaces:

DescriptionProvider

public class DefaultResourceAddDescriptionProvider
extends Object
implements DescriptionProvider

Uses an analysis of registry metadata to provide a default description of an operation that adds a resource.

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final AttributeDefinition	INDEX

Constructor Summary

Constructors

Constructor	Description
DefaultResourceAddDescriptionProvider(ImmutableManagementResourceRegistration registration, ResourceDescriptionResolver descriptionResolver)
DefaultResourceAddDescriptionProvider(ImmutableManagementResourceRegistration registration, ResourceDescriptionResolver descriptionResolver, boolean orderedChildResource)

Method Summary

Modifier and Type	Method	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.

Methods inherited from class java.lang.Object

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

Field Details

INDEX

public static final AttributeDefinition INDEX

Constructor Details

DefaultResourceAddDescriptionProvider

public DefaultResourceAddDescriptionProvider(ImmutableManagementResourceRegistration registration,
 ResourceDescriptionResolver descriptionResolver)

DefaultResourceAddDescriptionProvider

public DefaultResourceAddDescriptionProvider(ImmutableManagementResourceRegistration registration,
 ResourceDescriptionResolver descriptionResolver,
 boolean orderedChildResource)

Method Details

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