org.apache.camel.component.validator.ValidatorEndpoint Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation
Show all versions of camel-core Show documentation
The Core Camel Java DSL based router
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.component.validator;
import java.io.InputStream;
import javax.xml.XMLConstants;
import javax.xml.validation.SchemaFactory;
import org.w3c.dom.ls.LSResourceResolver;
import org.apache.camel.Component;
import org.apache.camel.Consumer;
import org.apache.camel.Processor;
import org.apache.camel.Producer;
import org.apache.camel.converter.IOConverter;
import org.apache.camel.impl.DefaultEndpoint;
import org.apache.camel.processor.validation.DefaultValidationErrorHandler;
import org.apache.camel.processor.validation.ValidatingProcessor;
import org.apache.camel.processor.validation.ValidatorErrorHandler;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.UriEndpoint;
import org.apache.camel.spi.UriParam;
import org.apache.camel.spi.UriPath;
import org.apache.camel.util.IOHelper;
import org.apache.camel.util.ResourceHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@UriEndpoint(scheme = "validator", title = "Validator", syntax = "validator:resourceUri", producerOnly = true, label = "core,validation")
public class ValidatorEndpoint extends DefaultEndpoint {
private static final Logger LOG = LoggerFactory.getLogger(ValidatorEndpoint.class);
@UriPath(description = "URL to a local resource on the classpath or a full URL to a remote resource or resource on the file system which contains the XSD to validate against.")
@Metadata(required = "true")
private String resourceUri;
@UriParam(defaultValue = XMLConstants.W3C_XML_SCHEMA_NS_URI, label = "advanced",
description = "Configures the W3C XML Schema Namespace URI.")
private String schemaLanguage = XMLConstants.W3C_XML_SCHEMA_NS_URI;
@UriParam(label = "advanced", description = "To use a custom javax.xml.validation.SchemaFactory")
private SchemaFactory schemaFactory;
@UriParam(label = "advanced", description = "To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler. The default error handler captures the errors and throws an exception.")
private ValidatorErrorHandler errorHandler = new DefaultValidationErrorHandler();
@UriParam(label = "advanced", description = "Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator.")
private boolean useDom;
@UriParam(defaultValue = "true", label = "advanced",
description = "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.")
private boolean useSharedSchema = true;
@UriParam(label = "advanced", description = "To use a custom LSResourceResolver")
private LSResourceResolver resourceResolver;
@UriParam(defaultValue = "true", description = "Whether to fail if no body exists.")
private boolean failOnNullBody = true;
@UriParam(defaultValue = "true", description = "Whether to fail if no header exists when validating against a header.")
private boolean failOnNullHeader = true;
@UriParam(description = "To validate against a header instead of the message body.")
private String headerName;
public ValidatorEndpoint() {
}
public ValidatorEndpoint(String endpointUri, Component component, String resourceUri) {
super(endpointUri, component);
this.resourceUri = resourceUri;
}
@Override
public Producer createProducer() throws Exception {
ValidatingProcessor validator = new ValidatingProcessor();
InputStream is = ResourceHelper.resolveMandatoryResourceAsInputStream(getCamelContext().getClassResolver(), resourceUri);
byte[] bytes = null;
try {
bytes = IOConverter.toBytes(is);
} finally {
// and make sure to close the input stream after the schema has been loaded
IOHelper.close(is);
}
validator.setSchemaAsByteArray(bytes);
LOG.debug("{} using schema resource: {}", this, resourceUri);
configureValidator(validator);
// force loading of schema at create time otherwise concurrent
// processing could cause thread safe issues for the javax.xml.validation.SchemaFactory
validator.loadSchema();
return new ValidatorProducer(this, validator);
}
@Override
public Consumer createConsumer(Processor processor) throws Exception {
throw new UnsupportedOperationException("Cannot consume from validator");
}
@Override
public boolean isSingleton() {
return true;
}
protected void configureValidator(ValidatingProcessor validator) throws Exception {
if (resourceResolver != null) {
validator.setResourceResolver(resourceResolver);
} else {
validator.setResourceResolver(new DefaultLSResourceResolver(getCamelContext(), resourceUri));
}
validator.setSchemaLanguage(getSchemaLanguage());
validator.setSchemaFactory(getSchemaFactory());
validator.setErrorHandler(getErrorHandler());
validator.setUseDom(isUseDom());
validator.setUseSharedSchema(isUseSharedSchema());
validator.setFailOnNullBody(isFailOnNullBody());
validator.setFailOnNullHeader(isFailOnNullHeader());
validator.setHeaderName(getHeaderName());
}
public String getResourceUri() {
return resourceUri;
}
/**
* URL to a local resource on the classpath or a full URL to a remote resource or resource on the file system which contains the XSD to validate against.
*/
public void setResourceUri(String resourceUri) {
this.resourceUri = resourceUri;
}
public String getSchemaLanguage() {
return schemaLanguage;
}
/**
* Configures the W3C XML Schema Namespace URI.
*/
public void setSchemaLanguage(String schemaLanguage) {
this.schemaLanguage = schemaLanguage;
}
public SchemaFactory getSchemaFactory() {
return schemaFactory;
}
/**
* To use a custom javax.xml.validation.SchemaFactory
*/
public void setSchemaFactory(SchemaFactory schemaFactory) {
this.schemaFactory = schemaFactory;
}
public ValidatorErrorHandler getErrorHandler() {
return errorHandler;
}
/**
* To use a custom org.apache.camel.processor.validation.ValidatorErrorHandler.
*
* The default error handler captures the errors and throws an exception.
*/
public void setErrorHandler(ValidatorErrorHandler errorHandler) {
this.errorHandler = errorHandler;
}
public boolean isUseDom() {
return useDom;
}
/**
* Whether DOMSource/DOMResult or SaxSource/SaxResult should be used by the validator.
*/
public void setUseDom(boolean useDom) {
this.useDom = useDom;
}
public boolean isUseSharedSchema() {
return 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.
*/
public void setUseSharedSchema(boolean useSharedSchema) {
this.useSharedSchema = useSharedSchema;
}
public LSResourceResolver getResourceResolver() {
return resourceResolver;
}
/**
* To use a custom LSResourceResolver
*/
public void setResourceResolver(LSResourceResolver resourceResolver) {
this.resourceResolver = resourceResolver;
}
public boolean isFailOnNullBody() {
return failOnNullBody;
}
/**
* Whether to fail if no body exists.
*/
public void setFailOnNullBody(boolean failOnNullBody) {
this.failOnNullBody = failOnNullBody;
}
public boolean isFailOnNullHeader() {
return failOnNullHeader;
}
/**
* Whether to fail if no header exists when validating against a header.
*/
public void setFailOnNullHeader(boolean failOnNullHeader) {
this.failOnNullHeader = failOnNullHeader;
}
public String getHeaderName() {
return headerName;
}
/**
* To validate against a header instead of the message body.
*/
public void setHeaderName(String headerName) {
this.headerName = headerName;
}
}