org.apache.camel.component.extension.verifier

Class DefaultResultVerificationError

java.lang.Object

org.apache.camel.component.extension.verifier.DefaultResultVerificationError

All Implemented Interfaces:

Serializable, ComponentVerifierExtension.VerificationError

public class DefaultResultVerificationError
extends Object
implements ComponentVerifierExtension.VerificationError

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.camel.component.extension.ComponentVerifierExtension.VerificationError

ComponentVerifierExtension.VerificationError.Attribute, ComponentVerifierExtension.VerificationError.Code, ComponentVerifierExtension.VerificationError.ExceptionAttribute, ComponentVerifierExtension.VerificationError.GroupAttribute, ComponentVerifierExtension.VerificationError.HttpAttribute, ComponentVerifierExtension.VerificationError.StandardCode

Constructor Summary

Constructors

Constructor and Description
DefaultResultVerificationError(ComponentVerifierExtension.VerificationError.Code code, String description, Set<String> parameterKeys, Map<ComponentVerifierExtension.VerificationError.Attribute,Object> details)

Method Summary

Modifier and Type	Method and Description
ComponentVerifierExtension.VerificationError.Code	getCode() The overall error code, which can be either a ComponentVerifierExtension.VerificationError.StandardCode or a custom code.
String	getDescription() A human readable description of the error in plain english
Map<ComponentVerifierExtension.VerificationError.Attribute,Object>	getDetails() Details about the failed verification.
Set<String>	getParameterKeys() A set of input parameter names which fails the verification.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.component.extension.ComponentVerifierExtension.VerificationError

asAttribute, asCode, getDetail, getDetail

Constructor Detail

DefaultResultVerificationError

public DefaultResultVerificationError(ComponentVerifierExtension.VerificationError.Code code,
                                      String description,
                                      Set<String> parameterKeys,
                                      Map<ComponentVerifierExtension.VerificationError.Attribute,Object> details)

Method Detail

getCode

public ComponentVerifierExtension.VerificationError.Code getCode()

Description copied from interface: ComponentVerifierExtension.VerificationError

The overall error code, which can be either a ComponentVerifierExtension.VerificationError.StandardCode or a custom code. It is recommended to stick to the predefined standard codes

Specified by:

getCode in interface ComponentVerifierExtension.VerificationError

Returns:

the general error code.

getDescription

public String getDescription()

Description copied from interface: ComponentVerifierExtension.VerificationError

A human readable description of the error in plain english

Specified by:

getDescription in interface ComponentVerifierExtension.VerificationError

Returns:

the error description (if available)

getParameterKeys

public Set<String> getParameterKeys()

Description copied from interface: ComponentVerifierExtension.VerificationError

A set of input parameter names which fails the verification. These are keys to the parameter provided to ComponentVerifierExtension.verify(ComponentVerifierExtension.Scope, Map).

Specified by:

getParameterKeys in interface ComponentVerifierExtension.VerificationError

Returns:

the parameter names which are malformed and caused the failure of the validation

getDetails

public Map<ComponentVerifierExtension.VerificationError.Attribute,Object> getDetails()

Description copied from interface: ComponentVerifierExtension.VerificationError

Details about the failed verification. The keys can be either predefined values (ComponentVerifierExtension.VerificationError.ExceptionAttribute, ComponentVerifierExtension.VerificationError.HttpAttribute, ComponentVerifierExtension.VerificationError.GroupAttribute) or it can be free-form custom keys specific to a component. The standard attributes are defined as enums in all uppercase (with underscore as separator), custom attributes are supposed to be in all lower case (also with underscores as separators)

Specified by:

getDetails in interface ComponentVerifierExtension.VerificationError

Returns:

a number of key/value pair with additional information related to the verification.

toString

public String toString()

Overrides:

toString in class Object