Package com.ibm.ws.ffdc
Class DiagnosticModule
java.lang.Object
com.ibm.ws.ffdc.DiagnosticModule
Extend this class to create a diagnostic module to help FFDC capture and dump
 data for your component. Example usage:
 
 
 DiagnosticModuleForComponent dm = new DiagnosticModuleForComponent();
 if (FFDC.registerDiagnosticModule(dm, "com.ibm.ws.mycomponent.packagename") != 0)
 {
 // Diagnostic module failed to meet the criteria described above
 // Return codes :
 // 0 - DM was registered
 // 1 - A DM has already been registered with the package name
 // 2 - The DM did not meet the criteria to contain a single dump method
 // 3 - An unknown failure occured during the registration
 }
 
 
 Any methods beginning with "ffdcDump" will be recognized by the ffdc runtime,
 and used for data collection. These methods should expect the following
 parameters:
 - Throwable th. The encountered exception.
- IncidentStream is. Write captured data to this stream.
- Object[] others. The value of the array may be null. If not null, it contains an array of objects which the caller to the FFDC filter passed.
- Object callerThis. The callerThis value may be null, if the method which invoked the filter was a static method. Or if the current point of execution for the filter, does not correspond to the DM being invoked.
- String sourceId. The sourceId passed to the filter.
Method names that start with "ffdcDumpDefault" will always be called when this component is involved in an exception or error situation. These methods will be responsible for performing the default data capture for their component.
Method names that simply start with "ffdcDump" [not ffdcDumpDefault] are only called under certain conditions and are not considered part of the default data capture.
 Methods that don't start with "ffdcDump", or that don't conform to the
 expected signature will be ignored. Setting the
 com.ibm.ws.ffdc.debugDiagnosticModule system property to true
 will cause exceptions to be thrown for malformed diagnostic module
 signatures.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringName of property used to enable noise-making when badly formed methods are encountered when initializing a new module.static final StringThe prefix of ffdcdumpdefault methods (compared using toLowerCase)static final StringThe prefix of ffdcdump methods (compared using toLowerCase)
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionfinal booleandumpComponentData(String[] input_directives, Throwable ex, IncidentStream ffdcis, Object callerThis, Object[] catcherObjects, String sourceId, String[] callStack) This method is invoked to instruct the diagnostic module to capture all relevant information that it has about a particular incidentfinal voidgetDataForDirectives(String[] directives, Throwable ex, IncidentStream ffdcis, Object callerThis, Object[] catcherObjects, String sourceId) Invoke all the ffdcdump methods for a set of directivesString[]Return the list of directives returned by this diagnostic module.final voidInform this base class (and the diagnostic engine) that no more diagnosis information is required for this incidentfinal booleanvalidate()Validate whether the diagnostic module is correctly coded.
- 
Field Details- 
DEBUG_DM_PROPERTYName of property used to enable noise-making when badly formed methods are encountered when initializing a new module.- See Also:
 
- 
FFDC_DUMP_PREFIXThe prefix of ffdcdump methods (compared using toLowerCase)- See Also:
 
- 
FFDC_DUMP_DEFAULT_PREFIXThe prefix of ffdcdumpdefault methods (compared using toLowerCase)- See Also:
 
 
- 
- 
Constructor Details- 
DiagnosticModulepublic DiagnosticModule()
 
- 
- 
Method Details- 
getDirectivesReturn the list of directives returned by this diagnostic module.- Returns:
- String[]
 
- 
dumpComponentDatapublic final boolean dumpComponentData(String[] input_directives, Throwable ex, IncidentStream ffdcis, Object callerThis, Object[] catcherObjects, String sourceId, String[] callStack) This method is invoked to instruct the diagnostic module to capture all relevant information that it has about a particular incident- Parameters:
- input_directives- The directives to be processed for this incident
- ex- The exception that caused this incident
- ffdcis- The incident stream to be used to record the relevant information
- callerThis- The object reporting the incident
- catcherObjects- Additional objects that might be involved
- sourceId- The source id of the class reporting the incident
- callStack- The list of classes on the stack
- Returns:
- true if more diagnostic modules should be invoked after this one
 
- 
getDataForDirectivespublic final void getDataForDirectives(String[] directives, Throwable ex, IncidentStream ffdcis, Object callerThis, Object[] catcherObjects, String sourceId) Invoke all the ffdcdump methods for a set of directives- Parameters:
- directives- The list of directives to be invoked
- ex- The exception causing the incident
- ffdcis- The incident stream on which to report
- callerThis- The object reporting the incident
- catcherObjects- Any additional interesting objects
- sourceId- The sourceid of the class reporting the problem
 
- 
validatepublic final boolean validate()Validate whether the diagnostic module is correctly coded. Method can be used as a simple validation of a components diagnostic module. The information printed can be used during the development of the DM.- Returns:
- true; if the system property "com.ibm.ws.ffdc.debugDiagnosticModule" is set, then some validation will be performed on the diagnostic module.
 
- 
stopProcessingExceptionpublic final void stopProcessingException()Inform this base class (and the diagnostic engine) that no more diagnosis information is required for this incident
 
-