org.apache.camel.component.velocity

Class VelocityEndpoint

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.velocity.VelocityEndpoint

All Implemented Interfaces:

ManagedResourceEndpointMBean, CamelContextAware, Endpoint, IsSingleton, Service, ShutdownableService, HasId, StatefulService, SuspendableService

@UriEndpoint(scheme="velocity",
             title="Velocity",
             syntax="velocity:resourceUri",
             producerOnly=true,
             label="transformation")
public class VelocityEndpoint
extends ResourceEndpoint

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
VelocityEndpoint()
VelocityEndpoint(String uri, VelocityComponent component, String resourceUri)

Method Summary

Methods

Modifier and Type	Method and Description
protected String	createEndpointUri() A factory method to lazily create the endpointUri if none is specified
VelocityEndpoint	findOrCreateEndpoint(String uri, String newResourceUri)
String	getEncoding()
ExchangePattern	getExchangePattern() Returns the default exchange pattern to use when creating an exchange.
String	getPropertiesFile()
boolean	isLoaderCache()
boolean	isSingleton() Whether this class supports being singleton or not.
protected void	onExchange(Exchange exchange)
void	setEncoding(String encoding) Character encoding of the resource content.
void	setLoaderCache(boolean loaderCache) Enables / disables the velocity resource loader cache which is enabled by default
void	setPropertiesFile(String file) The URI of the properties file which is used for VelocityEngine initialization.
void	setVelocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)

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

clearContentCache, getCamelId, getCamelManagementName, getResourceAsInputStream, getResourceAsInputStreamWithoutCache, getResourceUri, getState, isContentCache, isContentCacheCleared, loadResource, 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, getId, getPollingConsumerQueueSize, hashCode, isLenientProperties, isPollingConsumerBlockWhenFull, isSynchronous, setCamelContext, setConsumerProperties, setEndpointConfiguration, setEndpointUri, setEndpointUriIfNotSpecified, setExchangePattern, 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, 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

VelocityEndpoint

public VelocityEndpoint()

VelocityEndpoint

public VelocityEndpoint(String uri,
                VelocityComponent component,
                String resourceUri)

Method Detail

isSingleton

public boolean isSingleton()

Description copied from interface: IsSingleton

Whether this class supports being singleton or not.

Specified by:

isSingleton in interface IsSingleton

Overrides:

isSingleton in class ProcessorEndpoint

Returns:

true to be a single shared instance, false to create new instances.

getExchangePattern

public ExchangePattern getExchangePattern()

Description copied from class: DefaultEndpoint

Returns the default exchange pattern to use when creating an exchange.

Overrides:

getExchangePattern in class DefaultEndpoint

createEndpointUri

protected String createEndpointUri()

Description copied from class: DefaultEndpoint

A factory method to lazily create the endpointUri if none is specified

Overrides:

createEndpointUri in class DefaultEndpoint

setVelocityEngine

public void setVelocityEngine(org.apache.velocity.app.VelocityEngine velocityEngine)

isLoaderCache

public boolean isLoaderCache()

setLoaderCache

public void setLoaderCache(boolean loaderCache)

Enables / disables the velocity resource loader cache which is enabled by default

setEncoding

public void setEncoding(String encoding)

Character encoding of the resource content.

getEncoding

public String getEncoding()

setPropertiesFile

public void setPropertiesFile(String file)

The URI of the properties file which is used for VelocityEngine initialization.

getPropertiesFile

public String getPropertiesFile()

findOrCreateEndpoint

public VelocityEndpoint findOrCreateEndpoint(String uri,
                                    String newResourceUri)

onExchange

protected void onExchange(Exchange exchange)
                   throws Exception

Overrides:

onExchange in class ProcessorEndpoint

Throws:

Exception