com.sun.identity.shared.debug.file

Interface DebugFile

All Known Implementing Classes:

DebugFileImpl, StdDebugFile

public interface DebugFile

The implementation of this interface as well as the com.sun.identity.shared.debug.file.DebugFileProvider interface together provide the necessary functionality to replace or enhance the Debug File service.

Because of specific features that are only related to the log file and not the debugger, the debugger and the log file management can't be manage in a same class. For example, two debugger could write on the same log file with the merge mapping. They could have a different debug level but should have the same log rotation. This interface manages the log rotation, and the debugger the log level.

Even if this interface was dedicated to debugger, it could be used for managing a different kind of log file (example : access, statistics, etc.).

Every features that are related to the file should be implemented by classes that implement this interface.

Method Summary

Modifier and Type	Method and Description
void	writeIt(String prefix, String msg, Throwable th) Write message into file

Method Detail

writeIt

void writeIt(String prefix,
             String msg,
             Throwable th)
      throws IOException

Write message into file

Parameters:

prefix - Message prefix

msg - Message to be recorded.

th - the optional java.lang.Throwable which if present will be used to record the stack trace.

Throws:

IOException