org.jboss.as.clustering.infinispan.subsystem

Class InfinispanResourceDescriptionResolver

java.lang.Object

org.jboss.as.controller.descriptions.StandardResourceDescriptionResolver

org.jboss.as.clustering.infinispan.subsystem.InfinispanResourceDescriptionResolver

All Implemented Interfaces:

ResourceDescriptionResolver

public class InfinispanResourceDescriptionResolver
extends StandardResourceDescriptionResolver

Custom resource description resolver to handle resources structured in a class hierarchy which need to share resource name definitions.

Author:

Richard Achmatowicz (c) 2011 Red Hat Inc.

Field Summary

Fields inherited from class org.jboss.as.controller.descriptions.StandardResourceDescriptionResolver

REPLY

Constructor Summary

Constructors

Constructor and Description
InfinispanResourceDescriptionResolver(String keyPrefix, String bundleBaseName, ClassLoader bundleLoader)

Method Summary

Modifier and Type	Method and Description
String	getChildTypeDescription(String childType, Locale locale, ResourceBundle bundle) Gets the description of one of the resource's child types.
String	getOperationParameterDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle) Gets the description of one of the resource's operation's parameters.
String	getOperationParameterValueTypeDescription(String operationName, String paramName, Locale locale, ResourceBundle bundle, String... suffixes) Gets the description of a portion of a complex value type of one of the resource's operation's parameters.
String	getResourceAttributeDescription(String attributeName, Locale locale, ResourceBundle bundle) Gets the description of one of the resource's attributes.
String	getResourceAttributeValueTypeDescription(String attributeName, Locale locale, ResourceBundle bundle, String... suffixes) Gets the description of a portion of a complex value type of one of the resource's attributes.

Methods inherited from class org.jboss.as.controller.descriptions.StandardResourceDescriptionResolver

getChildResolver, getKeyPrefix, getOperationDeprecatedDescription, getOperationDescription, getOperationParameterDeprecatedDescription, getOperationReplyDescription, getOperationReplyValueTypeDescription, getResourceAttributeDeprecatedDescription, getResourceBundle, getResourceDeprecatedDescription, getResourceDescription, isReuseAttributesForAdd, isUseUnprefixedChildTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

InfinispanResourceDescriptionResolver

public InfinispanResourceDescriptionResolver(String keyPrefix,
                                             String bundleBaseName,
                                             ClassLoader bundleLoader)

Method Detail

getResourceAttributeDescription

public String getResourceAttributeDescription(String attributeName,
                                              Locale locale,
                                              ResourceBundle bundle)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of one of the resource's attributes.

Specified by:

getResourceAttributeDescription in interface ResourceDescriptionResolver

Overrides:

getResourceAttributeDescription in class StandardResourceDescriptionResolver

Parameters:

attributeName - the name of the attribute

locale - the locale

bundle - a resource bundle previously obtained from a call to ResourceDescriptionResolver.getResourceBundle(java.util.Locale), or null if that call returned null

Returns:

the localized description

getResourceAttributeValueTypeDescription

public String getResourceAttributeValueTypeDescription(String attributeName,
                                                       Locale locale,
                                                       ResourceBundle bundle,
                                                       String... suffixes)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of a portion of a complex value type of one of the resource's attributes.

Specified by:

getResourceAttributeValueTypeDescription in interface ResourceDescriptionResolver

Overrides:

getResourceAttributeValueTypeDescription in class StandardResourceDescriptionResolver

Parameters:

attributeName - the name of the attribute

locale - the locale

bundle - a resource bundle previously obtained from a call to ResourceDescriptionResolver.getResourceBundle(java.util.Locale), or null if that call returned null

suffixes - suffixes to dot-append to the base attribute key to generate a key

Returns:

the localized description

getOperationParameterDescription

public String getOperationParameterDescription(String operationName,
                                               String paramName,
                                               Locale locale,
                                               ResourceBundle bundle)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of one of the resource's operation's parameters.

Specified by:

getOperationParameterDescription in interface ResourceDescriptionResolver

Overrides:

getOperationParameterDescription in class StandardResourceDescriptionResolver

Parameters:

operationName - the name of the operation

paramName - the name of the operation's parameter

locale - the locale

bundle - a resource bundle previously obtained from a call to ResourceDescriptionResolver.getResourceBundle(java.util.Locale), or null if that call returned null

Returns:

the localized description

getOperationParameterValueTypeDescription

public String getOperationParameterValueTypeDescription(String operationName,
                                                        String paramName,
                                                        Locale locale,
                                                        ResourceBundle bundle,
                                                        String... suffixes)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of a portion of a complex value type of one of the resource's operation's parameters.

Specified by:

getOperationParameterValueTypeDescription in interface ResourceDescriptionResolver

Overrides:

getOperationParameterValueTypeDescription in class StandardResourceDescriptionResolver

Parameters:

operationName - the name of the operation

paramName - the name of the operation's parameter

locale - the locale

bundle - a resource bundle previously obtained from a call to ResourceDescriptionResolver.getResourceBundle(java.util.Locale), or null if that call returned null

suffixes - suffixes to dot-append to the base attribute key to generate a key

Returns:

the localized description

getChildTypeDescription

public String getChildTypeDescription(String childType,
                                      Locale locale,
                                      ResourceBundle bundle)

Description copied from class: StandardResourceDescriptionResolver

Gets the description of one of the resource's child types.

Specified by:

getChildTypeDescription in interface ResourceDescriptionResolver

Overrides:

getChildTypeDescription in class StandardResourceDescriptionResolver

Parameters:

childType - the name of the child type

locale - the locale

bundle - a resource bundle previously obtained from a call to ResourceDescriptionResolver.getResourceBundle(java.util.Locale), or null if that call returned null

Returns:

the localized description