Package org.frankframework.scheduler

Class SchedulerSender

java.lang.Object
org.frankframework.senders.AbstractSender
org.frankframework.senders.AbstractSenderWithParameters
org.frankframework.scheduler.SchedulerSender
All Implemented Interfaces:
IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
@Deprecated(forRemoval=true, since="9.0") public class SchedulerSender extends AbstractSenderWithParameters
Deprecated, for removal: This API element is subject to removal in a future version.
Registers a trigger in the scheduler so that the message is sent to a JavaListener at a scheduled time.
Author:
John Dekker

  • Constructor Details

    • SchedulerSender

      public SchedulerSender()
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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 AbstractSenderWithParameters
      Throws:
      ConfigurationException

    • start

      public void start()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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:
      start in interface ISender
      Overrides:
      start in class AbstractSender

    • isSynchronous

      public boolean isSynchronous()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: ISender
      When true, the result of sendMessage is the reply of the request.

    • sendMessage

      @Nonnull public SenderResult sendMessage(@Nonnull Message message, @Nonnull PipeLineSession session) throws SenderException
      Deprecated, for removal: This API element is subject to removal in a future version.
      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:

       synchronousa-synchronous
      ISender.isSynchronous() returnstruefalse
      return value of sendMessage() isthe reply-messagethe messageId of the message sent
      the correlationID specified with sendMessage()may be ignoredis sent with the message
      a {link TimeOutException}may be thrown if a timeout occurs waiting for a replyshould 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

      public void setCronExpressionPattern(String string)
      Deprecated, for removal: This API element is subject to removal in a future version.
      expression that generates the cron trigger

    • setJobGroup

      public void setJobGroup(String string)
      Deprecated, for removal: This API element is subject to removal in a future version.
      job group in which the new trigger is to be created (optional)

    • setJobNamePattern

      public void setJobNamePattern(String string)
      Deprecated, for removal: This API element is subject to removal in a future version.
      pattern that leads to the name of the registered trigger(optional)

    • setJavaListener

      public void setJavaListener(String string)
      Deprecated, for removal: This API element is subject to removal in a future version.
      java listener to be called when scheduler trigger fires

    • getSchedulerHelper

      public SchedulerHelper getSchedulerHelper()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • setSchedulerHelper

      public void setSchedulerHelper(SchedulerHelper helper)
      Deprecated, for removal: This API element is subject to removal in a future version.