Package org.frankframework.extensions.fxf

Class FxfWrapperPipe

java.lang.Object
org.frankframework.core.TransactionAttributes
org.frankframework.pipes.AbstractPipe
org.frankframework.pipes.FixedForwardPipe
org.frankframework.soap.SoapWrapperPipe
org.frankframework.extensions.esb.EsbSoapWrapperPipe
org.frankframework.extensions.fxf.FxfWrapperPipe
All Implemented Interfaces:
DestinationValidator, FrankElement, HasApplicationContext, HasName, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, IWrapperPipe, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle
public class FxfWrapperPipe extends EsbSoapWrapperPipe
FxF wrapper to be used with FxF3. When receiving files (direction=unwrap) the message handed to the pipeline is the local filename extracted from an ESB SOAP message. When sending files (direction=wrap) input should be a local filename which will be wrapped into an ESB SOAP message. Please note: When writing files which need to be send through FxF they should be written to ${fxf.dir}/NNX00000/out. The property ${fxf.dir} will automatically be available on the DTAP environment (define it in StageSpecifics_LOC.properties only). Replace NNX00000 with the specific flowId and generate a unique filename (files will automatically be cleaned after 30 days or any other value specified by ${fxf.retention}).
Author:
Jaco de Groot

  • Constructor Details

    • FxfWrapperPipe

      public FxfWrapperPipe()

  • Method Details

    • configure

      public void configure() throws ConfigurationException
      Description copied from class: FixedForwardPipe
      Checks for correct configuration of forward.
      Specified by:
      configure in interface IConfigurable
      Overrides:
      configure in class EsbSoapWrapperPipe
      Throws:
      ConfigurationException - in case it was not able to configure the component.

    • start

      public void start()
      Description copied from interface: IPipe
      Perform necessary action to start the pipe. This method is executed after the IConfigurable.configure() method, for each start and stop command of the adapter.
      Specified by:
      start in interface IPipe
      Specified by:
      start in interface org.springframework.context.Lifecycle
      Overrides:
      start in class SoapWrapperPipe

    • stop

      public void stop()
      Description copied from interface: IPipe
      Perform necessary actions to stop the Pipe.
      For instance, closing JMS connections, DBMS connections etc.
      Specified by:
      stop in interface IPipe
      Specified by:
      stop in interface org.springframework.context.Lifecycle
      Overrides:
      stop in class SoapWrapperPipe

    • doPipe

      public PipeRunResult doPipe(Message message, PipeLineSession session) throws PipeRunException
      Description copied from interface: IPipe
      This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult.
      Specified by:
      doPipe in interface IPipe
      Overrides:
      doPipe in class SoapWrapperPipe
      Throws:
      PipeRunException

    • setFlowId

      public void setFlowId(String flowId)
      The flowId of the file transfer when direction=wrap. When direction=unwrap the flowId will be extracted from the incoming message and added as a sessionKey to the pipeline.

    • setFlowOutFolder

      public void setFlowOutFolder(String flowOutFolder)
      specifies the output folder if transformFilename=false and direction=wrap

    • setTransformFilename

      public void setTransformFilename(boolean transformFilename)
      when true and direction=wrap, the input which is expected to be a local filename will be transformed to the filename as known on the IUF State machine.
      Default value
      true

    • setSoapBodySessionKey

      public void setSoapBodySessionKey(String soapBodySessionKey)

    • setTransferFlowIdSessionKey

      public void setTransferFlowIdSessionKey(String transferFlowIdSessionKey)

    • setClientFilenameSessionKey

      public void setClientFilenameSessionKey(String clientFilenameSessionKey)

    • setFlowIdSessionKey

      public void setFlowIdSessionKey(String flowIdSessionKey)

    • setFxfDirSessionKey

      public void setFxfDirSessionKey(String fxfDirSessionKey)

    • setFxfFileSessionKey

      public void setFxfFileSessionKey(String fxfFileSessionKey)

    • setFxfVersion

      public void setFxfVersion(String fxfVersion)
      either 3.1 or 3.2
      Default value
      3.1

    • setCreateFolder

      public void setCreateFolder(boolean createFolder)
      when set to true, the folder corresponding fxf.dir property will be created in case it does not exist
      Default value
      false

    • setUseServerFilename

      public void setUseServerFilename(boolean useServerFilename)
      when set to true, ServerFileName from the input will be used as the filename
      Default value
      false