nl.nn.adapterframework.senders

Class JavascriptSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.senders.SenderWrapperBase

nl.nn.adapterframework.senders.SenderSeries

nl.nn.adapterframework.senders.JavascriptSender

All Implemented Interfaces:

ICacheEnabled<String,String>, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Category(value="Advanced")
public class JavascriptSender
extends SenderSeries

Sender used to run javascript code using J2V8 or Rhino This sender can execute a function of a given javascript file, the result of the function will be the output of the sender. The parameters of the javascript function to run are given as parameters by the adapter configuration The sender doesn't accept nor uses the given input, instead for each argument for the jsFunctionName method, you will need to create a parameter on the sender. It is recommended to have the result of the javascript function be of type String, as the output of the sender will be of type String.

Since:

7.4

Author:

Jarno Huibers

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JavascriptSender.JavaScriptEngines

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields inherited from class nl.nn.adapterframework.senders.SenderWrapperBase

senderWrapperProcessor

Fields inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class nl.nn.adapterframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor and Description
JavascriptSender()

Method Summary

Modifier and Type	Method and Description
protected boolean	isSenderConfigured()
void	open() This method will be called to start the sender.
SenderResult	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
void	setEngineName(JavascriptSender.JavaScriptEngines engineName) the name of the javascript engine to be used
void	setJsFileName(String jsFileName) the name of the javascript file containing the functions to run
void	setJsFunctionName(String jsFunctionName) the name of the javascript function that will be called (first)

Methods inherited from class nl.nn.adapterframework.senders.SenderSeries

close, configure, consumesSessionVariable, doSendMessage, getSenders, getStatisticsKeeper, iterateOverStatistics, registerSender, setSender

Methods inherited from class nl.nn.adapterframework.senders.SenderWrapperBase

getLogPrefix, setGetInputFromFixedValue, setGetInputFromSessionKey, setPreserveInput, setStoreInputInSessionKey, setStoreResultInSessionKey

Methods inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

addParameter, checkStringAttributeOrParameter, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList

Methods inherited from class nl.nn.adapterframework.senders.SenderBase

createBean, getName, isSynchronous, setApplicationContext, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface nl.nn.adapterframework.cache.ICacheEnabled

getCache, setCache

Methods inherited from interface nl.nn.adapterframework.core.ISender

isSynchronous, sendMessageOrThrow

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Constructor Detail

JavascriptSender

public JavascriptSender()

Method Detail

isSenderConfigured

protected boolean isSenderConfigured()

Overrides:

isSenderConfigured in class SenderSeries

open

public void open()
          throws SenderException

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

open in interface ISender

Overrides:

open in class SenderSeries

Throws:

SenderException

sendMessage

public SenderResult sendMessage(Message message,
                                PipeLineSession session)
                         throws SenderException

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Specified by:

sendMessage in interface ISender

Overrides:

sendMessage in class SenderWrapperBase

Throws:

SenderException

setJsFileName

public void setJsFileName(String jsFileName)

the name of the javascript file containing the functions to run

setJsFunctionName

public void setJsFunctionName(String jsFunctionName)

the name of the javascript function that will be called (first)

Default value

main

setEngineName

public void setEngineName(JavascriptSender.JavaScriptEngines engineName)

the name of the javascript engine to be used

Default value

J2V8