org.jboss.as.controller.transform.description

Class RejectAttributeChecker.DefaultRejectAttributeChecker

java.lang.Object

org.jboss.as.controller.transform.description.RejectAttributeChecker.DefaultRejectAttributeChecker

All Implemented Interfaces:

RejectAttributeChecker

Direct Known Subclasses:

RejectAttributeChecker.SimpleAcceptAttributeChecker, RejectAttributeChecker.SimpleRejectAttributeChecker

Enclosing interface:

RejectAttributeChecker

public abstract static class RejectAttributeChecker.DefaultRejectAttributeChecker
extends Object
implements RejectAttributeChecker

A standard implementation of RejectAttributeChecker.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.as.controller.transform.description.RejectAttributeChecker

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

Field Summary

Fields inherited from interface org.jboss.as.controller.transform.description.RejectAttributeChecker

ALL, DEFINED, SIMPLE_EXPRESSIONS, UNDEFINED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultRejectAttributeChecker() Constructor

Method Summary

Modifier and Type	Method and Description
String	getRejectionLogMessageId() Returns the log message id used by this checker.
protected abstract boolean	rejectAttribute(PathAddress address, String attributeName, org.jboss.dmr.ModelNode attributeValue, TransformationContext context) Gets called by the default implementations of rejectOperationParameter(PathAddress, String, ModelNode, ModelNode, TransformationContext) and rejectResourceAttribute(PathAddress, String, ModelNode, TransformationContext).
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.as.controller.transform.description.RejectAttributeChecker

getRejectionLogMessage

Constructor Detail

DefaultRejectAttributeChecker

protected DefaultRejectAttributeChecker()

Constructor

Method Detail

rejectOperationParameter

public 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.

Specified by:

rejectOperationParameter in interface RejectAttributeChecker

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

public 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.

Specified by:

rejectResourceAttribute in interface RejectAttributeChecker

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.

rejectAttribute

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

Gets called by the default implementations of rejectOperationParameter(PathAddress, String, ModelNode, ModelNode, TransformationContext) and rejectResourceAttribute(PathAddress, String, ModelNode, TransformationContext).

Parameters:

address - the address of the operation

attributeName - the name of the attribute

attributeValue - the value of the attribute

context - the context of the transformation

Returns:

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

getRejectionLogMessageId

public 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. This default implementation uses the formatted log message with an empty attribute map as the id.

Specified by:

getRejectionLogMessageId in interface RejectAttributeChecker

Returns:

the log message id