|
Oracle Fusion Middleware Java API Reference for Oracle TopLink 11g Release 1 (11.1.1) E28847-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
org.eclipse.persistence.logging.AbstractSessionLog
public abstract class AbstractSessionLog
Represents the abstract log that implements all the generic logging functions. It contains a singleton SessionLog that logs messages from outside any EclipseLink session. The singleton SessionLog can also be passed to an EclipseLink session when messages are logged through that session. When JDK1.4 is used, a singleton JavaLog is created. Otherwise a singleton DefaultSessionLog is created.
SessionLog
, SessionLogEntry
, DefaultSessionLog
, JavaLog
Field Summary | |
---|---|
protected static java.lang.String |
CONFIG_PREFIX Represents prefix to logged config |
protected static java.lang.String |
CONNECTION_STRING Connection string |
protected static java.lang.String |
DATE_FORMAT_STR |
protected java.text.DateFormat |
dateFormat Format use to print the current date/time. |
protected static SessionLog |
defaultLog Represents the singleton SessionLog |
protected static java.lang.String |
FINE_PREFIX Represents prefix to logged fine |
protected static java.lang.String |
FINER_PREFIX Represents prefix to logged finer |
protected static java.lang.String |
FINEST_PREFIX Represents prefix to logged finest |
protected static java.lang.String |
INFO_PREFIX Represents prefix to logged info |
protected int |
level Represents the log level |
protected Session |
session Represents the session that owns this SessionLog |
protected static java.lang.String |
SEVERE_PREFIX Represents prefix to logged severe |
protected java.lang.Boolean |
shouldDisplayData Used to determine if bingdparameters should be logged or hidden. |
protected java.lang.Boolean |
shouldLogExceptionStackTrace Allows the printing of the stack to be explicitly disabled/enabled. |
protected java.lang.Boolean |
shouldPrintConnection Allows the printing of the connection to be explicitly disabled/enabled. |
protected java.lang.Boolean |
shouldPrintDate Allows the printing of the date to be explicitly disabled/enabled. |
protected java.lang.Boolean |
shouldPrintSession Allows the printing of the session to be explicitly disabled/enabled. |
protected java.lang.Boolean |
shouldPrintThread Allows the printing of the thread to be explicitly disabled/enabled. |
protected static java.lang.String |
THREAD_STRING Thread string |
protected static java.lang.String |
TOPLINK_PREFIX Cached TopLink prefix string. |
protected static java.lang.String |
WARNING_PREFIX Represents prefix to logged warning |
protected java.io.Writer |
writer Represents the writer that will receive the formatted log entries |
Fields inherited from interface org.eclipse.persistence.logging.SessionLog |
---|
ALL, ALL_LABEL, CACHE, CONFIG, CONFIG_LABEL, CONNECTION, DMS, EJB, EJB_OR_METADATA, EVENT, FINE, FINE_LABEL, FINER, FINER_LABEL, FINEST, FINEST_LABEL, INFO, INFO_LABEL, loggerCatagories, METAMODEL, OFF, OFF_LABEL, PROPAGATION, PROPERTIES, QUERY, SEQUENCING, SERVER, SEVERE, SEVERE_LABEL, SQL, TRANSACTION, WARNING, WARNING_LABEL, WEAVER |
Constructor Summary | |
---|---|
AbstractSessionLog() PUBLIC: Create a new AbstractSessionLog |
Method Summary | |
---|---|
java.lang.Object |
clone() INTERNAL: Each session owns its own session log because session is stored in the session log |
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. |
protected java.lang.String |
formatMessage(SessionLogEntry entry) Return the formatted message based on the information from the given SessionLogEntry. |
protected java.lang.String |
getConnectionString(org.eclipse.persistence.internal.databaseaccess.Accessor connection) Return the specified connection information. |
java.text.DateFormat |
getDateFormat() PUBLIC: Return the date format to be used when printing a log entry date. |
protected java.lang.String |
getDateString(java.util.Date date) Return the specified date and/or time information in string. |
static int |
getDefaultLoggingLevel() Return the system default log level. |
int |
getLevel() PUBLIC: Return the log level. |
int |
getLevel(java.lang.String category) PUBLIC: Return the log level for the category name space. |
java.lang.String |
getLevelString() PUBLIC: Return the log level as a string value. |
static SessionLog |
getLog() PUBLIC: Return the singleton SessionLog. |
Session |
getSession() PUBLIC: Get the session. |
protected java.lang.String |
getSessionString(Session session) Return the current session including the type and id. |
protected java.lang.String |
getSupplementDetailString(SessionLogEntry entry) Return the supplement detail information including date, session, thread and connection. |
protected java.lang.String |
getThreadString(java.lang.Thread thread) Return the specified thread information. |
java.io.Writer |
getWriter() PUBLIC: Return the writer that will receive the formatted log entries. |
void |
info(java.lang.String message) PUBLIC: This method is called when a info level message needs to be logged. |
boolean |
isOff() INTERNAL: Check if the log level is set to off. |
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[] params) PUBLIC: Log a message with an array of parameters that needs to be translated. |
void |
log(int level, java.lang.String message, java.lang.Object[] params, boolean shouldTranslate) PUBLIC: Log a message. |
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(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3, java.lang.Object param4) PUBLIC: Log a message with four parameters that needs to be translated. |
abstract void |
log(SessionLogEntry sessionLogEntry) PUBLIC: Log a SessionLogEntry |
void |
logThrowable(int level, java.lang.Throwable throwable) PUBLIC: Log a throwable with level. |
protected void |
printPrefixString(int level) Print the prefix string representing EclipseLink logging |
void |
setDateFormat(java.text.DateFormat dateFormat) PUBLIC: Set the date format to be used when printing a log entry date. |
void |
setLevel(int level) PUBLIC: Set the log level. |
void |
setLevel(int level, java.lang.String category) PUBLIC: Set the log level for the category name space. |
static void |
setLog(SessionLog sessionLog) PUBLIC: Set the singleton SessionLog. |
void |
setSession(Session session) PUBLIC: Set the session. |
void |
setShouldDisplayData(java.lang.Boolean shouldDisplayData) PUBLIC: Set whether bind parameters should be displayed when logging SQL. |
void |
setShouldLogExceptionStackTrace(boolean shouldLogExceptionStackTrace) By default the stack is logged for FINER or less (finest). |
void |
setShouldPrintConnection(boolean shouldPrintConnection) By default the connection is printed, this can be turned off. |
void |
setShouldPrintDate(boolean shouldPrintDate) By default the date is always printed, but can be turned off. |
void |
setShouldPrintSession(boolean shouldPrintSession) By default the session (and its connection is available) are printed, this can be turned off. |
void |
setShouldPrintThread(boolean shouldPrintThread) By default the thread is logged for FINE or less (finer,etc.). |
void |
setWriter(java.io.OutputStream outputstream) PUBLIC: Set the writer that will receive the formatted log entries. |
void |
setWriter(java.io.Writer writer) PUBLIC: Set the writer that will receive the formatted log entries. |
void |
severe(java.lang.String message) PUBLIC: This method is called when a severe level message needs to be logged. |
boolean |
shouldDisplayData() PUBLIC: Return true if SQL logging should log visible bind parameters. |
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 for the category name space. ! |
boolean |
shouldLogExceptionStackTrace() By default the stack is logged for FINER or less (finest). |
boolean |
shouldPrintConnection() By default the connection is printed, this can be turned off. |
boolean |
shouldPrintDate() By default the date is always printed, but can be turned off. |
boolean |
shouldPrintSession() By default the session (and its connection is available) are printed, this can be turned off. |
boolean |
shouldPrintThread() By default the thread is logged for FINE or less (finer,etc.). |
void |
throwing(java.lang.Throwable throwable) PUBLIC: Log a throwable at FINER level. |
static java.lang.String |
translateLoggingLevelToString(int loggingLevel) INTERNAL: Translate the string value of the log level to the constant value. |
static int |
translateStringToLoggingLevel(java.lang.String loggingLevel) INTERNAL: Translate the string value of the log level to the constant value. |
void |
warning(java.lang.String message) PUBLIC: This method is called when a warning level message needs to be logged. |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected int level
protected static SessionLog defaultLog
protected Session session
protected static java.lang.String SEVERE_PREFIX
protected static java.lang.String WARNING_PREFIX
protected static java.lang.String INFO_PREFIX
protected static java.lang.String CONFIG_PREFIX
protected static java.lang.String FINE_PREFIX
protected static java.lang.String FINER_PREFIX
protected static java.lang.String FINEST_PREFIX
protected static java.lang.String TOPLINK_PREFIX
protected static final java.lang.String CONNECTION_STRING
protected static final java.lang.String THREAD_STRING
protected java.io.Writer writer
protected static java.lang.String DATE_FORMAT_STR
protected java.text.DateFormat dateFormat
protected java.lang.Boolean shouldLogExceptionStackTrace
protected java.lang.Boolean shouldPrintDate
protected java.lang.Boolean shouldPrintThread
protected java.lang.Boolean shouldPrintSession
protected java.lang.Boolean shouldPrintConnection
protected java.lang.Boolean shouldDisplayData
Constructor Detail |
---|
public AbstractSessionLog()
Method Detail |
---|
public static int getDefaultLoggingLevel()
public int getLevel()
Return the log level. It is used when session is not available.
getLevel
in interface SessionLog
public java.lang.String getLevelString()
Return the log level as a string value.
getLevelString
in interface SessionLog
public int getLevel(java.lang.String category)
Return the log level for the category name space.
getLevel
in interface SessionLog
category
- the string representation of a EclipseLink category, e.g. "sql", "transaction" ...public void setLevel(int level)
Set the log level. It is used when session is not available.
setLevel
in interface SessionLog
level
- the new log levelpublic void setLevel(int level, java.lang.String category)
Set the log level for the category name space.
setLevel
in interface SessionLog
level
- the new log levelcategory
- the string representation of an EclipseLink category, e.g. "sql", "transaction" ...public boolean shouldDisplayData()
shouldDisplayData
in interface SessionLog
public boolean shouldLog(int level)
Check if a message of the given level would actually be logged. It is used when session is not available.
shouldLog
in interface SessionLog
level
- the log request levelpublic boolean shouldLog(int level, java.lang.String category)
Check if a message of the given level would actually be logged for the category name space. !isOff() is checked to screen out the possibility when both log level and log request level are set to OFF.
shouldLog
in interface SessionLog
level
- the log request levelcategory
- the string representation of an EclipseLink category, e.g. "sql", "transaction" ...*public static SessionLog getLog()
Return the singleton SessionLog. If the singleton SessionLog does not exist, a new one is created based on the version of JDK being used from the Version class.
public static void setLog(SessionLog sessionLog)
Set the singleton SessionLog.
sessionLog
- a SessionLogpublic Session getSession()
Get the session.
getSession
in interface SessionLog
public void setSession(Session session)
Set the session.
setSession
in interface SessionLog
session
- a Sessionpublic void log(int level, java.lang.String message)
Log a message that does not need to be translated. This method is intended for external use when logging messages are required within the EclipseLink output.
log
in interface SessionLog
level
- the log request level valuemessage
- the string message - this should not be a bundle keypublic void log(int level, java.lang.String message, java.lang.Object param)
Log a message with one parameter that needs to be translated.
log
in interface SessionLog
level
- the log request level valuemessage
- the string messageparam
- a parameter of the messagepublic void log(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2)
Log a message with two parameters that needs to be translated.
log
in interface SessionLog
level
- the log request level valuemessage
- the string messageparam1
- a parameter of the messageparam2
- second parameter of the messagepublic void log(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3)
Log a message with three parameters that needs to be translated.
log
in interface SessionLog
level
- the log request level valuemessage
- the string messageparam1
- a parameter of the messageparam2
- second parameter of the messageparam3
- third parameter of the messagepublic void log(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3, java.lang.Object param4)
Log a message with four parameters that needs to be translated.
log
in interface SessionLog
level
- the log request level valuemessage
- the string messageparam1
- a parameter of the messageparam2
- second parameter of the messageparam3
- third parameter of the messageparam4
- third parameter of the messagepublic void log(int level, java.lang.String message, java.lang.Object[] params)
Log a message with an array of parameters that needs to be translated.
log
in interface SessionLog
level
- the log request level valuemessage
- the string messageparams
- array of parameters to the messagepublic void log(int level, java.lang.String message, java.lang.Object[] params, boolean shouldTranslate)
Log a message. shouldTranslate determines if the message needs to be translated.
log
in interface SessionLog
level
- the log request levelmessage
- the string messageparams
- array of parameters to the messageshouldTranslate
- true if the message needs to be translatedpublic abstract void log(SessionLogEntry sessionLogEntry)
Log a SessionLogEntry
log
in interface SessionLog
entry
- SessionLogEntry that holds all the information for an EclipseLink logging eventpublic boolean shouldPrintSession()
shouldPrintSession
in interface SessionLog
public void setShouldPrintSession(boolean shouldPrintSession)
setShouldPrintSession
in interface SessionLog
public boolean shouldPrintConnection()
shouldPrintConnection
in interface SessionLog
public void setShouldPrintConnection(boolean shouldPrintConnection)
setShouldPrintConnection
in interface SessionLog
public boolean shouldLogExceptionStackTrace()
shouldLogExceptionStackTrace
in interface SessionLog
public void setShouldDisplayData(java.lang.Boolean shouldDisplayData)
setShouldDisplayData
in interface SessionLog
public void setShouldLogExceptionStackTrace(boolean shouldLogExceptionStackTrace)
setShouldLogExceptionStackTrace
in interface SessionLog
public boolean shouldPrintDate()
shouldPrintDate
in interface SessionLog
public void setShouldPrintDate(boolean shouldPrintDate)
setShouldPrintDate
in interface SessionLog
public boolean shouldPrintThread()
shouldPrintThread
in interface SessionLog
public void setShouldPrintThread(boolean shouldPrintThread)
setShouldPrintThread
in interface SessionLog
public java.io.Writer getWriter()
Return the writer that will receive the formatted log entries.
getWriter
in interface SessionLog
public void setWriter(java.io.Writer writer)
Set the writer that will receive the formatted log entries.
setWriter
in interface SessionLog
writer
- the log writerpublic void setWriter(java.io.OutputStream outputstream)
Set the writer that will receive the formatted log entries.
OutputStream
- the log writerpublic java.text.DateFormat getDateFormat()
protected java.lang.String getDateString(java.util.Date date)
protected java.lang.String getSupplementDetailString(SessionLogEntry entry)
protected java.lang.String getSessionString(Session session)
protected java.lang.String getConnectionString(org.eclipse.persistence.internal.databaseaccess.Accessor connection)
protected java.lang.String getThreadString(java.lang.Thread thread)
protected void printPrefixString(int level)
public void setDateFormat(java.text.DateFormat dateFormat)
Note: the JDK's java.text.SimpleDateFormat is NOT thread-safe.
The user is strongly advised to consider using Apache Commons
org.apache.commons.lang.time.FastDateFormat instead.
dateFormat
- java.text.DateFormatprotected java.lang.String formatMessage(SessionLogEntry entry)
public static int translateStringToLoggingLevel(java.lang.String loggingLevel)
public void throwing(java.lang.Throwable throwable)
Log a throwable at FINER level.
throwing
in interface SessionLog
throwable
- a Throwablepublic void severe(java.lang.String message)
This method is called when a severe level message needs to be logged. The message will be translated
severe
in interface SessionLog
message
- the message keypublic void warning(java.lang.String message)
This method is called when a warning level message needs to be logged. The message will be translated
warning
in interface SessionLog
message
- the message keypublic void info(java.lang.String message)
This method is called when a info level message needs to be logged. The message will be translated
info
in interface SessionLog
message
- the message keypublic void config(java.lang.String message)
This method is called when a config level message needs to be logged. The message will be translated
config
in interface SessionLog
message
- the message keypublic void fine(java.lang.String message)
This method is called when a fine level message needs to be logged. The message will be translated
fine
in interface SessionLog
message
- the message keypublic void finer(java.lang.String message)
This method is called when a finer level message needs to be logged. The message will be translated
finer
in interface SessionLog
message
- the message keypublic void finest(java.lang.String message)
This method is called when a finest level message needs to be logged. The message will be translated
finest
in interface SessionLog
message
- the message keypublic void logThrowable(int level, java.lang.Throwable throwable)
Log a throwable with level.
logThrowable
in interface SessionLog
level
- the log request level valuethrowable
- a Throwablepublic boolean isOff()
public java.lang.Object clone()
clone
in interface SessionLog
clone
in class java.lang.Object
public static java.lang.String translateLoggingLevelToString(int loggingLevel)
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |