Package org.apache.camel.component.xquery

Class XQueryEndpoint

java.lang.Object
org.apache.camel.support.service.BaseService
org.apache.camel.support.service.ServiceSupport
org.apache.camel.support.DefaultEndpoint
org.apache.camel.support.ScheduledPollEndpoint
org.apache.camel.support.DefaultPollingEndpoint
org.apache.camel.support.ProcessorEndpoint
org.apache.camel.component.xquery.XQueryEndpoint
All Implemented Interfaces:
AutoCloseable, org.apache.camel.CamelContextAware, org.apache.camel.ComponentAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasCamelContext, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
@UriEndpoint(firstVersion="1.0.0", scheme="xquery", title="XQuery", syntax="xquery:resourceUri", remote=false, category=TRANSFORMATION) public class XQueryEndpoint extends org.apache.camel.support.ProcessorEndpoint
Query and/or transform XML payloads using XQuery and Saxon.

  • Field Summary

    Fields inherited from class org.apache.camel.support.service.BaseService

    BUILT, FAILED, INITIALIZED, INITIALIZING, lock, NEW, SHUTDOWN, SHUTTING_DOWN, STARTED, STARTING, status, STOPPED, STOPPING, SUSPENDED, SUSPENDING

  • Constructor Summary

    Constructors
    Constructor
    Description
    XQueryEndpoint(String endpointUri, org.apache.camel.Component component)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doInit()
     
    protected void
    doInitXQuery()
     
    protected void
    doStart()
     
    protected void
    doStop()
     
    net.sf.saxon.Configuration
    getConfiguration()
     
    Map<String,Object>
    getConfigurationProperties()
     
    net.sf.saxon.lib.ModuleURIResolver
    getModuleURIResolver()
     
    Map<String,String>
    getNamespacePrefixes()
     
    Map<String,Object>
    getParameters()
     
    Properties
    getProperties()
     
    String
    getResourceUri()
     
    ResultFormat
    getResultsFormat()
     
    Class<?>
    getResultType()
     
    String
    getSource()
     
    net.sf.saxon.query.StaticQueryContext
    getStaticQueryContext()
     
    boolean
    isAllowStAX()
     
    boolean
    isRemote()
     
    boolean
    isStripsAllWhiteSpace()
     
    void
    setAllowStAX(boolean allowStAX)
    Whether to allow using StAX mode
    void
    setConfiguration(net.sf.saxon.Configuration configuration)
    To use a custom Saxon configuration
    void
    setConfigurationProperties(Map<String,Object> configurationProperties)
    To set custom Saxon configuration properties
    void
    setModuleURIResolver(net.sf.saxon.lib.ModuleURIResolver moduleURIResolver)
    To use the custom ModuleURIResolver
    void
    setNamespacePrefixes(Map<String,String> namespacePrefixes)
    Allows to control which namespace prefixes to use for a set of namespace mappings
    void
    setParameters(Map<String,Object> parameters)
    Additional parameters
    void
    setProperties(Properties properties)
    Properties to configure the serialization parameters
    void
    setResourceUri(String resourceUri)
    The name of the template to load from classpath or file system
    void
    setResultsFormat(ResultFormat resultsFormat)
    What output result to use
    void
    setResultType(Class<?> resultType)
    What output result to use defined as a class
    void
    setSource(String source)
    Source to use, instead of message body.
    void
    setStaticQueryContext(net.sf.saxon.query.StaticQueryContext staticQueryContext)
    To use a custom Saxon StaticQueryContext
    void
    setStripsAllWhiteSpace(boolean stripsAllWhiteSpace)
    Whether to strip all whitespaces

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

    createPollingConsumer, createProcessor, createProducer, getProcessor, onExchange, setProcessor

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

    createConsumer

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

    configureConsumer, configureProperties, configureScheduledPollConsumerProperties, doConfigureConsumer, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDefaultDelay, getDelay, getInitialDelay, getPollStrategy, getRepeatCount, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRepeatCount, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

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

    configureExchange, configurePollingConsumer, createAsyncProducer, createEndpointUri, createExchange, createExchange, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, getExchangePattern, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isAutowiredEnabled, isBridgeErrorHandler, isLazyStartProducer, isLenientProperties, isPollingConsumerBlockWhenFull, isPollingConsumerCopy, isSingleton, setAutowiredEnabled, setBridgeErrorHandler, setCamelContext, setComponent, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setLazyStartProducer, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerCopy, setPollingConsumerQueueSize, setProperties, toString

    Methods inherited from class org.apache.camel.support.service.BaseService

    build, doBuild, doFail, doLifecycleChange, doResume, doShutdown, doSuspend, fail, getInternalLock, getStatus, init, isBuild, isInit, isNew, isRunAllowed, isShutdown, isStarted, isStarting, isStartingOrStarted, 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.ComponentAware

    getComponent

    Methods inherited from interface org.apache.camel.Endpoint

    getEndpointBaseUri, isSingletonProducer

    Methods inherited from interface org.apache.camel.Service

    build, close, init, start, stop

    Methods inherited from interface org.apache.camel.ShutdownableService

    shutdown

    Methods inherited from interface org.apache.camel.StatefulService

    getStatus, isRunAllowed, isStarted, isStarting, isStopped, isStopping, isSuspending

    Methods inherited from interface org.apache.camel.SuspendableService

    isSuspended, resume, suspend

  • Constructor Details

    • XQueryEndpoint

      public XQueryEndpoint(String endpointUri, org.apache.camel.Component component)

  • Method Details

    • isRemote

      public boolean isRemote()

    • getResourceUri

      public String getResourceUri()

    • setResourceUri

      public void setResourceUri(String resourceUri)
      The name of the template to load from classpath or file system

    • getConfiguration

      public net.sf.saxon.Configuration getConfiguration()

    • setConfiguration

      public void setConfiguration(net.sf.saxon.Configuration configuration)
      To use a custom Saxon configuration

    • getConfigurationProperties

      public Map<String,Object> getConfigurationProperties()

    • setConfigurationProperties

      public void setConfigurationProperties(Map<String,Object> configurationProperties)
      To set custom Saxon configuration properties

    • getStaticQueryContext

      public net.sf.saxon.query.StaticQueryContext getStaticQueryContext()

    • setStaticQueryContext

      public void setStaticQueryContext(net.sf.saxon.query.StaticQueryContext staticQueryContext)
      To use a custom Saxon StaticQueryContext

    • getParameters

      public Map<String,Object> getParameters()

    • setParameters

      public void setParameters(Map<String,Object> parameters)
      Additional parameters

    • getNamespacePrefixes

      public Map<String,String> getNamespacePrefixes()

    • setNamespacePrefixes

      public void setNamespacePrefixes(Map<String,String> namespacePrefixes)
      Allows to control which namespace prefixes to use for a set of namespace mappings

    • getResultsFormat

      public ResultFormat getResultsFormat()

    • setResultsFormat

      public void setResultsFormat(ResultFormat resultsFormat)
      What output result to use

    • getProperties

      public Properties getProperties()

    • setProperties

      public void setProperties(Properties properties)
      Properties to configure the serialization parameters

    • getResultType

      public Class<?> getResultType()

    • setResultType

      public void setResultType(Class<?> resultType)
      What output result to use defined as a class

    • isStripsAllWhiteSpace

      public boolean isStripsAllWhiteSpace()

    • setStripsAllWhiteSpace

      public void setStripsAllWhiteSpace(boolean stripsAllWhiteSpace)
      Whether to strip all whitespaces

    • getModuleURIResolver

      public net.sf.saxon.lib.ModuleURIResolver getModuleURIResolver()

    • setModuleURIResolver

      public void setModuleURIResolver(net.sf.saxon.lib.ModuleURIResolver moduleURIResolver)
      To use the custom ModuleURIResolver

    • isAllowStAX

      public boolean isAllowStAX()

    • setAllowStAX

      public void setAllowStAX(boolean allowStAX)
      Whether to allow using StAX mode

    • getSource

      public String getSource()

    • setSource

      public void setSource(String source)
      Source to use, instead of message body. You can prefix with variable:, header:, or property: to specify kind of source. Otherwise, the source is assumed to be a variable. Use empty or null to use default source, which is the message body.

    • doInit

      protected void doInit() throws Exception
      Overrides:
      doInit in class org.apache.camel.support.DefaultEndpoint
      Throws:
      Exception

    • doStart

      protected void doStart() throws Exception
      Overrides:
      doStart in class org.apache.camel.support.service.BaseService
      Throws:
      Exception

    • doInitXQuery

      protected void doInitXQuery() throws Exception
      Throws:
      Exception

    • doStop

      protected void doStop() throws Exception
      Overrides:
      doStop in class org.apache.camel.support.service.BaseService
      Throws:
      Exception