nl.nn.adapterframework.scheduler

Class SchedulerSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.scheduler.SchedulerSender

All Implemented Interfaces:

IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class SchedulerSender
extends SenderWithParametersBase

Registers a trigger in the scheduler so that the message is send to a javalistener at a scheduled time.

Author:

John Dekker

Field Summary

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
SchedulerSender()

Method Summary

Modifier and Type	Method and Description
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
SchedulerHelper	getSchedulerHelper()
boolean	isSynchronous() When true, the result of sendMessage is the reply of the request.
void	open() This method will be called to start the sender.
Message	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
void	setCronExpressionPattern(String string)
void	setJavaListener(String string)
void	setJobGroup(String string)
void	setJobNamePattern(String string)
void	setSchedulerHelper(SchedulerHelper helper)

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

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue

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

close, createBean, getLogPrefix, getName, 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.core.ISender

close

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

SchedulerSender

public SchedulerSender()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class SenderWithParametersBase

Throws:

ConfigurationException

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 SenderBase

Throws:

SenderException

isSynchronous

public boolean isSynchronous()

Description copied from interface: ISender

When true, the result of sendMessage is the reply of the request.

Specified by:

isSynchronous in interface ISender

Overrides:

isSynchronous in class SenderBase

sendMessage

public Message 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.

Throws:

SenderException

setCronExpressionPattern

@IbisDoc(value={"expression that generates the cron trigger",""})
public void setCronExpressionPattern(String string)

setJobGroup

@IbisDoc(value={"job group in which the new trigger is to be created (optional)",""})
public void setJobGroup(String string)

setJobNamePattern

@IbisDoc(value={"pattern that leads to the name of the registered trigger(optional)",""})
public void setJobNamePattern(String string)

setJavaListener

@IbisDoc(value={"java listener to be called when scheduler trigger fires",""})
public void setJavaListener(String string)

getSchedulerHelper

public SchedulerHelper getSchedulerHelper()

setSchedulerHelper

public void setSchedulerHelper(SchedulerHelper helper)