IT30633: IBM MQ Managed File Transfer tracing enhancements for SFTP transfers

APAR status

• Closed as program error.

Error description

• The IBM MQ Managed File Transfer trace component does not have
  the capability to display full Java exception stacks in trace.
   Instead it just displays the Exception's 'detail message'.
  
  Most of the time this is sufficient to be able to diagnose
  problems.  However it does make it more difficult to spot that
  exceptions have been thrown at a glance of the trace, and if the
  exception was thrown in a third party part of the product code
  (for example the JSch library when communicating with a SFTP
  server), understanding the cause of the exception can be much
  more difficult.
  

Local fix

Problem summary

• ****************************************************************
  USERS AFFECTED:
  Users of IBM MQ Managed File Transfer who are using a Protocol
  Bridge Agent to communicate with a SFTP server, and have trace
  enabled to supply to IBM MQ support.
  
  
  Platforms affected:
  MultiPlatform
  
  ****************************************************************
  PROBLEM DESCRIPTION:
  The goal of trace is to allow for the diagnosis of problems
  which occur within the product.  The more useful information
  which is available within trace, the easier (and thus quicker)
  it is to understand problems which have occurred.
  
  Java exception stack traces provide a lot of useful information,
  including the line numbers of the line of code where the problem
  was being reported from.
  
  When an exception occurred when the Protocol Bridge Agent was
  accessing the InputStream or OutputStream provided by the JSch
  library, an example of the information displayed in trace was:
  
    c.i.w.io.bridge.BridgeFileChannelImpl   ----+-  !  close, 4:
   [java.io.IOException]
  
  the "4: " here being the detail message contained within the
  Exception.  On its own this does not provide much help in
  understanding the underlying problem which has occurred.
  

Problem conclusion

• The IBM MQ Managed File Transfer trace has been updated to allow
  Java exception stacks to be displayed in trace.
  
  The Protocol Bridge Agent component has subsequently been
  updated so that the operations which access the InputStream and
  OutputStream provided by the JSch library have any thrown
  exceptions reported in full in trace.
  
  An example trace snippet which demonstrates the new output is as
  follows:
  
  @f86de378  c.i.w.io.bridge.BridgeFileChannelImpl         ----+-
   d  close data [Closing output stream
  mySftpServer.myDomain:/my/location/myfile.txt]
  @f86de378  c.i.w.io.bridge.BridgeFileChannelImpl         ----+-
   X  close
  4: [java.io.IOException] at:
    com.jcraft.jsch.ChannelSftp$1.close(ChannelSftp.java:857)
  
  com.ibm.wmqfte.io.bridge.BridgeFileChannelImpl.close(BridgeFileC
  hannelImpl.java:242)
  
  com.ibm.wmqfte.transfer.frame.impl.TransferFrameReceiverImpl.wri
  teComplete(TransferFrameReceiverImpl.java:770)
  
  com.ibm.wmqfte.transfer.frame.impl.TransferFrameReceiverImpl.wri
  teSlice(TransferFrameReceiverImpl.java:577)
  
  com.ibm.wmqfte.transfer.frame.impl.TransferFrameReceiverImpl.pro
  cessChunk(TransferFrameReceiverImpl.java:515)
  
  com.ibm.wmqfte.transfer.frame.impl.TransferFrameReceiverImpl.acc
  ess$000(TransferFrameReceiverImpl.java:78)
  
  com.ibm.wmqfte.transfer.frame.impl.TransferFrameReceiverImpl$Chu
  nkProcessor.processFileIORequest(TransferFrameReceiverImpl.java:
  118)
  
  com.ibm.wmqfte.transfer.frame.impl.TransferFrameIOWorker.doWorkI
  mpl(TransferFrameIOWorker.java:307)
  
  com.ibm.wmqfte.io.impl.FTEFileIOWorker.doWork(FTEFileIOWorker.ja
  va:118)
  
  com.ibm.wmqfte.io.impl.FTEFileIORequestQueue.run(FTEFileIOReques
  tQueue.java:244)
    java.lang.Thread.run(Thread.java:812)
    com.ibm.wmqfte.thread.FTEThread.run(FTEThread.java:70)
  Object ClassLoader = null
  CurrentThread ClassLoader =
  com.ibm.wmqfte.agent.bootstrap.impl.BootstrapClassLoaderImpl@e0d
  0f384
  
  ---------------------------------------------------------------
  The fix is targeted for delivery in the following PTFs:
  
  Version    Maintenance Level
  v9.0 LTS   9.0.0.9
  v9.1 CD    9.1.5
  v9.1 LTS   9.1.0.5
  
  The latest available MQ maintenance can be obtained from
  'WebSphere MQ Recommended Fixes'
  http://www-1.ibm.com/support/docview.wss?rs=171&uid=swg27006037
  
  If the maintenance level is not yet available information on
  its planned availability can be found in 'WebSphere MQ
  Planned Maintenance Release Dates'
  http://www-1.ibm.com/support/docview.wss?rs=171&uid=swg27006309
  ---------------------------------------------------------------
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

• Fixed component name

  IBM MQ MFT V9.0

• Fixed component ID

  5724H7262

Applicable component levels