com.ibm.ws.ffdc

Interface FFDCFilterService


  1. public interface FFDCFilterService
Interface for pluggable FFDCFilter implementation. Services that implement this interface and register as FFDCFilterService providers will be delegated to by the static methods in com.ibm.ws.ffdc.FFDCFilter.

Method Summary

Modifier and Type Method and Description
  1. java.io.File
getFFDCLogLocation()
  1. void
init(com.ibm.wsspi.logprovider.LogProviderConfig config)
Initialize FFDC service from set of initial properties
  1. void
processException(java.lang.Throwable th,java.lang.String sourceId,java.lang.String probeId)
Filter method used to process a Throwable from user code.
  1. void
processException(java.lang.Throwable th,java.lang.String sourceId,java.lang.String probeId,java.lang.Object callerThis)
Filter method used to process a Throwable from user code.
  1. void
processException(java.lang.Throwable th,java.lang.String sourceId,java.lang.String probeId,java.lang.Object[] objectArray)
Filter method used to process a Throwable from user code.
  1. void
processException(java.lang.Throwable th,java.lang.String sourceId,java.lang.String probeId,java.lang.Object callerThis,java.lang.Object[] objectArray)
Filter method used to process a Throwable from user code.
  1. void
rollLogs()
Allow new incidents to be reported and if necessary logs to be rolled.
  1. void
stop()
Stop FFDC service
  1. void
update(com.ibm.wsspi.logprovider.LogProviderConfig config)

Method Detail

processException

  1. void processException(java.lang.Throwable th,
  2. java.lang.String sourceId,
  3. java.lang.String probeId)
Filter method used to process a Throwable from user code.

Parameters:
th - The throwable from the caller which is to be processed.
sourceId - The source Id is a unique identifier for the the source code. The code insertion tool uses the class+method name as the source identifier.
probeId - The probe Id is a unique identifier with in the code. The source line will be used as the probe Id. The identifier needs to be unique within the file, when the file changes and the code location has changed within the source file, the files does not need to be updated. The probe Id simply needs to maintained unique within the file. If the resequencing of the source is needed, the tool can be used to resequence the probe Ids to be consistent with the source file.

processException

  1. void processException(java.lang.Throwable th,
  2. java.lang.String sourceId,
  3. java.lang.String probeId,
  4. java.lang.Object callerThis)
Filter method used to process a Throwable from user code.

Parameters:
th - The throwable from the caller which is to be processed.
sourceId - The source Id is a unique identifier for the the source code. The code insertion tool uses the class+method name as the source identifier.
probeId - The probe Id is a unique identifier with in the code. The source line will be used as the probe Id. The identifier needs to be unique within the file, when the file changes and the code location has changed within the source file, the files does not need to be updated. The probe Id simply needs to maintained unique within the file. If the resequencing of the source is needed, the tool can be used to resequence the probe Ids to be consistent with the source file.
callerThis - The callerThis parameter corresponds to the invoker's this pointer. The pointer will be processed by the components diagnostic module.

processException

  1. void processException(java.lang.Throwable th,
  2. java.lang.String sourceId,
  3. java.lang.String probeId,
  4. java.lang.Object[] objectArray)
Filter method used to process a Throwable from user code.

Parameters:
th - The exception from the caller which is to be processed
sourceId - The source Id is a unique identifier for the the source code. The code insertion tool uses the class+method name as the source identifier.
probeId - The probe Id is a unique identifier with in the code. The source line will be used as the probe Id. The identifier needs to be unique within the file, when the file changes and the code location has changed within the source file, the files does not need to be updated. The probe Id simply needs to maintained unique within the file. If the resequencing of the source is needed, the tool can be used to resequence the probe Ids to be consistent with the source file.
objectArray - Array of objects supplied by the caller to be used during the processing of the diagnostic module.

processException

  1. void processException(java.lang.Throwable th,
  2. java.lang.String sourceId,
  3. java.lang.String probeId,
  4. java.lang.Object callerThis,
  5. java.lang.Object[] objectArray)
Filter method used to process a Throwable from user code.

Parameters:
th - The exception from the caller which is to be processed
sourceId - The source Id is a unique identifier for the the source code. The code insertion tool uses the class+method name as the source identifier.
probeId - The probe Id is a unique identifier with in the code. The source line will be used as the probe Id. The identifier needs to be unique within the file, when the file changes and the code location has changed within the source file, the files does not need to be updated. The probe Id simply needs to maintained unique within the file. If the resequencing of the source is needed, the tool can be used to resequence the probe Ids to be consistent with the source file.
callerThis - The callerThis parameter corresponds to the invokers this pointer. The pointer will be processed by the component's diagnostic module.
objectArray - Array of object supplied by the caller to be used during the processing of the diagnostic module.

init

  1. void init(com.ibm.wsspi.logprovider.LogProviderConfig config)
Initialize FFDC service from set of initial properties
Parameters:
config -

rollLogs

  1. void rollLogs()
Allow new incidents to be reported and if necessary logs to be rolled.

stop

  1. void stop()
Stop FFDC service

getFFDCLogLocation

  1. java.io.File getFFDCLogLocation( )
Returns:
File object for the directory that ffdc logs should be placed in

update

  1. void update(com.ibm.wsspi.logprovider.LogProviderConfig config)
Parameters:
config -