org.apache.camel.builder.script

Class ScriptBuilder

java.lang.Object

org.apache.camel.support.ServiceSupport

org.apache.camel.builder.script.ScriptBuilder

All Implemented Interfaces:

org.apache.camel.Expression, org.apache.camel.Predicate, org.apache.camel.Processor, org.apache.camel.Service, org.apache.camel.ShutdownableService, org.apache.camel.StatefulService, org.apache.camel.SuspendableService

public class ScriptBuilder
extends org.apache.camel.support.ServiceSupport
implements org.apache.camel.Expression, org.apache.camel.Predicate, org.apache.camel.Processor

A builder class for creating Processor, Expression and Predicate objects using the JSR 223 scripting engine.

Version:

Field Summary

Fields

Modifier and Type	Field and Description
static String	ARGUMENTS Additional arguments to ScriptEngine provided as a header on the IN Message using the key ARGUMENTS

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

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

Constructor Summary

Constructors

Constructor and Description
ScriptBuilder(String scriptEngineName) Constructor.
ScriptBuilder(String scriptEngineName, String scriptText) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addScriptEngineArguments(ScriptEngine engine, org.apache.camel.Exchange exchange)
void	assertMatches(String text, org.apache.camel.Exchange exchange)
ScriptBuilder	attribute(String name, Object value) Sets the attribute on the context so that it is available to the script as a variable in the ScriptContext.ENGINE_SCOPE
protected void	checkInitialised(org.apache.camel.Exchange exchange)
protected void	compileScript(Compilable compilable, org.apache.camel.Exchange exchange)
protected ScriptEvaluationException	createScriptCompileException(Exception e)
protected ScriptEngine	createScriptEngine()
protected ScriptEvaluationException	createScriptEvaluationException(Throwable e)
protected InputStreamReader	createScriptReader(org.apache.camel.Exchange exchange)
protected void	doStart()
protected void	doStop()
Object	evaluate(org.apache.camel.Exchange exchange)
<T> T	evaluate(org.apache.camel.Exchange exchange, Class<T> type)
protected Object	evaluateScript(org.apache.camel.Exchange exchange)
CompiledScript	getCompiledScript()
ScriptEngine	getEngine()
ScriptContext	getScriptContext() Access the script context so that it can be configured such as adding attributes
String	getScriptDescription() Returns a description of the script
String	getScriptEngineName()
String	getScriptText()
static ScriptBuilder	groovy(String scriptText) Creates a script builder for the groovy script contents
protected boolean	isBeanShell()
protected boolean	isPython()
static ScriptBuilder	javaScript(String scriptText) Creates a script builder for the JavaScript/ECMAScript script contents
boolean	matches(org.apache.camel.Exchange exchange)
protected boolean	matches(org.apache.camel.Exchange exchange, Object scriptValue)
static ScriptBuilder	php(String scriptText) Creates a script builder for the PHP script contents
protected void	populateBindings(ScriptEngine engine, org.apache.camel.Exchange exchange)
void	process(org.apache.camel.Exchange exchange)
static ScriptBuilder	python(String scriptText) Creates a script builder for the Python script contents
static ScriptBuilder	ruby(String scriptText) Creates a script builder for the Ruby/JRuby script contents
protected Object	runScript(org.apache.camel.Exchange exchange)
static ScriptBuilder	script(String language, String scriptText) Creates a script builder for the named language and script contents
void	setScriptContext(ScriptContext scriptContext) Sets the context to use by the script
void	setScriptText(String scriptText)
String	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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ARGUMENTS

public static final String ARGUMENTS

Additional arguments to ScriptEngine provided as a header on the IN Message using the key ARGUMENTS

See Also:

Constant Field Values

Constructor Detail

ScriptBuilder

public ScriptBuilder(String scriptEngineName)

Constructor.

Parameters:

scriptEngineName - the name of the scripting language

ScriptBuilder

public ScriptBuilder(String scriptEngineName,
             String scriptText)

Constructor.

Parameters:

scriptEngineName - the name of the scripting language

scriptText - the script text to be evaluated, or a reference to a script resource

Method Detail

toString

public String toString()

Overrides:

toString in class Object

evaluate

public Object evaluate(org.apache.camel.Exchange exchange)

evaluate

public <T> T evaluate(org.apache.camel.Exchange exchange,
             Class<T> type)

Specified by:

evaluate in interface org.apache.camel.Expression

matches

public boolean matches(org.apache.camel.Exchange exchange)

Specified by:

matches in interface org.apache.camel.Predicate

assertMatches

public void assertMatches(String text,
                 org.apache.camel.Exchange exchange)
                   throws AssertionError

Throws:

AssertionError

process

public void process(org.apache.camel.Exchange exchange)

Specified by:

process in interface org.apache.camel.Processor

attribute

public ScriptBuilder attribute(String name,
                      Object value)

Sets the attribute on the context so that it is available to the script as a variable in the ScriptContext.ENGINE_SCOPE

Parameters:

name - the name of the attribute

value - the attribute value

Returns:

this builder

script

public static ScriptBuilder script(String language,
                   String scriptText)

Creates a script builder for the named language and script contents

Parameters:

language - the language to use for the script

scriptText - the script text to be evaluated, or a reference to a script resource

Returns:

the builder

groovy

public static ScriptBuilder groovy(String scriptText)

Creates a script builder for the groovy script contents

Parameters:

scriptText - the script text to be evaluated, or a reference to a script resource

Returns:

the builder

javaScript

public static ScriptBuilder javaScript(String scriptText)

Creates a script builder for the JavaScript/ECMAScript script contents

Parameters:

scriptText - the script text to be evaluated, or a reference to a script resource

Returns:

the builder

php

public static ScriptBuilder php(String scriptText)

Creates a script builder for the PHP script contents

Parameters:

scriptText - the script text to be evaluated, or a reference to a script resource

Returns:

the builder

python

public static ScriptBuilder python(String scriptText)

Creates a script builder for the Python script contents

Parameters:

scriptText - the script text to be evaluated, or a reference to a script resource

Returns:

the builder

ruby

public static ScriptBuilder ruby(String scriptText)

Creates a script builder for the Ruby/JRuby script contents

Parameters:

scriptText - the script text to be evaluated, or a reference to a script resource

Returns:

the builder

getEngine

public ScriptEngine getEngine()

getCompiledScript

public CompiledScript getCompiledScript()

getScriptText

public String getScriptText()

setScriptText

public void setScriptText(String scriptText)

getScriptEngineName

public String getScriptEngineName()

getScriptDescription

public String getScriptDescription()

Returns a description of the script

Returns:

the script description

getScriptContext

public ScriptContext getScriptContext()

Access the script context so that it can be configured such as adding attributes

setScriptContext

public void setScriptContext(ScriptContext scriptContext)

Sets the context to use by the script

checkInitialised

protected void checkInitialised(org.apache.camel.Exchange exchange)

matches

protected boolean matches(org.apache.camel.Exchange exchange,
              Object scriptValue)

createScriptEngine

protected ScriptEngine createScriptEngine()

compileScript

protected void compileScript(Compilable compilable,
                 org.apache.camel.Exchange exchange)

evaluateScript

protected Object evaluateScript(org.apache.camel.Exchange exchange)

runScript

protected Object runScript(org.apache.camel.Exchange exchange)
                    throws ScriptException,
                           IOException

Throws:

ScriptException

IOException

populateBindings

protected void populateBindings(ScriptEngine engine,
                    org.apache.camel.Exchange exchange)

addScriptEngineArguments

protected void addScriptEngineArguments(ScriptEngine engine,
                            org.apache.camel.Exchange exchange)

createScriptReader

protected InputStreamReader createScriptReader(org.apache.camel.Exchange exchange)
                                        throws IOException

Throws:

IOException

createScriptCompileException

protected ScriptEvaluationException createScriptCompileException(Exception e)

createScriptEvaluationException

protected ScriptEvaluationException createScriptEvaluationException(Throwable e)

isPython

protected boolean isPython()

isBeanShell

protected boolean isBeanShell()

doStart

protected void doStart()
                throws Exception

Specified by:

doStart in class org.apache.camel.support.ServiceSupport

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Specified by:

doStop in class org.apache.camel.support.ServiceSupport

Throws:

Exception