org.apache.camel.component.validator

Class ValidatorEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.component.validator.ValidatorEndpoint

All Implemented Interfaces:

CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, HasId, StatefulService, SuspendableService

@ManagedResource(description="Managed ValidatorEndpoint")
 @UriEndpoint(firstVersion="1.1.0",
             scheme="validator",
             title="Validator",
             syntax="validator:resourceUri",
             producerOnly=true,
             label="core,validation")
public class ValidatorEndpoint
extends DefaultEndpoint

Validates the payload of a message using XML Schema and JAXP Validation.

Field Summary

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
ValidatorEndpoint()
ValidatorEndpoint(String endpointUri, Component component, String resourceUri)

Method Summary

Modifier and Type	Method and Description
void	clearCachedSchema()
protected void	configureValidator(ValidatingProcessor validator)
Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
ValidatorErrorHandler	getErrorHandler()
String	getHeaderName()
LSResourceResolver	getResourceResolver()
ValidatorResourceResolverFactory	getResourceResolverFactory()
String	getResourceUri()
SchemaFactory	getSchemaFactory()
String	getSchemaLanguage()
boolean	isFailOnNullBody()
boolean	isFailOnNullHeader()
boolean	isSingleton() Whether this class supports being singleton or not.
boolean	isUseDom()
boolean	isUseSharedSchema()
void	setErrorHandler(ValidatorErrorHandler errorHandler) To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler.
void	setFailOnNullBody(boolean failOnNullBody) Whether to fail if no body exists.
void	setFailOnNullHeader(boolean failOnNullHeader) Whether to fail if no header exists when validating against a header.
void	setHeaderName(String headerName) To validate against a header instead of the message body.
void	setResourceResolver(LSResourceResolver resourceResolver) To use a custom LSResourceResolver.
void	setResourceResolverFactory(ValidatorResourceResolverFactory resourceResolverFactory) For creating a resource resolver which depends on the endpoint resource URI.
void	setResourceUri(String resourceUri) URL to a local resource on the classpath,or a reference to lookup a bean in the Registry, or a full URL to a remote resource or resource on the file system which contains the XSD to validate against.
void	setSchemaFactory(SchemaFactory schemaFactory) To use a custom javax.xml.validation.SchemaFactory
void	setSchemaLanguage(String schemaLanguage) Configures the W3C XML Schema Namespace URI.
void	setUseDom(boolean useDom) Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator.
void	setUseSharedSchema(boolean useSharedSchema) Whether the Schema instance should be shared or not.

Methods inherited from class org.apache.camel.impl.DefaultEndpoint

configureConsumer, configurePollingConsumer, configureProperties, createEndpointConfiguration, createEndpointUri, createExchange, createExchange, createExchange, createPollingConsumer, doStart, doStop, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

Methods inherited from class org.apache.camel.support.ServiceSupport

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isStoppingOrStopped, isSuspended, isSuspending, isSuspendingOrSuspended, resume, shutdown, start, stop, suspend

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.camel.Service

start, stop

Constructor Detail

ValidatorEndpoint

public ValidatorEndpoint()

ValidatorEndpoint

public ValidatorEndpoint(String endpointUri,
                         Component component,
                         String resourceUri)

Method Detail

clearCachedSchema

@ManagedOperation(description="Clears the cached schema, forcing to re-load the schema on next request")
public void clearCachedSchema()

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Returns:

true to be a single shared instance, false to create new instances.

configureValidator

protected void configureValidator(ValidatingProcessor validator)
                           throws Exception

Throws:

Exception

getResourceUri

public String getResourceUri()

setResourceUri

public void setResourceUri(String resourceUri)

URL to a local resource on the classpath,or a reference to lookup a bean in the Registry, or a full URL to a remote resource or resource on the file system which contains the XSD to validate against.

getSchemaLanguage

public String getSchemaLanguage()

setSchemaLanguage

public void setSchemaLanguage(String schemaLanguage)

Configures the W3C XML Schema Namespace URI.

getSchemaFactory

public SchemaFactory getSchemaFactory()

setSchemaFactory

public void setSchemaFactory(SchemaFactory schemaFactory)

To use a custom javax.xml.validation.SchemaFactory

getErrorHandler

public ValidatorErrorHandler getErrorHandler()

setErrorHandler

public void setErrorHandler(ValidatorErrorHandler errorHandler)

To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler.

The default error handler captures the errors and throws an exception.

isUseDom

public boolean isUseDom()

setUseDom

public void setUseDom(boolean useDom)

Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator.

isUseSharedSchema

public boolean isUseSharedSchema()

setUseSharedSchema

public void setUseSharedSchema(boolean useSharedSchema)

Whether the Schema instance should be shared or not. This option is introduced to work around a JDK 1.6.x bug. Xerces should not have this issue.

getResourceResolver

public LSResourceResolver getResourceResolver()

setResourceResolver

public void setResourceResolver(LSResourceResolver resourceResolver)

To use a custom LSResourceResolver. See also setResourceResolverFactory(ValidatorResourceResolverFactory)

getResourceResolverFactory

public ValidatorResourceResolverFactory getResourceResolverFactory()

setResourceResolverFactory

public void setResourceResolverFactory(ValidatorResourceResolverFactory resourceResolverFactory)

For creating a resource resolver which depends on the endpoint resource URI. Must not be used in combination with method setResourceResolver(LSResourceResolver). If not set then DefaultValidatorResourceResolverFactory is used

isFailOnNullBody

public boolean isFailOnNullBody()

setFailOnNullBody

public void setFailOnNullBody(boolean failOnNullBody)

Whether to fail if no body exists.

isFailOnNullHeader

public boolean isFailOnNullHeader()

setFailOnNullHeader

public void setFailOnNullHeader(boolean failOnNullHeader)

Whether to fail if no header exists when validating against a header.

getHeaderName

public String getHeaderName()

setHeaderName

public void setHeaderName(String headerName)

To validate against a header instead of the message body.