org.apache.camel.model.language.XPathExpression 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.model.language;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import javax.xml.xpath.XPathFactory;
import org.apache.camel.CamelContext;
import org.apache.camel.Expression;
import org.apache.camel.Predicate;
import org.apache.camel.builder.xml.XPathBuilder;
import org.apache.camel.spi.Metadata;
import org.apache.camel.util.ObjectHelper;
/**
* To use XPath (XML) in Camel expressions or predicates.
*/
@Metadata(firstVersion = "1.1.0", label = "language,core,xml", title = "XPath")
@XmlRootElement(name = "xpath")
@XmlAccessorType(XmlAccessType.FIELD)
public class XPathExpression extends NamespaceAwareExpression {
@XmlAttribute(name = "documentType")
private String documentTypeName;
@XmlAttribute(name = "resultType") @Metadata(defaultValue = "NODESET", enums = "NUMBER,STRING,BOOLEAN,NODESET,NODE")
private String resultTypeName;
@XmlAttribute
private Boolean saxon;
@XmlAttribute @Metadata(label = "advanced")
private String factoryRef;
@XmlAttribute @Metadata(label = "advanced")
private String objectModel;
@XmlAttribute
private Boolean logNamespaces;
@XmlAttribute
private String headerName;
@XmlTransient
private Class documentType;
@XmlTransient
private Class resultType;
@XmlTransient
private XPathFactory xpathFactory;
@XmlAttribute @Metadata(label = "advanced")
private Boolean threadSafety;
public XPathExpression() {
}
public XPathExpression(String expression) {
super(expression);
}
public XPathExpression(Expression expression) {
setExpressionValue(expression);
}
public String getLanguage() {
return "xpath";
}
public Class getDocumentType() {
return documentType;
}
/**
* Class for document type to use
*
* The default value is org.w3c.dom.Document
*/
public void setDocumentType(Class documentType) {
this.documentType = documentType;
}
public String getDocumentTypeName() {
return documentTypeName;
}
/**
* Name of class for document type
*
* The default value is org.w3c.dom.Document
*/
public void setDocumentTypeName(String documentTypeName) {
this.documentTypeName = documentTypeName;
}
public Class getResultType() {
return resultType;
}
/**
* Sets the class of the result type (type from output).
*
* The default result type is NodeSet
*/
public void setResultType(Class resultType) {
this.resultType = resultType;
}
public String getResultTypeName() {
return resultTypeName;
}
/**
* Sets the class name of the result type (type from output)
*
* The default result type is NodeSet
*/
public void setResultTypeName(String resultTypeName) {
this.resultTypeName = resultTypeName;
}
/**
* Whether to use Saxon.
*/
public void setSaxon(Boolean saxon) {
this.saxon = saxon;
}
public Boolean getSaxon() {
return saxon;
}
/**
* References to a custom XPathFactory to lookup in the registry
*/
public void setFactoryRef(String factoryRef) {
this.factoryRef = factoryRef;
}
public String getFactoryRef() {
return factoryRef;
}
/**
* The XPath object model to use
*/
public void setObjectModel(String objectModel) {
this.objectModel = objectModel;
}
public String getObjectModel() {
return objectModel;
}
/**
* Whether to log namespaces which can assist during trouble shooting
*/
public void setLogNamespaces(Boolean logNamespaces) {
this.logNamespaces = logNamespaces;
}
public Boolean getLogNamespaces() {
return logNamespaces;
}
public String getHeaderName() {
return headerName;
}
/**
* Name of header to use as input, instead of the message body
*/
public void setHeaderName(String headerName) {
this.headerName = headerName;
}
public Boolean getThreadSafety() {
return threadSafety;
}
/**
* Whether to enable thread-safety for the returned result of the xpath expression.
* This applies to when using NODESET as the result type, and the returned set has
* multiple elements. In this situation there can be thread-safety issues if you
* process the NODESET concurrently such as from a Camel Splitter EIP in parallel processing mode.
* This option prevents concurrency issues by doing defensive copies of the nodes.
*
* It is recommended to turn this option on if you are using camel-saxon or Saxon in your application.
* Saxon has thread-safety issues which can be prevented by turning this option on.
*/
public void setThreadSafety(Boolean threadSafety) {
this.threadSafety = threadSafety;
}
@Override
public Expression createExpression(CamelContext camelContext) {
if (documentType == null && documentTypeName != null) {
try {
documentType = camelContext.getClassResolver().resolveMandatoryClass(documentTypeName);
} catch (ClassNotFoundException e) {
throw ObjectHelper.wrapRuntimeCamelException(e);
}
}
if (resultType == null && resultTypeName != null) {
try {
resultType = camelContext.getClassResolver().resolveMandatoryClass(resultTypeName);
} catch (ClassNotFoundException e) {
throw ObjectHelper.wrapRuntimeCamelException(e);
}
}
resolveXPathFactory(camelContext);
return super.createExpression(camelContext);
}
@Override
public Predicate createPredicate(CamelContext camelContext) {
if (documentType == null && documentTypeName != null) {
try {
documentType = camelContext.getClassResolver().resolveMandatoryClass(documentTypeName);
} catch (ClassNotFoundException e) {
throw ObjectHelper.wrapRuntimeCamelException(e);
}
}
resolveXPathFactory(camelContext);
return super.createPredicate(camelContext);
}
@Override
protected void configureExpression(CamelContext camelContext, Expression expression) {
boolean isSaxon = getSaxon() != null && getSaxon();
boolean isLogNamespaces = getLogNamespaces() != null && getLogNamespaces();
if (documentType != null) {
setProperty(expression, "documentType", documentType);
}
if (resultType != null) {
setProperty(expression, "resultType", resultType);
}
if (isSaxon) {
ObjectHelper.cast(XPathBuilder.class, expression).enableSaxon();
}
if (xpathFactory != null) {
setProperty(expression, "xPathFactory", xpathFactory);
}
if (objectModel != null) {
setProperty(expression, "objectModelUri", objectModel);
}
if (threadSafety != null) {
setProperty(expression, "threadSafety", threadSafety);
}
if (isLogNamespaces) {
ObjectHelper.cast(XPathBuilder.class, expression).setLogNamespaces(true);
}
if (ObjectHelper.isNotEmpty(getHeaderName())) {
ObjectHelper.cast(XPathBuilder.class, expression).setHeaderName(getHeaderName());
}
// moved the super configuration to the bottom so that the namespace init picks up the newly set XPath Factory
super.configureExpression(camelContext, expression);
}
@Override
protected void configurePredicate(CamelContext camelContext, Predicate predicate) {
boolean isSaxon = getSaxon() != null && getSaxon();
boolean isLogNamespaces = getLogNamespaces() != null && getLogNamespaces();
if (documentType != null) {
setProperty(predicate, "documentType", documentType);
}
if (resultType != null) {
setProperty(predicate, "resultType", resultType);
}
if (isSaxon) {
ObjectHelper.cast(XPathBuilder.class, predicate).enableSaxon();
}
if (xpathFactory != null) {
setProperty(predicate, "xPathFactory", xpathFactory);
}
if (objectModel != null) {
setProperty(predicate, "objectModelUri", objectModel);
}
if (threadSafety != null) {
setProperty(predicate, "threadSafety", threadSafety);
}
if (isLogNamespaces) {
ObjectHelper.cast(XPathBuilder.class, predicate).setLogNamespaces(true);
}
if (ObjectHelper.isNotEmpty(getHeaderName())) {
ObjectHelper.cast(XPathBuilder.class, predicate).setHeaderName(getHeaderName());
}
// moved the super configuration to the bottom so that the namespace init picks up the newly set XPath Factory
super.configurePredicate(camelContext, predicate);
}
private void resolveXPathFactory(CamelContext camelContext) {
// Factory and Object Model can be set simultaneously. The underlying XPathBuilder allows for setting Saxon too, as it is simply a shortcut for
// setting the appropriate Object Model, it is not wise to allow this in XML because the order of invocation of the setters by JAXB may cause undeterministic behaviour
if ((ObjectHelper.isNotEmpty(factoryRef) || ObjectHelper.isNotEmpty(objectModel)) && (saxon != null)) {
throw new IllegalArgumentException("The saxon attribute cannot be set on the xpath element if any of the following is also set: factory, objectModel" + this);
}
// Validate the factory class
if (ObjectHelper.isNotEmpty(factoryRef)) {
xpathFactory = camelContext.getRegistry().lookupByNameAndType(factoryRef, XPathFactory.class);
if (xpathFactory == null) {
throw new IllegalArgumentException("The provided XPath Factory is invalid; either it cannot be resolved or it is not an XPathFactory instance");
}
}
}
}