org.jboss.as.controller.descriptions

Interface OverrideDescriptionProvider

public interface OverrideDescriptionProvider

Provides description elements to override the description of a resource produced by a DescriptionProvider. For use with specifically named resources (i.e. those whose ManagementResourceRegistration path is identified with a two-argument PathElement) that expose additional attributes or operations not provided by the generic resource description (i.e. the ManagementResourceRegistration whose path is identified with a one-argument PathElement.)

Author:

Brian Stansberry (c) 2011 Red Hat Inc.

See Also:

ManagementResourceRegistration.registerOverrideModel(String, OverrideDescriptionProvider)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,org.jboss.dmr.ModelNode>	getAttributeOverrideDescriptions(Locale locale) Provides descriptions for attributes that are in addition to those provided by the generic resource.
Map<String,org.jboss.dmr.ModelNode>	getChildTypeOverrideDescriptions(Locale locale) Provides descriptions for child types that are in addition to those provided by the generic resource.

Method Detail

getAttributeOverrideDescriptions

Map<String,org.jboss.dmr.ModelNode> getAttributeOverrideDescriptions(Locale locale)

Provides descriptions for attributes that are in addition to those provided by the generic resource.

Parameters:

locale - locale to use for generating internationalized descriptions

Returns:

map whose keys are attribute names and whose values are the descriptions of the attribute to incorporate into the overall resource description.

getChildTypeOverrideDescriptions

Map<String,org.jboss.dmr.ModelNode> getChildTypeOverrideDescriptions(Locale locale)

Provides descriptions for child types that are in addition to those provided by the generic resource.

Parameters:

locale - locale to use for generating internationalized descriptions

Returns:

map whose keys are child type names and whose values are the descriptions of the child type to incorporate into the overall resource description.