Class Validator

java.lang.Object

org.apache.camel.support.service.BaseService

org.apache.camel.support.service.ServiceSupport

org.apache.camel.spi.Validator

All Implemented Interfaces:

AutoCloseable, CamelContextAware, Service, ShutdownableService, HasCamelContext, StatefulService, SuspendableService

public abstract class Validator
extends ServiceSupport
implements CamelContextAware

Validates message content against a declared DataType, as described in the Transformer and Validator documentation.

When a route declares an inputType or outputType with validate = true,

invalid reference

org.apache.camel.processor.ContractAdvice

invokes the registered Validator for that type before (or after) the route's main processing logic. If the message content does not satisfy the validator's rules, the validator should throw a ValidationException to signal the failure.

Validators are registered in the ValidatorRegistry keyed by their target DataType. Custom validators extend this abstract class and are registered via the DSL (e.g., inputType / outputType with validate = true), which wires them through

invalid reference

org.apache.camel.model.ValidatorDefinition

during route startup.

See Also:

• ValidatorRegistry
• DataType
• invalid reference

  org.apache.camel.model.ValidatorDefinition

Field Summary

Fields inherited from class BaseService

BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

Constructor Summary

Constructors

Constructor	Description
Validator()

Method Summary

Modifier and Type	Method	Description
@Nullable CamelContext	getCamelContext()	Returns the camel context.
@Nullable DataType	getType()	Get 'from' data type.
void	setCamelContext(CamelContext context)	Injects the CamelContext
Validator	setType(String type)	Set data type.
String	toString()
abstract void	validate(Message message, DataType type)	Perform data validation with specified type.

Methods inherited from class BaseService

build, doBuild, doFail, doInit, doLifecycleChange, doResume, doShutdown, doStart, doStop, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class Object

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

Methods inherited from interface Service

build, close, init, start, stop

Methods inherited from interface ShutdownableService

shutdown

Methods inherited from interface StatefulService

getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

Methods inherited from interface SuspendableService

isSuspended, resume, suspend

Constructor Details

Validator

public Validator()

Method Details

validate

public abstract void validate(Message message,
 DataType type)
                       throws ValidationException

Perform data validation with specified type.

Parameters:

message - message to apply validation

type - the data type

Throws:

ValidationException - thrown if any validation error is detected

getType

public @Nullable DataType getType()

Get 'from' data type.

setType

public Validator setType(String type)

Set data type.

Parameters:

type - data type

getCamelContext

public @Nullable CamelContext getCamelContext()

Description copied from interface: HasCamelContext

Returns the camel context.

Specified by:

getCamelContext in interface HasCamelContext

Returns:

the camel context.

setCamelContext

public void setCamelContext(CamelContext context)

Description copied from interface: CamelContextAware

Injects the CamelContext

Specified by:

setCamelContext in interface CamelContextAware

Parameters:

context - the Camel context

toString

public String toString()

Overrides:

toString in class Object