Package org.apache.camel.model.language
Class XPathExpression
- java.lang.Object
-
- org.apache.camel.model.language.ExpressionDefinition
-
- org.apache.camel.model.language.SingleInputExpressionDefinition
-
- org.apache.camel.model.language.NamespaceAwareExpression
-
- org.apache.camel.model.language.XPathExpression
-
- All Implemented Interfaces:
org.apache.camel.Expression
,org.apache.camel.ExpressionFactory
,HasExpressionType
,org.apache.camel.Predicate
,org.apache.camel.PredicateFactory
,org.apache.camel.spi.ExpressionFactoryAware
,org.apache.camel.spi.NamespaceAware
,org.apache.camel.spi.PredicateFactoryAware
@Metadata(firstVersion="1.1.0", label="language,core,xml", title="XPath") public class XPathExpression extends NamespaceAwareExpression
Evaluates an XPath expression against an XML payload.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
XPathExpression.Builder
Builder
is a specific builder forXPathExpression
.-
Nested classes/interfaces inherited from class org.apache.camel.model.language.SingleInputExpressionDefinition
SingleInputExpressionDefinition.AbstractBuilder<T extends SingleInputExpressionDefinition.AbstractBuilder<T,E>,E extends SingleInputExpressionDefinition>
-
-
Constructor Summary
Constructors Constructor Description XPathExpression()
XPathExpression(String expression)
XPathExpression(org.apache.camel.Expression expression)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class<?>
getDocumentType()
String
getDocumentTypeName()
String
getFactoryRef()
String
getLanguage()
String
getLogNamespaces()
String
getObjectModel()
String
getPreCompile()
Class<?>
getResultType()
String
getResultTypeName()
String
getSaxon()
String
getThreadSafety()
XPathFactory
getXPathFactory()
void
setDocumentType(Class<?> documentType)
Class for document type to usevoid
setDocumentTypeName(String documentTypeName)
Name of class for document typevoid
setFactoryRef(String factoryRef)
References to a custom XPathFactory to lookup in the registryvoid
setLogNamespaces(String logNamespaces)
Whether to log namespaces which can assist during troubleshootingvoid
setObjectModel(String objectModel)
The XPath object model to usevoid
setPreCompile(String preCompile)
Whether to enable pre-compiling the xpath expression during initialization phase.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)void
setSaxon(String saxon)
Whether to use Saxon.void
setThreadSafety(String threadSafety)
Whether to enable thread-safety for the returned result of the xpath expression.void
setXPathFactory(XPathFactory xpathFactory)
-
Methods inherited from class org.apache.camel.model.language.NamespaceAwareExpression
getNamespace, getNamespaceAsMap, getNamespaces, setNamespace, setNamespaces
-
Methods inherited from class org.apache.camel.model.language.SingleInputExpressionDefinition
getHeaderName, getPropertyName, setHeaderName, setPropertyName
-
Methods inherited from class org.apache.camel.model.language.ExpressionDefinition
createExpression, createPredicate, evaluate, getExpression, getExpressionFactory, getExpressionType, getExpressionValue, getId, getLabel, getLabel, getPredicate, getPredicateFactory, getTrim, init, initPredicate, matches, setExpression, setExpressionType, setExpressionValue, setId, setTrim, toString
-
-
-
-
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 classExpressionDefinition
-
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(String saxon)
Whether to use Saxon.
-
getSaxon
public String 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(String logNamespaces)
Whether to log namespaces which can assist during troubleshooting
-
getLogNamespaces
public String getLogNamespaces()
-
getXPathFactory
public XPathFactory getXPathFactory()
-
setXPathFactory
public void setXPathFactory(XPathFactory xpathFactory)
-
getThreadSafety
public String getThreadSafety()
-
setThreadSafety
public void setThreadSafety(String 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.
-
getPreCompile
public String getPreCompile()
-
setPreCompile
public void setPreCompile(String preCompile)
Whether to enable pre-compiling the xpath expression during initialization phase. pre-compile is enabled by default.This can be used to turn off, for example in cases the compilation phase is desired at the starting phase, such as if the application is ahead of time compiled (for example with camel-quarkus) which would then load the xpath factory of the built operating system, and not a JVM runtime.
-
-