|
Oracle TopLink Java API Reference 10g Release 3 (10.1.3.1) B28219-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
AbstractSessionLog
, SessionLogEntry
, Session
Field Summary | |
static int |
ALL |
static java.lang.String |
CACHE |
static int |
CONFIG |
static java.lang.String |
CONNECTION |
static java.lang.String |
DMS |
static java.lang.String |
EJB |
static java.lang.String |
EJB_ANNOTATION |
static java.lang.String |
EVENT |
static int |
FINE |
static int |
FINER |
static int |
FINEST |
static int |
INFO |
static int |
OFF |
static java.lang.String |
PROPAGATION |
static java.lang.String |
QUERY |
static java.lang.String |
SEQUENCING |
static int |
SEVERE |
static java.lang.String |
SQL |
static java.lang.String |
TRANSACTION |
static int |
WARNING |
static java.lang.String |
WEAVER |
Method Summary | |
void |
config(java.lang.String message) PUBLIC: This method is called when a config level message needs to be logged. |
void |
fine(java.lang.String message) PUBLIC: This method is called when a fine level message needs to be logged. |
void |
finer(java.lang.String message) PUBLIC: This method is called when a finer level message needs to be logged. |
void |
finest(java.lang.String message) PUBLIC: This method is called when a finest level message needs to be logged. |
int |
getLevel() PUBLIC: Return the log level. |
int |
getLevel(java.lang.String category) PUBLIC: Return the log level. |
Session |
getSession() PUBLIC: Get the session that owns this SessionLog. |
java.io.Writer |
getWriter() PUBLIC: Return the writer to which an accessor writes logged messages and SQL. |
void |
info(java.lang.String message) PUBLIC: This method is called when a info level message needs to be logged. |
void |
log(int level, java.lang.String message) PUBLIC: Log a message that does not need to be translated. |
void |
log(int level, java.lang.String message, java.lang.Object param) PUBLIC: Log a message with one parameter that needs to be translated. |
void |
log(int level, java.lang.String message, java.lang.Object[] arguments) PUBLIC: This method is called when the log request is from somewhere session is not available. |
void |
log(int level, java.lang.String message, java.lang.Object[] arguments, boolean shouldTranslate) PUBLIC: This method is called when the log request is from somewhere session is not available. |
void |
log(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2) PUBLIC: Log a message with two parameters that needs to be translated. |
void |
log(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3) PUBLIC: Log a message with three parameters that needs to be translated. |
void |
log(SessionLogEntry entry) PUBLIC: TopLink will call this method whenever something needs to be logged (messages, SQL, etc.). |
void |
logThrowable(int level, java.lang.Throwable throwable) PUBLIC: Log a throwable with level. |
void |
setLevel(int level) PUBLIC: Set the log level. |
void |
setLevel(int level, java.lang.String category) PUBLIC: Set the log level. |
void |
setSession(Session session) PUBLIC: Set the session that owns this SessionLog. |
void |
setShouldLogExceptionStackTrace(boolean flag) By default stack trace is logged for SEVERE all the time and at FINER level for WARNING or less. |
void |
setShouldPrintConnection(boolean flag) By default the connection is always printed whenever available, this can be turned off. |
void |
setShouldPrintDate(boolean flag) By default date is printed, this can be turned off. |
void |
setShouldPrintSession(boolean flag) By default the Session is always printed whenever available, this can be turned off. |
void |
setShouldPrintThread(boolean flag) By default the thread is logged at FINE or less level, this can be turned off. |
void |
setWriter(java.io.Writer log) PUBLIC: Set the writer to which an accessor writes logged messages and SQL. |
void |
severe(java.lang.String message) PUBLIC: This method is called when a severe level message needs to be logged. |
boolean |
shouldLog(int level) PUBLIC: Check if a message of the given level would actually be logged. |
boolean |
shouldLog(int level, java.lang.String category) PUBLIC: Check if a message of the given level would actually be logged. |
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. |
boolean |
shouldPrintConnection() By default the connection is always printed whenever available, this can be turned off. |
boolean |
shouldPrintDate() By default the date is always printed, this can be turned off. |
boolean |
shouldPrintSession() By default the Session is always printed whenever available, this can be turned off. |
boolean |
shouldPrintThread() By default the thread is logged at FINE or less level, this can be turned off. |
void |
throwing(java.lang.Throwable throwable) PUBLIC: This method is called when a throwable at finer level needs to be logged. |
void |
warning(java.lang.String message) PUBLIC: This method is called when a warning level message needs to be logged. |
Methods inherited from interface oracle.toplink.sessions.SessionLog |
log, setShouldLogDebug, setShouldLogExceptions, shouldLogDebug, shouldLogExceptions |
Field Detail |
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 java.lang.String SQL
public static final java.lang.String TRANSACTION
public static final java.lang.String EVENT
public static final java.lang.String CONNECTION
public static final java.lang.String QUERY
public static final java.lang.String CACHE
public static final java.lang.String PROPAGATION
public static final java.lang.String SEQUENCING
public static final java.lang.String EJB
public static final java.lang.String DMS
public static final java.lang.String EJB_ANNOTATION
public static final java.lang.String WEAVER
Method Detail |
public void log(SessionLogEntry entry)
log
in interface SessionLog
entry
- oracle.toplink.sessions.LogEntrypublic boolean shouldLogExceptionStackTrace()
shouldLogExceptionStackTrace
in interface SessionLog
public boolean shouldPrintDate()
shouldPrintDate
in interface SessionLog
public boolean shouldPrintThread()
shouldPrintThread
in interface SessionLog
public boolean shouldPrintConnection()
shouldPrintConnection
in interface SessionLog
public boolean shouldPrintSession()
shouldPrintSession
in interface SessionLog
public void setShouldLogExceptionStackTrace(boolean flag)
setShouldLogExceptionStackTrace
in interface SessionLog
public void setShouldPrintDate(boolean flag)
setShouldPrintDate
in interface SessionLog
public void setShouldPrintThread(boolean flag)
setShouldPrintThread
in interface SessionLog
public void setShouldPrintConnection(boolean flag)
setShouldPrintConnection
in interface SessionLog
public void setShouldPrintSession(boolean flag)
setShouldPrintSession
in interface SessionLog
public java.io.Writer getWriter()
getWriter
in interface SessionLog
public void setWriter(java.io.Writer log)
setWriter
in interface SessionLog
public int getLevel()
getLevel
in interface SessionLog
public int getLevel(java.lang.String category)
getLevel
in interface SessionLog
public void setLevel(int level)
setLevel
in interface SessionLog
public void setLevel(int level, java.lang.String category)
setLevel
in interface SessionLog
public boolean shouldLog(int level)
shouldLog
in interface SessionLog
public boolean shouldLog(int level, java.lang.String category)
shouldLog
in interface SessionLog
public void log(int level, java.lang.String message)
log
in interface SessionLog
public void log(int level, java.lang.String message, java.lang.Object param)
log
in interface SessionLog
public void log(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2)
log
in interface SessionLog
public void log(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3)
log
in interface SessionLog
public void log(int level, java.lang.String message, java.lang.Object[] arguments)
log
in interface SessionLog
public void log(int level, java.lang.String message, java.lang.Object[] arguments, boolean shouldTranslate)
log
in interface SessionLog
public void throwing(java.lang.Throwable throwable)
throwing
in interface SessionLog
public void severe(java.lang.String message)
severe
in interface SessionLog
public void warning(java.lang.String message)
warning
in interface SessionLog
public void info(java.lang.String message)
info
in interface SessionLog
public void config(java.lang.String message)
config
in interface SessionLog
public void fine(java.lang.String message)
fine
in interface SessionLog
public void finer(java.lang.String message)
finer
in interface SessionLog
public void finest(java.lang.String message)
finest
in interface SessionLog
public void logThrowable(int level, java.lang.Throwable throwable)
logThrowable
in interface SessionLog
public Session getSession()
getSession
in interface SessionLog
public void setSession(Session session)
setSession
in interface SessionLog
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |