org.apache.camel.builder.script
Class ScriptBuilder

java.lang.Object
  extended by org.apache.camel.builder.script.ScriptBuilder
All Implemented Interfaces:
Expression, Predicate, Processor

public class ScriptBuilder
extends Object
implements Expression, Predicate, Processor

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

Version:

Constructor Summary
ScriptBuilder(String scriptEngineName)
           
ScriptBuilder(String scriptEngineName, org.springframework.core.io.Resource scriptResource)
           
ScriptBuilder(String scriptEngineName, String scriptText)
           
 
Method Summary
 void assertMatches(String text, 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()
           
protected  void compileScript(Compilable compilable)
           
protected  ScriptEvaluationException createScriptCompileException(Exception e)
           
protected  ScriptEngine createScriptEngine()
           
protected  ScriptEvaluationException createScriptEvaluationException(Throwable e)
           
protected  InputStreamReader createScriptReader()
           
 Object evaluate(Exchange exchange)
           
<T> T
evaluate(Exchange exchange, Class<T> type)
          Returns the value of the expression on the given exchange
protected  Object evaluateScript(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()
           
 org.springframework.core.io.Resource getScriptResource()
           
 String getScriptText()
           
static ScriptBuilder groovy(File scriptFile)
          Creates a script builder for the groovy script File
static ScriptBuilder groovy(org.springframework.core.io.Resource scriptResource)
          Creates a script builder for the groovy script Resource
static ScriptBuilder groovy(String scriptText)
          Creates a script builder for the groovy script contents
static ScriptBuilder groovy(URL scriptURL)
          Creates a script builder for the groovy script URL
protected  boolean isBeanShell()
           
protected  boolean isPython()
           
static ScriptBuilder javaScript(File scriptFile)
          Creates a script builder for the JavaScript/ECMAScript script File
static ScriptBuilder javaScript(org.springframework.core.io.Resource scriptResource)
          Creates a script builder for the JavaScript/ECMAScript script
static ScriptBuilder javaScript(String scriptText)
          Creates a script builder for the JavaScript/ECMAScript script contents
static ScriptBuilder javaScript(URL scriptURL)
          Creates a script builder for the JavaScript/ECMAScript script URL
 boolean matches(Exchange exchange)
          Evaluates the predicate on the message exchange and returns true if this exchange matches the predicate
protected  boolean matches(Exchange exchange, Object scriptValue)
           
static ScriptBuilder php(File scriptFile)
          Creates a script builder for the PHP script File
static ScriptBuilder php(org.springframework.core.io.Resource scriptResource)
          Creates a script builder for the PHP script Resource
static ScriptBuilder php(String scriptText)
          Creates a script builder for the PHP script contents
static ScriptBuilder php(URL scriptURL)
          Creates a script builder for the PHP script URL
protected  void populateBindings(ScriptEngine engine, Exchange exchange)
           
 void process(Exchange exchange)
          Processes the message exchange
static ScriptBuilder python(File scriptFile)
          Creates a script builder for the Python script File
static ScriptBuilder python(org.springframework.core.io.Resource scriptResource)
          Creates a script builder for the Python script Resource
static ScriptBuilder python(String scriptText)
          Creates a script builder for the Python script contents
static ScriptBuilder python(URL scriptURL)
          Creates a script builder for the Python script URL
static ScriptBuilder ruby(File scriptFile)
          Creates a script builder for the Ruby/JRuby script File
static ScriptBuilder ruby(org.springframework.core.io.Resource scriptResource)
          Creates a script builder for the Ruby/JRuby script Resource
static ScriptBuilder ruby(String scriptText)
          Creates a script builder for the Ruby/JRuby script contents
static ScriptBuilder ruby(URL scriptURL)
          Creates a script builder for the Ruby/JRuby script URL
protected  Object runScript()
           
static ScriptBuilder script(String language, File scriptFile)
          Creates a script builder for the named language and script File
static ScriptBuilder script(String language, org.springframework.core.io.Resource scriptResource)
          Creates a script builder for the named language and script Resource
static ScriptBuilder script(String language, String scriptText)
          Creates a script builder for the named language and script contents
static ScriptBuilder script(String language, URL scriptURL)
          Creates a script builder for the named language and script URL
 void setScriptContext(ScriptContext scriptContext)
          Sets the context to use by the script
 void setScriptResource(org.springframework.core.io.Resource scriptResource)
           
 void setScriptText(String scriptText)
           
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ScriptBuilder

public ScriptBuilder(String scriptEngineName)

ScriptBuilder

public ScriptBuilder(String scriptEngineName,
                     String scriptText)

ScriptBuilder

public ScriptBuilder(String scriptEngineName,
                     org.springframework.core.io.Resource scriptResource)
Method Detail

toString

public String toString()
Overrides:
toString in class Object

evaluate

public Object evaluate(Exchange exchange)

evaluate

public <T> T evaluate(Exchange exchange,
                      Class<T> type)
Description copied from interface: Expression
Returns the value of the expression on the given exchange

Specified by:
evaluate in interface Expression
Parameters:
exchange - the message exchange on which to evaluate the expression
type - the expected type of the evaluation result
Returns:
the value of the expression

matches

public boolean matches(Exchange exchange)
Description copied from interface: Predicate
Evaluates the predicate on the message exchange and returns true if this exchange matches the predicate

Specified by:
matches in interface Predicate
Parameters:
exchange - the message exchange
Returns:
true if the predicate matches

assertMatches

public void assertMatches(String text,
                          Exchange exchange)
                   throws AssertionError
Throws:
AssertionError

process

public void process(Exchange exchange)
Description copied from interface: Processor
Processes the message exchange

Specified by:
process in interface Processor
Parameters:
exchange - the message exchange

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
Returns:
the builder

script

public static ScriptBuilder script(String language,
                                   org.springframework.core.io.Resource scriptResource)
Creates a script builder for the named language and script Resource

Parameters:
language - the language to use for the script
scriptResource - the resource used to load the script
Returns:
the builder

script

public static ScriptBuilder script(String language,
                                   File scriptFile)
Creates a script builder for the named language and script File

Parameters:
language - the language to use for the script
scriptFile - the file used to load the script
Returns:
the builder

script

public static ScriptBuilder script(String language,
                                   URL scriptURL)
Creates a script builder for the named language and script URL

Parameters:
language - the language to use for the script
scriptURL - the URL used to load the script
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
Returns:
the builder

groovy

public static ScriptBuilder groovy(org.springframework.core.io.Resource scriptResource)
Creates a script builder for the groovy script Resource

Parameters:
scriptResource - the resource used to load the script
Returns:
the builder

groovy

public static ScriptBuilder groovy(File scriptFile)
Creates a script builder for the groovy script File

Parameters:
scriptFile - the file used to load the script
Returns:
the builder

groovy

public static ScriptBuilder groovy(URL scriptURL)
Creates a script builder for the groovy script URL

Parameters:
scriptURL - the URL used to load the script
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
Returns:
the builder

javaScript

public static ScriptBuilder javaScript(org.springframework.core.io.Resource scriptResource)
Creates a script builder for the JavaScript/ECMAScript script

Parameters:
scriptResource - the resource used to load the script
Returns:
the builder

javaScript

public static ScriptBuilder javaScript(File scriptFile)
Creates a script builder for the JavaScript/ECMAScript script File

Parameters:
scriptFile - the file used to load the script
Returns:
the builder

javaScript

public static ScriptBuilder javaScript(URL scriptURL)
Creates a script builder for the JavaScript/ECMAScript script URL

Parameters:
scriptURL - the URL used to load the script
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
Returns:
the builder

php

public static ScriptBuilder php(org.springframework.core.io.Resource scriptResource)
Creates a script builder for the PHP script Resource

Parameters:
scriptResource - the resource used to load the script
Returns:
the builder

php

public static ScriptBuilder php(File scriptFile)
Creates a script builder for the PHP script File

Parameters:
scriptFile - the file used to load the script
Returns:
the builder

php

public static ScriptBuilder php(URL scriptURL)
Creates a script builder for the PHP script URL

Parameters:
scriptURL - the URL used to load the script
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
Returns:
the builder

python

public static ScriptBuilder python(org.springframework.core.io.Resource scriptResource)
Creates a script builder for the Python script Resource

Parameters:
scriptResource - the resource used to load the script
Returns:
the builder

python

public static ScriptBuilder python(File scriptFile)
Creates a script builder for the Python script File

Parameters:
scriptFile - the file used to load the script
Returns:
the builder

python

public static ScriptBuilder python(URL scriptURL)
Creates a script builder for the Python script URL

Parameters:
scriptURL - the URL used to load the script
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
Returns:
the builder

ruby

public static ScriptBuilder ruby(org.springframework.core.io.Resource scriptResource)
Creates a script builder for the Ruby/JRuby script Resource

Parameters:
scriptResource - the resource used to load the script
Returns:
the builder

ruby

public static ScriptBuilder ruby(File scriptFile)
Creates a script builder for the Ruby/JRuby script File

Parameters:
scriptFile - the file used to load the script
Returns:
the builder

ruby

public static ScriptBuilder ruby(URL scriptURL)
Creates a script builder for the Ruby/JRuby script URL

Parameters:
scriptURL - the URL used to load the script
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


getScriptResource

public org.springframework.core.io.Resource getScriptResource()

setScriptResource

public void setScriptResource(org.springframework.core.io.Resource scriptResource)

checkInitialised

protected void checkInitialised()

matches

protected boolean matches(Exchange exchange,
                          Object scriptValue)

createScriptEngine

protected ScriptEngine createScriptEngine()

compileScript

protected void compileScript(Compilable compilable)

evaluateScript

protected Object evaluateScript(Exchange exchange)

runScript

protected Object runScript()
                    throws ScriptException,
                           IOException
Throws:
ScriptException
IOException

populateBindings

protected void populateBindings(ScriptEngine engine,
                                Exchange exchange)

createScriptReader

protected InputStreamReader createScriptReader()
                                        throws IOException
Throws:
IOException

createScriptCompileException

protected ScriptEvaluationException createScriptCompileException(Exception e)

createScriptEvaluationException

protected ScriptEvaluationException createScriptEvaluationException(Throwable e)

isPython

protected boolean isPython()

isBeanShell

protected boolean isBeanShell()


Apache CAMEL