Package org.frankframework.core

Interface ISender

All Superinterfaces:
org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, NameAware
All Known Subinterfaces:
IBlockEnabledSender<H>, ICorrelatedSender, ISapSender, ISenderWithParameters
All Known Implementing Classes:
AbstractBlockEnabledSender, AbstractCollectorSender, AbstractFileSystemSender, AbstractHttpSender, AbstractJdbcQuerySender, AbstractJdbcSender, AbstractMailSender, AbstractSender, AbstractSenderWithParameters, AbstractSenderWrapper, Afm2EdiFactSender, AmazonS3Sender, AmqpSender, BisJmsSender, CmisHttpSender, CmisSender, CommandSender, DelaySender, DirectQuerySender, EchoSender, EsbJmsSender, ExchangeFileSystemSender, ExchangeFolderSender, FileSystemSenderWithAttachments, FixedQuerySender, FixedResultSender, FrankSender, FtpFileSystemSender, HttpSender, IbisJavaSender, IbisLocalSender, IdinSender, IdocSender, IdocSender, IdocSenderImpl, ImapSender, IMSSender, JavascriptSender, JdbcIteratingPipeBase.MixedQuerySender, JmsSender, JsonXsltSender, KafkaSender, LdapSender, LocalFileSystemSender, LogSender, MailSender, MessageStoreSender, MongoDbSender, MQSender, MqttSender, MsalClientAdapter, NetStorageSender, ParallelSenders, ReconnectSenderWrapper, ReloadSender, ResultSet2FileSender, Samba1Sender, Samba2Sender, SapSender, SapSender, SapSenderBase, SapSenderImpl, SenderSeries, SenderWrapper, SendGridSender, SendMessageJob.SendMessageJobSender, SftpFileSystemSender, ShadowSender, StoredProcedureQuerySender, WebServiceNtlmSender, WebServiceSender, XComSender, XfbSender, XmlJmsBrowserSender, XmlQuerySender, XmlValidatorSender, XsltSender, ZipWriterSender
@FrankDocGroup(SENDER) @EnterpriseIntegrationPattern(ENDPOINT) public interface ISender extends IConfigurable, FrankElement, NameAware
Marks an implementation as responsible for sending a message to some destination.
Author:
Gerrit van Brakel

  • Method Details

    • start

      void start()
      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.

    • stop

      void stop()
      Stop/close the sender and deallocate resources.

    • isSynchronous

      default boolean isSynchronous()
      When true, the result of sendMessage is the reply of the request.

    • sendMessage

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

    • sendMessageOrThrow

      @Nonnull default Message sendMessageOrThrow(@Nonnull Message message, @Nonnull PipeLineSession session) throws SenderException, TimeoutException
      Throws:
      SenderException
      TimeoutException

    • consumesSessionVariable

      default boolean consumesSessionVariable(String sessionKey)
      returns true if the sender or one of its children use the named session variable. Callers can use this to determine if a message needs to be preserved.