org.apache.camel.model.language

Class XPathExpression

java.lang.Object

org.apache.camel.model.language.ExpressionDefinition

org.apache.camel.model.language.NamespaceAwareExpression

org.apache.camel.model.language.XPathExpression

All Implemented Interfaces:

org.apache.camel.Expression, org.apache.camel.ExpressionFactory, DefinitionPropertyPlaceholderConfigurer, OtherAttributesAware, org.apache.camel.Predicate, org.apache.camel.spi.NamespaceAware, org.apache.camel.spi.PropertyConfigurer, org.apache.camel.spi.PropertyPlaceholderConfigurer

@Metadata(firstVersion="1.1.0",
          label="language,core,xml",
          title="XPath")
public class XPathExpression
extends NamespaceAwareExpression

To use XPath (XML) in Camel expressions or predicates.

Constructor Summary

Constructors

Constructor and Description
XPathExpression()
XPathExpression(org.apache.camel.Expression expression)
XPathExpression(String expression)

Method Summary

Modifier and Type	Method and Description
protected void	configureExpression(org.apache.camel.CamelContext camelContext, org.apache.camel.Expression expression)
protected void	configurePredicate(org.apache.camel.CamelContext camelContext, org.apache.camel.Predicate predicate)
org.apache.camel.Expression	createExpression(org.apache.camel.CamelContext camelContext)
org.apache.camel.Predicate	createPredicate(org.apache.camel.CamelContext camelContext)
Class<?>	getDocumentType()
String	getDocumentTypeName()
String	getFactoryRef()
String	getHeaderName()
String	getLanguage()
Boolean	getLogNamespaces()
String	getObjectModel()
Class<?>	getResultType()
String	getResultTypeName()
Boolean	getSaxon()
Boolean	getThreadSafety()
void	setDocumentType(Class<?> documentType) Class for document type to use The default value is org.w3c.dom.Document
void	setDocumentTypeName(String documentTypeName) Name of class for document type The default value is org.w3c.dom.Document
void	setFactoryRef(String factoryRef) References to a custom XPathFactory to lookup in the registry
void	setHeaderName(String headerName) Name of header to use as input, instead of the message body
void	setLogNamespaces(Boolean logNamespaces) Whether to log namespaces which can assist during trouble shooting
void	setObjectModel(String objectModel) The XPath object model to use
void	setResultType(Class<?> resultType) Sets the class of the result type (type from output).
void	setResultTypeName(String resultTypeName) Sets the class name of the result type (type from output) The default result type is NodeSet
void	setSaxon(Boolean saxon) Whether to use Saxon.
void	setThreadSafety(Boolean threadSafety) Whether to enable thread-safety for the returned result of the xpath expression.

Methods inherited from class org.apache.camel.model.language.NamespaceAwareExpression

configureNamespaceAware, getNamespaces, setNamespaces

Methods inherited from class org.apache.camel.model.language.ExpressionDefinition

assertMatches, createExpression, createPredicate, evaluate, evaluate, getExpression, getExpressionType, getExpressionValue, getId, getLabel, getLabel, getOtherAttributes, getPredicate, getTrim, matches, setExpression, setExpressionType, setExpressionValue, setId, setOtherAttributes, setProperty, setTrim, 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.model.DefinitionPropertyPlaceholderConfigurer

getReadPropertyPlaceholderOptions, getWritePropertyPlaceholderOptions

Constructor Detail

XPathExpression

public XPathExpression()

XPathExpression

public XPathExpression(String expression)

XPathExpression

public XPathExpression(org.apache.camel.Expression expression)

Method Detail

getLanguage

public String getLanguage()

Overrides:

getLanguage in class ExpressionDefinition

getDocumentType

public Class<?> getDocumentType()

setDocumentType

public void setDocumentType(Class<?> documentType)

Class for document type to use

The default value is org.w3c.dom.Document

getDocumentTypeName

public String getDocumentTypeName()

setDocumentTypeName

public void setDocumentTypeName(String documentTypeName)

Name of class for document type

The default value is org.w3c.dom.Document

getResultType

public Class<?> getResultType()

setResultType

public void setResultType(Class<?> resultType)

Sets the class of the result type (type from output).

The default result type is NodeSet

getResultTypeName

public String getResultTypeName()

setResultTypeName

public void setResultTypeName(String resultTypeName)

Sets the class name of the result type (type from output)

The default result type is NodeSet

setSaxon

public void setSaxon(Boolean saxon)

Whether to use Saxon.

getSaxon

public Boolean getSaxon()

setFactoryRef

public void setFactoryRef(String factoryRef)

References to a custom XPathFactory to lookup in the registry

getFactoryRef

public String getFactoryRef()

setObjectModel

public void setObjectModel(String objectModel)

The XPath object model to use

getObjectModel

public String getObjectModel()

setLogNamespaces

public void setLogNamespaces(Boolean logNamespaces)

Whether to log namespaces which can assist during trouble shooting

getLogNamespaces

public Boolean getLogNamespaces()

getHeaderName

public String getHeaderName()

setHeaderName

public void setHeaderName(String headerName)

Name of header to use as input, instead of the message body

getThreadSafety

public Boolean getThreadSafety()

setThreadSafety

public void setThreadSafety(Boolean 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.

createExpression

public org.apache.camel.Expression createExpression(org.apache.camel.CamelContext camelContext)

Specified by:

createExpression in interface org.apache.camel.ExpressionFactory

Overrides:

createExpression in class ExpressionDefinition

createPredicate

public org.apache.camel.Predicate createPredicate(org.apache.camel.CamelContext camelContext)

Overrides:

createPredicate in class ExpressionDefinition

configureExpression

protected void configureExpression(org.apache.camel.CamelContext camelContext,
                                   org.apache.camel.Expression expression)

Overrides:

configureExpression in class NamespaceAwareExpression

configurePredicate

protected void configurePredicate(org.apache.camel.CamelContext camelContext,
                                  org.apache.camel.Predicate predicate)

Overrides:

configurePredicate in class NamespaceAwareExpression