public class DefaultOperationDescriptionProvider extends Object implements DescriptionProvider
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) |
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
|
public DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, AttributeDefinition... parameters)
public DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, DeprecationData deprecationData, AttributeDefinition... parameters)
public DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, org.jboss.dmr.ModelType replyType, AttributeDefinition... parameters)
public DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, org.jboss.dmr.ModelType replyType, org.jboss.dmr.ModelType replyValueType, AttributeDefinition... parameters)
public DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, org.jboss.dmr.ModelType replyType, org.jboss.dmr.ModelType replyValueType, DeprecationData deprecationData, AttributeDefinition... parameters)
public DefaultOperationDescriptionProvider(String operationName, ResourceDescriptionResolver descriptionResolver, ResourceDescriptionResolver attributeDescriptionResolver, org.jboss.dmr.ModelType replyType, org.jboss.dmr.ModelType replyValueType, DeprecationData deprecationData, AttributeDefinition[] replyParameters, AttributeDefinition... parameters)
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)
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)
public org.jboss.dmr.ModelNode getModelDescription(Locale locale)
DescriptionProvider
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.
getModelDescription
in interface DescriptionProvider
locale
- the locale to use to generate any localized text used in the description.
May be null
, in which case Locale.getDefault()
should be usedModelNode
describing the model node's structureprotected boolean isAddAccessConstraints()
protected org.jboss.dmr.ModelNode getReplyValueTypeDescription(ResourceDescriptionResolver descriptionResolver, Locale locale, ResourceBundle bundle)
This default implementation throws an IllegalStateException
; it is the responsibility of
subclasses to override this method if a complex "value-type" description is required.
descriptionResolver
- resolver for localizing any text in the descriptionlocale
- locale for any text descriptionbundle
- resource bundle previously obtained from the description resolver
IllegalStateException
- if not overridden by an implementation that does notCopyright © 2023 JBoss by Red Hat. All rights reserved.