Class FxfListener

All Implemented Interfaces:
FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, HasSender, IConfigurable, IJmsListener<jakarta.jms.Message>, IKnowsDeliveryCount<jakarta.jms.Message>, IListener<jakarta.jms.Message>, IPortConnectedListener<jakarta.jms.Message>, IPushingListener<jakarta.jms.Message>, IRedeliveringListener<jakarta.jms.Message>, IScopeProvider, IThreadCountControllable, ITransactionRequirements, IWithParameters, IXAEnabled, NameAware, ReceiverAware<jakarta.jms.Message>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

public class FxfListener extends EsbJmsListener
FxF extension of EsbJmsListener.

Configuration (where deviating from EsbJmsListener):

attributesdescriptiondefault
destinationNamename of the JMS destination (queue or topic) to use"jms/FileTransferAction"
jmsRealm "qcf_tibco_p2p_ff"
messageProtocolprotocol of ESB service to be called. Possible values
  • "FF": Fire & Forget protocol
  • "RR": Request-Reply protocol
"FF"

Author:
Peter Leeuwenburgh
  • Constructor Details

    • FxfListener

      public FxfListener()
  • 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 EsbJmsListener
      Throws:
      ConfigurationException - in case it was not able to configure the component.
    • afterMessageProcessed

      public void afterMessageProcessed(PipeLineResult plr, RawMessageWrapper<jakarta.jms.Message> rawMessageWrapper, PipeLineSession pipeLineSession) throws ListenerException
      Description copied from interface: IListener
      Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
      Specified by:
      afterMessageProcessed in interface IListener<jakarta.jms.Message>
      Overrides:
      afterMessageProcessed in class EsbJmsListener
      Throws:
      ListenerException
    • setFxfFileSessionKey

      public void setFxfFileSessionKey(String fxfFileSessionKey)
      name of the session key to store the name of the received file in
      Default value
      fxfFile
    • setMoveProcessedFile

      public void setMoveProcessedFile(boolean b)
      If set to true, the received file is moved after being processed
      Default value
      true
    • setProcessedSiblingDirectory

      public void setProcessedSiblingDirectory(String processedSiblingDirectory)
      (only used when moveProcessedFile=true) sibling directory (related to the parent directory of the file to process) where files are stored after being processed
      Default value
      processed
    • setCreateProcessedDirectory

      public void setCreateProcessedDirectory(boolean b)
      (only used when moveProcessedFile=true) when set to true, the directory to move processed files in is created if it does not exist
      Default value
      false