Package org.apache.camel.component.stringtemplate

Class StringTemplateEndpoint

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.ResourceEndpoint
org.apache.camel.component.stringtemplate.StringTemplateEndpoint
All Implemented Interfaces:
AutoCloseable, org.apache.camel.api.management.mbean.ManagedResourceEndpointMBean, 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.2.0", scheme="string-template", title="String Template", syntax="string-template:resourceUri", producerOnly=true, category={TRANSFORMATION,SCRIPT}, headersClass=StringTemplateConstants.class) public class StringTemplateEndpoint extends org.apache.camel.component.ResourceEndpoint
Transform messages using StringTemplate engine.

  • Field Summary

    Fields inherited from class org.apache.camel.component.ResourceEndpoint

    log

    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
    StringTemplateEndpoint()
     
    StringTemplateEndpoint(String endpointUri, org.apache.camel.Component component, String resourceUri)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    StringTemplateEndpoint
    findOrCreateEndpoint(String uri, String newResourceUri)
     
    char
    getDelimiterStart()
     
    char
    getDelimiterStop()
     
    org.apache.camel.ExchangePattern
    getExchangePattern()
     
    boolean
    isAllowTemplateFromHeader()
     
    protected void
    onExchange(org.apache.camel.Exchange exchange)
     
    void
    setAllowTemplateFromHeader(boolean allowTemplateFromHeader)
    Whether to allow to use resource template from header or not (default false).
    void
    setDelimiterStart(char delimiterStart)
    The variable start delimiter
    void
    setDelimiterStop(char delimiterStop)
    The variable end delimiter

    Methods inherited from class org.apache.camel.component.ResourceEndpoint

    clearContentCache, getCamelId, getCamelManagementName, getResourceAsInputStream, getResourceAsInputStreamWithoutCache, getResourceUri, getState, isAllowContextMapAll, isContentCache, isContentCacheCleared, loadResource, setAllowContextMapAll, setContentCache, setResourceUri

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

    createPollingConsumer, createProcessor, createProducer, getProcessor, 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, doInit, equals, getCamelContext, getComponent, getEndpointKey, getEndpointUri, getExceptionHandler, 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, doStart, doStop, doSuspend, fail, 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

    • StringTemplateEndpoint

      public StringTemplateEndpoint()

    • StringTemplateEndpoint

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

  • Method Details

    • getExchangePattern

      public org.apache.camel.ExchangePattern getExchangePattern()
      Specified by:
      getExchangePattern in interface org.apache.camel.Endpoint
      Overrides:
      getExchangePattern in class org.apache.camel.support.DefaultEndpoint

    • getDelimiterStart

      public char getDelimiterStart()

    • setDelimiterStart

      public void setDelimiterStart(char delimiterStart)
      The variable start delimiter

    • getDelimiterStop

      public char getDelimiterStop()

    • setDelimiterStop

      public void setDelimiterStop(char delimiterStop)
      The variable end delimiter

    • isAllowTemplateFromHeader

      public boolean isAllowTemplateFromHeader()

    • setAllowTemplateFromHeader

      public void setAllowTemplateFromHeader(boolean allowTemplateFromHeader)
      Whether to allow to use resource template from header or not (default false). Enabling this allows to specify dynamic templates via message header. However this can be seen as a potential security vulnerability if the header is coming from a malicious user, so use this with care.

    • findOrCreateEndpoint

      public StringTemplateEndpoint findOrCreateEndpoint(String uri, String newResourceUri)

    • onExchange

      protected void onExchange(org.apache.camel.Exchange exchange) throws Exception
      Overrides:
      onExchange in class org.apache.camel.support.ProcessorEndpoint
      Throws:
      Exception