IBM WebSphere Application ServerTM
Release 7

com.ibm.ffdc
Interface Manager


public interface Manager


Field Summary
static Manager Ffdc
          Sole instance of the Manager
 
Method Summary
 com.ibm.ffdc.Ffdc getFfdc(java.lang.Throwable exception, java.lang.Object reporter, java.lang.String sourceId)
          Constructor variant using unique sourceID.
 com.ibm.ffdc.Ffdc getFfdc(java.lang.Throwable exception, java.lang.Object reporter, java.lang.String sourceId, java.lang.String probeId)
          The Ffdc instance incapsulates the exception and code location, it is a light weight object.
 java.util.List<com.ibm.ffdc.util.provider.Incident> getIncidents()
          Returns the list of incidents.
 void log(java.lang.Throwable exception, java.lang.Object reporter, java.lang.String sourceId, java.lang.String probeId)
          Logs an ffdc incident without upfront checking and without data capture.
 void log(java.lang.Throwable exception, java.lang.Object reporter, java.lang.String sourceId, java.lang.String probeId, java.lang.Object... args)
          Logs an ffdc incident without upfront checking.
 void unblockLogging()
          unblock all incidents.
 boolean unblockLogging(com.ibm.ffdc.util.provider.Incident incident)
          Unblock the logging of the next occurence of this incident
 

Field Detail

Ffdc

static final Manager Ffdc
Sole instance of the Manager

Method Detail

getFfdc

com.ibm.ffdc.Ffdc getFfdc(java.lang.Throwable exception,
                          java.lang.Object reporter,
                          java.lang.String sourceId)
Constructor variant using unique sourceID.

Parameters:
exception - - the exception to be reported
reporter - - the class or instance reporting the ffdc incident
sourceId - is the id of the, unique code location of this incident reporting, must not be null

getFfdc

com.ibm.ffdc.Ffdc getFfdc(java.lang.Throwable exception,
                          java.lang.Object reporter,
                          java.lang.String sourceId,
                          java.lang.String probeId)
The Ffdc instance incapsulates the exception and code location, it is a light weight object.

Parameters:
exception - - the exception to be reported
reporter - - the class or instance reporting the ffdc incident
sourceId - is the id of the, possibly not unique code location of this incident reporting, must not be null
probeId - together with the sourceId above provides for the unique code location, must not be null.

log

void log(java.lang.Throwable exception,
         java.lang.Object reporter,
         java.lang.String sourceId,
         java.lang.String probeId,
         java.lang.Object... args)
Logs an ffdc incident without upfront checking. Do not use this method if the captured data arguments are expensive to compute. This method still checks internaly if the incident is a first failure occurence.

Parameters:
exception - - the exception to be reported
reporter - - the class or instance reporting the ffdc incident
sourceId - together with the probeId parameter must be unique, can be null
probeId - together with the sourceId above provides for the unique code location, can be null.
args - - the data captured to aid problem determination, include the this object here if it is relevant

log

void log(java.lang.Throwable exception,
         java.lang.Object reporter,
         java.lang.String sourceId,
         java.lang.String probeId)
Logs an ffdc incident without upfront checking and without data capture.

Parameters:
exception - - the exception to be reported
reporter - - the class or instance reporting the ffdc incident
sourceId - together with the probeId parameter must be unique, can be null
probeId - together with the sourceId above provides for the unique code location, can be null.

getIncidents

java.util.List<com.ibm.ffdc.util.provider.Incident> getIncidents()
Returns the list of incidents. The list is unmodifiable.

Returns:
incidents

unblockLogging

boolean unblockLogging(com.ibm.ffdc.util.provider.Incident incident)
Unblock the logging of the next occurence of this incident

Parameters:
incident -
Returns:
true if the operation was successful

unblockLogging

void unblockLogging()
unblock all incidents. After this action on all incidents, the next time that each is used, the incident will be created as if the original incident had never been logged D606700


IBM WebSphere Application ServerTM
Release 7