Package org.apache.camel.component.chunk

Class ChunkEndpoint

  • All Implemented Interfaces:
    AutoCloseable, org.apache.camel.api.management.mbean.ManagedResourceEndpointMBean, org.apache.camel.CamelContextAware, org.apache.camel.Endpoint, org.apache.camel.IsSingleton, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.spi.HasId, org.apache.camel.StatefulService, org.apache.camel.SuspendableService
    @UriEndpoint(firstVersion="2.15.0",
             scheme="chunk",
             title="Chunk",
             syntax="chunk:resourceUri",
             producerOnly=true,
             category=TRANSFORMATION,
             headersClass=ChunkConstants.class)
public class ChunkEndpoint
extends org.apache.camel.component.ResourceEndpoint
    Transform messages using Chunk templating 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearContentCache()  
      protected String createEndpointUri()  
      protected void doStart()  
      protected void doStop()  
      String getEncoding()  
      org.apache.camel.ExchangePattern getExchangePattern()  
      String getExtension()  
      String getResourceUri()  
      String getThemeFolder()  
      String getThemeLayer()  
      String getThemeSubfolder()  
      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 setEncoding​(String encoding)  
      void setExtension​(String extension)  
      void setThemeFolder​(String themeFolder)  
      void setThemeLayer​(String themeLayer)  
      void setThemeSubfolder​(String themeSubfolder)  

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

        getCamelId, getCamelManagementName, getResourceAsInputStream, getResourceAsInputStreamWithoutCache, 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, 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, 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 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 Detail

      • ChunkEndpoint

        public ChunkEndpoint()

      • ChunkEndpoint

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

    • Method Detail

      • 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

      • createEndpointUri

        protected String createEndpointUri()
        Overrides:
        createEndpointUri in class org.apache.camel.support.DefaultEndpoint

      • clearContentCache

        public void clearContentCache()
        Specified by:
        clearContentCache in interface org.apache.camel.api.management.mbean.ManagedResourceEndpointMBean
        Overrides:
        clearContentCache in class org.apache.camel.component.ResourceEndpoint

      • onExchange

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

      • getResourceUri

        public String getResourceUri()
        Overrides:
        getResourceUri in class org.apache.camel.component.ResourceEndpoint

      • getEncoding

        public String getEncoding()

      • setEncoding

        public void setEncoding​(String encoding)

      • getThemeFolder

        public String getThemeFolder()

      • setThemeFolder

        public void setThemeFolder​(String themeFolder)

      • getThemeSubfolder

        public String getThemeSubfolder()

      • setThemeSubfolder

        public void setThemeSubfolder​(String themeSubfolder)

      • getThemeLayer

        public String getThemeLayer()

      • setThemeLayer

        public void setThemeLayer​(String themeLayer)

      • getExtension

        public String getExtension()

      • setExtension

        public void setExtension​(String extension)

      • 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.

      • doStart

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

      • doStop

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