File Doc Category Size Date Package
SessionLog.java API Doc Glassfish v2 API 10847 Tue May 22 16:54:44 BST 2007 oracle.toplink.essentials.logging

SessionLog

public interface SessionLog

SessionLog is the ever-so-simple interface used by TopLink to log generated messages and SQL. An implementor of this interface can be passed to the TopLink session (via the #setSessionLog(SessionLog) method); and all logging data will be passed through to the implementor via an instance of SessionLogEntry. This can be used to supplement debugging; or the entries could be stored in a database instead of logged to System.out; etc.

see: AbstractSessionLog
see: SessionLogEntry
since: TOPLink/Java 3.0

Fields Summary
public static final int
OFF
public static final int
SEVERE
public static final int
WARNING
public static final int
INFO
public static final int
CONFIG
public static final int
FINE
public static final int
FINER
public static final int
FINEST
public static final int
ALL
public static final String
SQL
public static final String
TRANSACTION
public static final String
EVENT
public static final String
CONNECTION
public static final String
QUERY
public static final String
CACHE
public static final String
PROPAGATION
public static final String
SEQUENCING
public static final String
EJB
public static final String
DMS
public static final String
EJB_OR_METADATA
public static final String
WEAVER
public static final String
PROPERTIES
public final String[]
loggerCategories
Constructors Summary
Methods Summary
public void config(java.lang.String message)
PUBLIC: This method is called when a config level message needs to be logged. The message will be translated
public void fine(java.lang.String message)
PUBLIC: This method is called when a fine level message needs to be logged. The message will be translated
public void finer(java.lang.String message)
PUBLIC: This method is called when a finer level message needs to be logged. The message will be translated
public void finest(java.lang.String message)
PUBLIC: This method is called when a finest level message needs to be logged. The message will be translated
public int getLevel()
PUBLIC: Return the log level. Used when session is not available.
public int getLevel(java.lang.String category)
PUBLIC: Return the log level. category is only needed where name space is available.
public oracle.toplink.essentials.sessions.Session getSession()
PUBLIC: Get the session that owns this SessionLog.
public java.io.Writer getWriter()
PUBLIC: Return the writer to which an accessor writes logged messages and SQL. If not set, this reference usually defaults to a writer on System.out. To enable logging, logMessages must be turned on in the session.
public void info(java.lang.String message)
PUBLIC: This method is called when a info level message needs to be logged. The message will be translated
public void log(oracle.toplink.essentials.logging.SessionLogEntry entry)
INTERNAL: TopLink will call this method whenever something needs to be logged (messages, SQL, etc.). All the pertinent information will be contained in the specified entry.
param
entry oracle.toplink.essentials.sessions.LogEntry
public void log(int level, java.lang.String message)
PUBLIC: Log a message that does not need to be translated. This method is intended for external use when logging messages are wanted within the TopLink output.
public void log(int level, java.lang.String message, java.lang.Object param)
INTERNAL: Log a message with one parameter that needs to be translated.
public void log(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2)
INTERNAL: Log a message with two parameters that needs to be translated.
public void log(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3)
INTERNAL: Log a message with three parameters that needs to be translated.
public void log(int level, java.lang.String message, java.lang.Object[] arguments)
INTERNAL: This method is called when the log request is from somewhere session is not available. The message needs to be translated.
public void log(int level, java.lang.String message, java.lang.Object[] arguments, boolean shouldTranslate)
INTERNAL: This method is called when the log request is from somewhere session is not available. shouldTranslate flag determines if the message needs to be translated.
public void logThrowable(int level, java.lang.Throwable throwable)
PUBLIC: Log a throwable with level.
public void setLevel(int level)
PUBLIC: Set the log level. Used when session is not available.
public void setLevel(int level, java.lang.String category)
PUBLIC: Set the log level. Category is only needed where name space is available.
public void setSession(oracle.toplink.essentials.sessions.Session session)
PUBLIC: Set the session that owns this SessionLog.
public void setShouldLogExceptionStackTrace(boolean flag)
By default stack trace is logged for SEVERE all the time and at FINER level for WARNING or less. This can be turned off.
public void setShouldPrintConnection(boolean flag)
By default the connection is always printed whenever available, this can be turned off.
public void setShouldPrintDate(boolean flag)
By default date is printed, this can be turned off.
public void setShouldPrintSession(boolean flag)
By default the Session is always printed whenever available, this can be turned off.
public void setShouldPrintThread(boolean flag)
By default the thread is logged at FINE or less level, this can be turned off.
public void setWriter(java.io.Writer log)
PUBLIC: Set the writer to which an accessor writes logged messages and SQL. If not set, this reference usually defaults to a writer on System.out. To enable logging, logMessages() is used on the session.
public void severe(java.lang.String message)
PUBLIC: This method is called when a severe level message needs to be logged. The message will be translated
public boolean shouldLog(int level)
PUBLIC: Check if a message of the given level would actually be logged. Used when session is not available.
public boolean shouldLog(int level, java.lang.String category)
PUBLIC: Check if a message of the given level would actually be logged. Category is only needed where name space is available.
public boolean shouldLogExceptionStackTrace()
By default the stack trace is logged for SEVERE all the time and at FINER level for WARNING or less, this can be turned off.
public boolean shouldPrintConnection()
By default the connection is always printed whenever available, this can be turned off.
public boolean shouldPrintDate()
By default the date is always printed, this can be turned off.
public boolean shouldPrintSession()
By default the Session is always printed whenever available, this can be turned off.
public boolean shouldPrintThread()
By default the thread is logged at FINE or less level, this can be turned off.
public void throwing(java.lang.Throwable throwable)
PUBLIC: This method is called when a throwable at finer level needs to be logged.
public void warning(java.lang.String message)
PUBLIC: This method is called when a warning level message needs to be logged. The message will be translated