org.apache.camel.component.language

Class LanguageEndpoint

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.language.LanguageEndpoint

All Implemented Interfaces:

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

@UriEndpoint(firstVersion="2.5.0",
             scheme="language",
             title="Language",
             syntax="language:languageName:resourceUri",
             producerOnly=true,
             label="core,script")
public class LanguageEndpoint
extends ResourceEndpoint

The language component allows you to send a message to an endpoint which executes a script by any of the supported Languages in Camel. By having a component to execute language scripts, it allows more dynamic routing capabilities. For example by using the Routing Slip or Dynamic Router EIPs you can send messages to language endpoints where the script is dynamic defined as well. This component is provided out of the box in camel-core and hence no additional JARs is needed. You only have to include additional Camel components if the language of choice mandates it, such as using Groovy or JavaScript languages.

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
LanguageEndpoint()
LanguageEndpoint(String endpointUri, Component component, Language language, Expression expression, String resourceUri)

Method Summary

Modifier and Type	Method and Description
void	clearContentCache()
Consumer	createConsumer(Processor processor) Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor
protected String	createEndpointUri() A factory method to lazily create the endpointUri if none is specified
Producer	createProducer() Creates a new producer which is used send messages into the endpoint
Expression	getExpression()
Language	getLanguage()
String	getResourceUri()
String	getScript()
boolean	isBinary()
boolean	isCacheScript()
boolean	isContentResolvedFromResource()
boolean	isSingleton() Whether this class supports being singleton or not.
boolean	isTransform()
protected String	resolveScript(String script) Resolves the script.
void	setBinary(boolean binary) Whether the script is binary content or text content.
void	setCacheScript(boolean cacheScript) Whether to cache the compiled script and reuse Notice reusing the script can cause side effects from processing one Camel Exchange to the next Exchange.
void	setContentResolvedFromResource(boolean contentResolvedFromResource)
void	setExpression(Expression expression)
void	setLanguageName(String languageName) Sets the name of the language to use
void	setResourceUri(String resourceUri) Path to the resource, or a reference to lookup a bean in the Registry to use as the resource
void	setScript(String script) Sets the script to execute
void	setTransform(boolean transform) Whether or not the result of the script should be used as message body.

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

getCamelId, getCamelManagementName, getResourceAsInputStream, getResourceAsInputStreamWithoutCache, getState, isContentCache, isContentCacheCleared, loadResource, setContentCache

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

createPollingConsumer, createProcessor, getProcessor, onExchange, setProcessor

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, getExchangePattern, 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

LanguageEndpoint

public LanguageEndpoint()

LanguageEndpoint

public LanguageEndpoint(String endpointUri,
                        Component component,
                        Language language,
                        Expression expression,
                        String resourceUri)

Method Detail

createProducer

public Producer createProducer()
                        throws Exception

Description copied from interface: Endpoint

Creates a new producer which is used send messages into the endpoint

Specified by:

createProducer in interface Endpoint

Overrides:

createProducer in class ProcessorEndpoint

Returns:

a newly created producer

Throws:

Exception - can be thrown

createConsumer

public Consumer createConsumer(Processor processor)
                        throws Exception

Description copied from interface: Endpoint

Creates a new Event Driven Consumer which consumes messages from the endpoint using the given processor

Specified by:

createConsumer in interface Endpoint

Overrides:

createConsumer in class DefaultPollingEndpoint

Parameters:

processor - the given processor

Returns:

a newly created consumer

Throws:

Exception - can be thrown

resolveScript

protected String resolveScript(String script)
                        throws IOException

Resolves the script.

Parameters:

script - script or uri for a script to load

Returns:

the script

Throws:

IOException - is thrown if error loading the script

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.

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

getLanguage

public Language getLanguage()

getExpression

public Expression getExpression()

setExpression

public void setExpression(Expression expression)

isTransform

public boolean isTransform()

setTransform

public void setTransform(boolean transform)

Whether or not the result of the script should be used as message body.

This options is default true.

Parameters:

transform - true to use result as new message body, false to keep the existing message body

isBinary

public boolean isBinary()

setBinary

public void setBinary(boolean binary)

Whether the script is binary content or text content.

By default the script is read as text content (eg java.lang.String)

Parameters:

binary - true to read the script as binary, instead of text based.

setLanguageName

public void setLanguageName(String languageName)

Sets the name of the language to use

Parameters:

languageName - the name of the language

setResourceUri

public void setResourceUri(String resourceUri)

Path to the resource, or a reference to lookup a bean in the Registry to use as the resource

Overrides:

setResourceUri in class ResourceEndpoint

Parameters:

resourceUri - the resource path

getResourceUri

public String getResourceUri()

Overrides:

getResourceUri in class ResourceEndpoint

setScript

public void setScript(String script)

Sets the script to execute

Parameters:

script - the script

getScript

public String getScript()

isContentResolvedFromResource

public boolean isContentResolvedFromResource()

setContentResolvedFromResource

public void setContentResolvedFromResource(boolean contentResolvedFromResource)

isCacheScript

public boolean isCacheScript()

setCacheScript

public void setCacheScript(boolean cacheScript)

Whether to cache the compiled script and reuse

Notice reusing the script can cause side effects from processing one Camel Exchange to the next Exchange.

clearContentCache

public void clearContentCache()

Specified by:

clearContentCache in interface ManagedResourceEndpointMBean

Overrides:

clearContentCache in class ResourceEndpoint