Package org.jboss.as.controller.transform.description

Interface RejectAttributeChecker

All Known Implementing Classes:

DefaultCheckersAndConverter, RejectAttributeChecker.DefaultRejectAttributeChecker, RejectAttributeChecker.ListRejectAttributeChecker, RejectAttributeChecker.ObjectFieldsRejectAttributeChecker, RejectAttributeChecker.SimpleAcceptAttributeChecker, RejectAttributeChecker.SimpleRejectAttributeChecker

public interface RejectAttributeChecker

Checks whether an attribute should be rejected or not

Author:

Kabir Khan

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RejectAttributeChecker.DefaultRejectAttributeChecker	A standard implementation of RejectAttributeChecker.
static class	RejectAttributeChecker.ListRejectAttributeChecker	A RejectAttributeChecker for ModelType.LIST attribute values
static class	RejectAttributeChecker.ObjectFieldsRejectAttributeChecker	A RejectAttributeChecker for ModelType.OBJECT attribute values
static class	RejectAttributeChecker.SimpleAcceptAttributeChecker	Rejects an attribute if the value is anything other than the specified value..
static class	RejectAttributeChecker.SimpleRejectAttributeChecker	Rejects the attribute if the value is equal to the specified value.

Field Summary

Fields

Modifier and Type	Field	Description
static RejectAttributeChecker	ALL
static RejectAttributeChecker	DEFINED
static RejectAttributeChecker	SIMPLE_EXPRESSIONS	Checks a simple attribute for expressions
static RejectAttributeChecker	UNDEFINED

Method Summary

Modifier and Type	Method	Description
String	getRejectionLogMessage(Map<String,org.jboss.dmr.ModelNode> attributes)	Gets the log message if the attribute failed rejection
String	getRejectionLogMessageId()	Returns the log message id used by this checker.
boolean	rejectOperationParameter(PathAddress address, String attributeName, org.jboss.dmr.ModelNode attributeValue, org.jboss.dmr.ModelNode operation, TransformationContext context)	Determines whether the given operation parameter value is not understandable by the target process and needs to be rejected.
boolean	rejectResourceAttribute(PathAddress address, String attributeName, org.jboss.dmr.ModelNode attributeValue, TransformationContext context)	Gets whether the given resource attribute value is not understandable by the target process and needs to be rejected.

Field Detail

SIMPLE_EXPRESSIONS

static final RejectAttributeChecker SIMPLE_EXPRESSIONS

Checks a simple attribute for expressions

DEFINED

static final RejectAttributeChecker DEFINED

UNDEFINED

static final RejectAttributeChecker UNDEFINED

ALL

static final RejectAttributeChecker ALL

Method Detail

rejectOperationParameter

boolean rejectOperationParameter(PathAddress address,
                                 String attributeName,
                                 org.jboss.dmr.ModelNode attributeValue,
                                 org.jboss.dmr.ModelNode operation,
                                 TransformationContext context)

Determines whether the given operation parameter value is not understandable by the target process and needs to be rejected.

Parameters:

address - the address of the operation

attributeName - the name of the attribute

attributeValue - the value of the attribute

operation - the operation executed. This is unmodifiable.

context - the context of the transformation

Returns:

true if the parameter value is not understandable by the target process and so needs to be rejected, false otherwise.

rejectResourceAttribute

boolean rejectResourceAttribute(PathAddress address,
                                String attributeName,
                                org.jboss.dmr.ModelNode attributeValue,
                                TransformationContext context)

Gets whether the given resource attribute value is not understandable by the target process and needs to be rejected.

Parameters:

address - the address of the resource

attributeName - the name of the attribute

attributeValue - the value of the attribute

context - the context of the transformation

Returns:

true if the attribute value is not understandable by the target process and so needs to be rejected, false otherwise.

getRejectionLogMessageId

String getRejectionLogMessageId()

Returns the log message id used by this checker. This is used to group it so that all attributes failing a type of rejction end up in the same error message

Returns:

the log message id

getRejectionLogMessage

String getRejectionLogMessage(Map<String,org.jboss.dmr.ModelNode> attributes)

Gets the log message if the attribute failed rejection

Parameters:

attributes - a map of all attributes failed in this checker and their values

Returns:

the formatted log message