User post file transfer protocol (FTP) user exit

The user post file transfer protocol user exit is used to pass all outbound file transfer protocol (FTP) information to the user exit. The Gateway Server calls the execute method after an outbound transmission is loaded to the destination. The user defines what user exit to call by using the UserPostFtpExit configuration keyword. The user exit should extend the UserPostFtpExit class. This base class implements the UserPostFtpExitInterface class and all the necessary getter and setter methods in the interface. The user must implement one method, execute(). This method is called immediately after the outbound transmission is loaded to the destination.

The Gateway Server passes the following information to the user exit:
  • File Transfer Protocol host address
  • File Transfer Protocol port
  • File Transfer Protocol status
  • File size of each transmission loaded to the destination
  • Destination folder
  • File set names in destination
  • Local folder
  • File set names in local
The UserPostFtpExitInterface class defines the following file transfer protocol statuses:
  • STATUS_SUCCESS
  • STATUS_FAIL

Gateway supplies a sample user exit that shows how to transfer an FDUP file to a destination after the outbound transmission is loaded to the destination. To run the sample post file transfer protocol user exit, set outPostFTPClass to com.ibm.icpcs.gatewayserver.samples.SampleUserPostFtpExit in the configuration properties. The Gateway SampleUserPostFtpExit.java file in the samples directory is an example of calling the execute method to transfer a duplicate data transmission to a destination with the file extension of FDUP.