Class FreemarkerEndpoint
- 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.freemarker.FreemarkerEndpoint
-
- 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.10.0", scheme="freemarker", title="Freemarker", syntax="freemarker:resourceUri", producerOnly=true, category=TRANSFORMATION) public class FreemarkerEndpoint extends org.apache.camel.component.ResourceEndpoint
Transform messages using FreeMarker templates.
-
-
Constructor Summary
Constructors Constructor Description FreemarkerEndpoint()
FreemarkerEndpoint(String uri, org.apache.camel.Component component, String resourceUri)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearContentCache()
protected String
createEndpointUri()
FreemarkerEndpoint
findOrCreateEndpoint(String uri, String newResourceUri)
freemarker.template.Configuration
getConfiguration()
String
getEncoding()
org.apache.camel.ExchangePattern
getExchangePattern()
int
getTemplateUpdateDelay()
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
setConfiguration(freemarker.template.Configuration configuration)
Sets the Freemarker configuration to usevoid
setEncoding(String encoding)
Sets the encoding to be used for loading the template file.void
setTemplateUpdateDelay(int templateUpdateDelay)
Number of seconds the loaded template resource will remain in the cache.-
Methods inherited from class org.apache.camel.component.ResourceEndpoint
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.ScheduledPollEndpoint
configureConsumer, configureProperties, configureScheduledPollConsumerProperties, doConfigureConsumer, doStart, doStop, 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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getExchangePattern
public org.apache.camel.ExchangePattern getExchangePattern()
- Specified by:
getExchangePattern
in interfaceorg.apache.camel.Endpoint
- Overrides:
getExchangePattern
in classorg.apache.camel.support.DefaultEndpoint
-
createEndpointUri
protected String createEndpointUri()
- Overrides:
createEndpointUri
in classorg.apache.camel.support.DefaultEndpoint
-
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.
-
setEncoding
public void setEncoding(String encoding)
Sets the encoding to be used for loading the template file.
-
getEncoding
public String getEncoding()
-
getTemplateUpdateDelay
public int getTemplateUpdateDelay()
-
setTemplateUpdateDelay
public void setTemplateUpdateDelay(int templateUpdateDelay)
Number of seconds the loaded template resource will remain in the cache.
-
getConfiguration
public freemarker.template.Configuration getConfiguration()
-
setConfiguration
public void setConfiguration(freemarker.template.Configuration configuration)
Sets the Freemarker configuration to use
-
findOrCreateEndpoint
public FreemarkerEndpoint findOrCreateEndpoint(String uri, String newResourceUri)
-
clearContentCache
public void clearContentCache()
- Specified by:
clearContentCache
in interfaceorg.apache.camel.api.management.mbean.ManagedResourceEndpointMBean
- Overrides:
clearContentCache
in classorg.apache.camel.component.ResourceEndpoint
-
-