org.jboss.as.controller.access.management

Interface AccessConstraintDefinition

All Known Implementing Classes:

ApplicationTypeAccessConstraintDefinition, SensitiveTargetAccessConstraintDefinition

public interface AccessConstraintDefinition

Definition of a constraint that can be associated with a ResourceDefinition, OperationDefinition or AttributeDefinition.

Implementations of this class must be usable as keys in a map; i.e. they should have proper implementations of #equals(Object) and #hashCode().

Author:

Brian Stansberry (c) 2013 Red Hat Inc.

Method Summary

Methods

Modifier and Type	Method and Description
ConstraintFactory	getConstraintFactory() Get the factory to use for creating a Constraint that implements
String	getDescription(Locale locale) Gets a text description if this attribute definition for inclusion in read-xxx-description metadata.
AccessConstraintKey	getKey() Gets a unique identifier for this AccessConstraintDefinition.
org.jboss.dmr.ModelNode	getModelDescriptionDetails(Locale locale) Get arbitrary descriptive information about the constraint for inclusion in the read-xxx-description metadata
String	getName() Get the name of the constraint
String	getSubsystemName() Gets the name of the subsystem that provides this definition, it is not core.
String	getType() Get the type of constraint
boolean	isCore() Gets whether the definition is provided by the core management system.

Method Detail

getName

String getName()

Get the name of the constraint

Returns:

the name

getType

String getType()

Get the type of constraint

Returns:

the type of constraint

isCore

boolean isCore()

Gets whether the definition is provided by the core management system.

Returns:

true if the definition is provided by the core; false if it is provided by a subsystem

getSubsystemName

String getSubsystemName()

Gets the name of the subsystem that provides this definition, it is not core.

Returns:

the subsystem name, or null if isCore()

getKey

AccessConstraintKey getKey()

Gets a unique identifier for this AccessConstraintDefinition.

Returns:

the key. Will not be null

getDescription

String getDescription(Locale locale)

Gets a text description if this attribute definition for inclusion in read-xxx-description metadata.

Parameters:

locale - locale to use to provide internationalized text

Returns:

the text description, or null if none is available

getModelDescriptionDetails

org.jboss.dmr.ModelNode getModelDescriptionDetails(Locale locale)

Get arbitrary descriptive information about the constraint for inclusion in the read-xxx-description metadata

Parameters:

locale - locale to use for any internationalized text

Returns:

an arbitrary description node; can be null or undefined

getConstraintFactory

ConstraintFactory getConstraintFactory()

Get the factory to use for creating a Constraint that implements

Returns:

the factory. Cannot return null