Package org.frankframework.xcom

Class XComSender

java.lang.Object
org.frankframework.senders.AbstractSender
org.frankframework.senders.AbstractSenderWithParameters
org.frankframework.xcom.XComSender
All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle
public class XComSender extends AbstractSenderWithParameters
XCom client voor het versturen van files via XCom.
Author:
John Dekker

  • Constructor Details

    • XComSender

      public XComSender()

  • 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.

    • isSynchronous

      public boolean isSynchronous()
      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, 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.

      Throws:
      SenderException
      TimeoutException

    • setFileOption

      public void setFileOption(XComSender.FileOptionType newVal)
      one of create, append or replace

    • setRemoteDirectory

      public void setRemoteDirectory(String string)
      remote directory is prefixed witht the remote file

    • setCarriageflag

      public void setCarriageflag(XComSender.CarriageFlagType value)

    • setCodeflag

      public void setCodeflag(XComSender.CodeType value)
      characterset conversion

    • setCompress

      public void setCompress(XComSender.CompressType value)

    • setLogfile

      public void setLogfile(String string)
      name of logfile for xcomtcp to be used

    • setPassword

      public void setPassword(String string)
      password of user on remote system

    • setPort

      public void setPort(String string)
      port of remote host

    • setQueue

      public void setQueue(Boolean b)
      set queue off or on

    • setRemoteSystem

      public void setRemoteSystem(String string)
      hostname or tcpip adres of remote host

    • setTracelevel

      public void setTracelevel(Integer i)
      set between 0 (no trace) and 10

    • setTruncation

      public void setTruncation(Boolean b)
      set truncation off or on

    • setUserid

      public void setUserid(String string)
      loginname of user on remote system

    • setRemoteFilePattern

      public void setRemoteFilePattern(String string)
      remote file to create. if empty, the name is equal to the local file

    • setWorkingDirName

      @Mandatory public void setWorkingDirName(String string)
      directory in which to run the xcomtcp command

    • setXcomtcp

      public void setXcomtcp(String string)
      path to xcomtcp command

    • setConfigFile

      public void setConfigFile(String string)

    • setAuthAlias

      public void setAuthAlias(String string)
      name of the alias to obtain credentials to authenticatie on remote server