com.ibm.ws.ffdc
Class FFDCFilter

java.lang.Object
  extended by com.ibm.ws.ffdc.FFDCFilter

public final class FFDCFilter
extends java.lang.Object

This class provides static methods to write first failure data capture (FFDC) records to assist in debugging problems. When an unexpected exception is caught, the processException methods can be used to record the exception stack. For example:

 
 catch (Exception x){
 FFDCFilter.processException(x, getClass().getName(), "129", this);
 throw x;
 }
 
 
The source and probe identifiers combine to provide the unique location in the source code where the FFDC record originated. Objects can also be passed for introspection that will also be included in the FFDC record. By default, the FFDC files are written to the ${server.output.dir}/logs/ffdc directory.


Method Summary
static void processException(java.lang.Throwable th, java.lang.String sourceId, java.lang.String probeId)
          Write a first failure data capture record for the provided throwable
static void processException(java.lang.Throwable th, java.lang.String sourceId, java.lang.String probeId, java.lang.Object callerThis)
          Write a first failure data capture record for the provided throwable
static void processException(java.lang.Throwable th, java.lang.String sourceId, java.lang.String probeId, java.lang.Object[] objectArray)
          Write a first failure data capture record for the provided throwable
static void processException(java.lang.Throwable th, java.lang.String sourceId, java.lang.String probeId, java.lang.Object callerThis, java.lang.Object[] objectArray)
          Write a first failure data capture record for the provided throwable
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

processException

public static void processException(java.lang.Throwable th,
                                    java.lang.String sourceId,
                                    java.lang.String probeId)
Write a first failure data capture record for the provided throwable

Parameters:
th - The throwable
sourceId - An identifier for the source of this record, for example the package and class name
probeId - A unique identifier within the source of this record, for example the source file line number

processException

public static void processException(java.lang.Throwable th,
                                    java.lang.String sourceId,
                                    java.lang.String probeId,
                                    java.lang.Object callerThis)
Write a first failure data capture record for the provided throwable

Parameters:
th - The throwable
sourceId - An identifier for the source of this record, for example the package and class name
probeId - A unique identifier within the source of this record, for example the source file line number
callerThis - The object making this call, which will be introspected for inclusion in the FFDC record

processException

public static void processException(java.lang.Throwable th,
                                    java.lang.String sourceId,
                                    java.lang.String probeId,
                                    java.lang.Object[] objectArray)
Write a first failure data capture record for the provided throwable

Parameters:
th - The throwable
sourceId - An identifier for the source of this record, for example the package and class name
probeId - A unique identifier within the source of this record, for example the source file line number
objectArray - An array of objects which will be introspected for inclusion in the FFDC record

processException

public static void processException(java.lang.Throwable th,
                                    java.lang.String sourceId,
                                    java.lang.String probeId,
                                    java.lang.Object callerThis,
                                    java.lang.Object[] objectArray)
Write a first failure data capture record for the provided throwable

Parameters:
th - The throwable
sourceId - An identifier for the source of this record, for example the package and class name
probeId - A unique identifier within the source of this record, for example the source file line number
callerThis - The object making this call, which will be introspected for inclusion in the FFDC record
objectArray - An array of objects which will be introspected for inclusion in the FFDC record