org.apache.camel.component.freemarker

Class FreemarkerEndpoint

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.impl.DefaultEndpoint

org.apache.camel.impl.ScheduledPollEndpoint

org.apache.camel.impl.DefaultPollingEndpoint

org.apache.camel.impl.ProcessorEndpoint

org.apache.camel.component.ResourceEndpoint

org.apache.camel.component.freemarker.FreemarkerEndpoint

All Implemented Interfaces:

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,
             label="transformation")
public class FreemarkerEndpoint
extends org.apache.camel.component.ResourceEndpoint

Transforms the message using a FreeMarker template.

Field Summary

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

log

Fields inherited from class org.apache.camel.support.ServiceSupport

shutdown, shuttingdown, started, starting, stopped, stopping, suspended, suspending

Constructor Summary

Constructors

Constructor and Description
FreemarkerEndpoint()
FreemarkerEndpoint(String uri, org.apache.camel.Component component, String resourceUri)

Method Summary

Modifier and Type	Method and 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()
boolean	isSingleton()
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 use
void	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.impl.ProcessorEndpoint

createPollingConsumer, createProcessor, createProducer, getProcessor, setProcessor

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

createConsumer

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

configurePollingConsumer, configureProperties, configureScheduledPollConsumerProperties, doStart, doStop, getBackoffErrorThreshold, getBackoffIdleThreshold, getBackoffMultiplier, getDelay, getInitialDelay, getPollStrategy, getRunLoggingLevel, getScheduledExecutorService, getScheduler, getSchedulerProperties, getTimeUnit, initConsumerProperties, isGreedy, isSendEmptyMessageWhenIdle, isStartScheduler, isUseFixedDelay, setBackoffErrorThreshold, setBackoffIdleThreshold, setBackoffMultiplier, setDelay, setGreedy, setInitialDelay, setPollStrategy, setRunLoggingLevel, setScheduledExecutorService, setScheduler, setScheduler, setSchedulerProperties, setSendEmptyMessageWhenIdle, setStartScheduler, setTimeUnit, setUseFixedDelay

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

configureConsumer, createEndpointConfiguration, createExchange, createExchange, createExchange, equals, getCamelContext, getComponent, getConsumerProperties, getEndpointConfiguration, getEndpointKey, getEndpointUri, getExceptionHandler, getId, getPollingConsumerBlockTimeout, getPollingConsumerQueueSize, hashCode, isBridgeErrorHandler, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setBridgeErrorHandler, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExceptionHandler, setExchangePattern, setPollingConsumerBlockTimeout, setPollingConsumerBlockWhenFull, setPollingConsumerQueueSize, setProperties, setSynchronous, toString

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

doResume, doShutdown, doSuspend, getStatus, getVersion, isRunAllowed, isStarted, isStarting, 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.Service

start, stop

Constructor Detail

FreemarkerEndpoint

public FreemarkerEndpoint()

FreemarkerEndpoint

public FreemarkerEndpoint(String uri,
                          org.apache.camel.Component component,
                          String resourceUri)

Method Detail

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.apache.camel.IsSingleton

Overrides:

isSingleton in class org.apache.camel.impl.ProcessorEndpoint

getExchangePattern

public org.apache.camel.ExchangePattern getExchangePattern()

Overrides:

getExchangePattern in class org.apache.camel.impl.DefaultEndpoint

createEndpointUri

protected String createEndpointUri()

Overrides:

createEndpointUri in class org.apache.camel.impl.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 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.impl.ProcessorEndpoint

Throws:

Exception