Package org.frankframework.senders

Class AbstractSenderWrapper

java.lang.Object
org.frankframework.senders.AbstractSender
org.frankframework.senders.AbstractSenderWithParameters
org.frankframework.senders.AbstractSenderWrapper
All Implemented Interfaces:
ICacheEnabled<String,String>, FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle
Direct Known Subclasses:
ReconnectSenderWrapper, SenderSeries, SenderWrapper
public abstract class AbstractSenderWrapper extends AbstractSenderWithParameters implements ICacheEnabled<String,String>
Baseclass for Wrappers for senders, that allows to get input from a session variable, and to store output in a session variable.
Since:
4.9
Author:
Gerrit van Brakel

  • Field Details

  • Constructor Details

    • AbstractSenderWrapper

      public AbstractSenderWrapper()

  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Description copied from interface: IConfigurable
      Configure this component.

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

      In the case of a container, this will propagate the configure signal to all components that apply.

      Specified by:
      configure in interface IConfigurable
      Overrides:
      configure in class AbstractSenderWithParameters
      Throws:
      ConfigurationException - in case it was not able to configure the component.

    • start

      public void start()
      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
      Specified by:
      start in interface org.springframework.context.Lifecycle
      Overrides:
      start in class AbstractSender

    • stop

      public void stop()
      Description copied from interface: ISender
      Stop/close the sender and deallocate resources.
      Specified by:
      stop in interface ISender
      Specified by:
      stop in interface org.springframework.context.Lifecycle
      Overrides:
      stop in class AbstractSender

    • setName

      public void setName(String name)
      Description copied from class: AbstractSender
      name of the sender
      Specified by:
      setName in interface NameAware
      Overrides:
      setName in class AbstractSender

    • isSenderConfigured

      protected abstract boolean isSenderConfigured()

    • doSendMessage

      public abstract SenderResult doSendMessage(@Nonnull Message message, @Nonnull PipeLineSession session) throws SenderException, TimeoutException
      Throws:
      SenderException
      TimeoutException

    • sendMessage

      @Nonnull public SenderResult sendMessage(@Nonnull Message message, @Nonnull PipeLineSession session) throws SenderException, TimeoutException
      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.

      Specified by:
      sendMessage in interface ISender
      Throws:
      SenderException
      TimeoutException

    • setGetInputFromSessionKey

      public void setGetInputFromSessionKey(String string)
      If set, input is taken from this session key, instead of regular input

    • setGetInputFromFixedValue

      public void setGetInputFromFixedValue(String string)
      If set, this fixed value is taken as input, instead of regular input

    • setPreserveInput

      public void setPreserveInput(boolean preserveInput)
      If true, the input of a pipe is restored before processing the next one
      Default value
      false

    • setStoreResultInSessionKey

      public void setStoreResultInSessionKey(String string)
      If set, the result is stored under this session key

    • setStoreInputInSessionKey

      public void setStoreInputInSessionKey(String string)
      If set, the input is stored under this session key