public abstract class AbstractSessionLog extends Object implements SessionLog, Cloneable
SessionLog,
SessionLogEntry,
DefaultSessionLog,
JavaLogALL, ALL_LABEL, CACHE, CONFIG, CONFIG_LABEL, CONNECTION, DDL, DMS, EJB, EJB_OR_METADATA, EVENT, FINE, FINE_LABEL, FINER, FINER_LABEL, FINEST, FINEST_LABEL, INFO, INFO_LABEL, JPA, JPARS, loggerCatagories, METADATA, METAMODEL, MONITORING, OFF, OFF_LABEL, PROPAGATION, PROPERTIES, QUERY, SEQUENCING, SERVER, SEVERE, SEVERE_LABEL, SQL, TRANSACTION, WARNING, WARNING_LABEL, WEAVER| Constructor and Description |
|---|
AbstractSessionLog()
PUBLIC:
Create a new AbstractSessionLog
|
| Modifier and Type | Method and Description |
|---|---|
Object |
clone()
INTERNAL:
Each session owns its own session log because session is stored in the session log
|
void |
config(String message)
PUBLIC:
|
void |
fine(String message)
PUBLIC:
|
void |
finer(String message)
PUBLIC:
|
void |
finest(String message)
PUBLIC:
|
DateFormat |
getDateFormat()
PUBLIC:
Return the date format to be used when printing a log entry date.
|
static int |
getDefaultLoggingLevel()
Return the system default log level.
|
int |
getLevel()
PUBLIC:
|
int |
getLevel(String category)
PUBLIC:
|
String |
getLevelString()
PUBLIC:
|
static SessionLog |
getLog()
PUBLIC:
|
Session |
getSession()
PUBLIC:
|
Writer |
getWriter()
PUBLIC:
|
void |
info(String message)
PUBLIC:
|
boolean |
isOff()
INTERNAL:
Check if the log level is set to off.
|
void |
log(int level,
String message)
PUBLIC:
|
void |
log(int level,
String message,
Object param)
PUBLIC:
|
void |
log(int level,
String message,
Object[] params)
PUBLIC:
|
void |
log(int level,
String message,
Object[] params,
boolean shouldTranslate)
PUBLIC:
|
void |
log(int level,
String message,
Object param1,
Object param2)
PUBLIC:
|
void |
log(int level,
String message,
Object param1,
Object param2,
Object param3)
PUBLIC:
|
void |
log(int level,
String message,
Object param1,
Object param2,
Object param3,
Object param4)
PUBLIC:
|
void |
log(int level,
String category,
String message,
Object param)
PUBLIC:
|
void |
log(int level,
String category,
String message,
Object[] params)
PUBLIC:
|
void |
log(int level,
String category,
String message,
Object[] params,
boolean shouldTranslate)
PUBLIC:
|
void |
log(int level,
String category,
String message,
Object param1,
Object param2)
PUBLIC:
|
void |
log(int level,
String category,
String message,
Object param1,
Object param2,
Object param3)
PUBLIC:
|
void |
log(int level,
String category,
String message,
Object param1,
Object param2,
Object param3,
Object param4)
PUBLIC:
|
abstract void |
log(SessionLogEntry sessionLogEntry)
PUBLIC:
|
void |
logThrowable(int level,
String category,
Throwable throwable)
PUBLIC:
|
void |
logThrowable(int level,
Throwable throwable)
PUBLIC:
|
void |
setDateFormat(DateFormat dateFormat)
PUBLIC:
Set the date format to be used when printing a log entry date.
|
void |
setLevel(int level)
PUBLIC:
|
void |
setLevel(int level,
String category)
PUBLIC:
|
static void |
setLog(SessionLog sessionLog)
PUBLIC:
|
void |
setSession(Session session)
PUBLIC:
|
void |
setShouldDisplayData(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(OutputStream outputstream)
PUBLIC:
|
void |
setWriter(Writer writer)
PUBLIC:
|
void |
severe(String message)
PUBLIC:
|
boolean |
shouldDisplayData()
PUBLIC:
Return true if SQL logging should log visible bind parameters.
|
boolean |
shouldLog(int level)
PUBLIC:
|
boolean |
shouldLog(int level,
String category)
PUBLIC:
|
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(Throwable throwable)
PUBLIC:
|
static String |
translateLoggingLevelToString(int loggingLevel)
INTERNAL:
Translate the string value of the log level to the constant value.
|
static int |
translateStringToLoggingLevel(String loggingLevel)
INTERNAL:
Translate the string value of the log level to the constant value.
|
void |
warning(String message)
PUBLIC:
|
public AbstractSessionLog()
public static int getDefaultLoggingLevel()
public int getLevel()
Return the log level. It is used when session is not available.
getLevel in interface SessionLogpublic String getLevelString()
Return the log level as a string value.
getLevelString in interface SessionLogpublic int getLevel(String category)
Return the log level for the category name space.
getLevel in interface SessionLogcategory - 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 SessionLoglevel - the new log level
public void setLevel(int level,
String category)
Set the log level for the category name space.
setLevel in interface SessionLoglevel - the new log levelcategory - the string representation of an EclipseLink category, e.g. "sql", "transaction" ...
public boolean shouldDisplayData()
shouldDisplayData in interface SessionLogpublic 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 SessionLoglevel - the log request level
public boolean shouldLog(int level,
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 SessionLoglevel - 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 SessionLog
public Session getSession()
Get the session.
getSession in interface SessionLogpublic void setSession(Session session)
Set the session.
setSession in interface SessionLogsession - a Session
public void log(int level,
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 SessionLoglevel - the log request level value
message - the string message - this should not be a bundle key
public void log(int level,
String message,
Object param)
Log a message with one parameter that needs to be translated.
log in interface SessionLoglevel - the log request level value
message - the string message
param - a parameter of the message
public void log(int level,
String category,
String message,
Object param)
Log a message with one parameter that needs to be translated.
log in interface SessionLoglevel - the log request level value
message - the string message
param - a parameter of the message
public void log(int level,
String message,
Object param1,
Object param2)
Log a message with two parameters that needs to be translated.
log in interface SessionLoglevel - the log request level value
message - the string message
param1 - a parameter of the message
param2 - second parameter of the message
public void log(int level,
String category,
String message,
Object param1,
Object param2)
Log a message with two parameters that needs to be translated.
log in interface SessionLoglevel - the log request level value
message - the string message
param1 - a parameter of the message
param2 - second parameter of the message
public void log(int level,
String message,
Object param1,
Object param2,
Object param3)
Log a message with three parameters that needs to be translated.
log in interface SessionLoglevel - the log request level value
message - the string message
param1 - a parameter of the message
param2 - second parameter of the message
param3 - third parameter of the message
public void log(int level,
String category,
String message,
Object param1,
Object param2,
Object param3)
Log a message with three parameters that needs to be translated.
log in interface SessionLoglevel - the log request level value
message - the string message
param1 - a parameter of the message
param2 - second parameter of the message
param3 - third parameter of the message
public void log(int level,
String message,
Object param1,
Object param2,
Object param3,
Object param4)
Log a message with four parameters that needs to be translated.
log in interface SessionLoglevel - the log request level value
message - the string message
param1 - a parameter of the message
param2 - second parameter of the message
param3 - third parameter of the message
param4 - third parameter of the message
public void log(int level,
String category,
String message,
Object param1,
Object param2,
Object param3,
Object param4)
Log a message with four parameters that needs to be translated.
log in interface SessionLoglevel - the log request level value
message - the string message
param1 - a parameter of the message
param2 - second parameter of the message
param3 - third parameter of the message
param4 - third parameter of the message
public void log(int level,
String message,
Object[] params)
Log a message with an array of parameters that needs to be translated.
log in interface SessionLoglevel - the log request level value
message - the string message
params - array of parameters to the message
public void log(int level,
String category,
String message,
Object[] params)
Log a message with an array of parameters that needs to be translated.
log in interface SessionLoglevel - the log request level value
message - the string message
params - array of parameters to the message
public void log(int level,
String message,
Object[] params,
boolean shouldTranslate)
Log a message. shouldTranslate determines if the message needs to be translated.
log in interface SessionLoglevel - the log request level
message - the string message
params - array of parameters to the message
shouldTranslate - true if the message needs to be translated
public void log(int level,
String category,
String message,
Object[] params,
boolean shouldTranslate)
Log a message. shouldTranslate determines if the message needs to be translated.
log in interface SessionLoglevel - the log request level
message - the string message
category - the log category
params - array of parameters to the message
shouldTranslate - true if the message needs to be translated
public abstract void log(SessionLogEntry sessionLogEntry)
Log a SessionLogEntry
log in interface SessionLogentry - SessionLogEntry that holds all the information for an EclipseLink logging event
public boolean shouldPrintSession()
shouldPrintSession in interface SessionLogpublic void setShouldPrintSession(boolean shouldPrintSession)
setShouldPrintSession in interface SessionLogpublic boolean shouldPrintConnection()
shouldPrintConnection in interface SessionLogpublic void setShouldPrintConnection(boolean shouldPrintConnection)
setShouldPrintConnection in interface SessionLogpublic boolean shouldLogExceptionStackTrace()
shouldLogExceptionStackTrace in interface SessionLogpublic void setShouldDisplayData(Boolean shouldDisplayData)
setShouldDisplayData in interface SessionLogpublic void setShouldLogExceptionStackTrace(boolean shouldLogExceptionStackTrace)
setShouldLogExceptionStackTrace in interface SessionLogpublic boolean shouldPrintDate()
shouldPrintDate in interface SessionLogpublic void setShouldPrintDate(boolean shouldPrintDate)
setShouldPrintDate in interface SessionLogpublic boolean shouldPrintThread()
shouldPrintThread in interface SessionLogpublic void setShouldPrintThread(boolean shouldPrintThread)
setShouldPrintThread in interface SessionLogpublic Writer getWriter()
Return the writer that will receive the formatted log entries.
getWriter in interface SessionLogpublic void setWriter(Writer writer)
Set the writer that will receive the formatted log entries.
setWriter in interface SessionLogwriter - the log writer
public void setWriter(OutputStream outputstream)
Set the writer that will receive the formatted log entries.
OutputStream - the log writer
public DateFormat getDateFormat()
public void setDateFormat(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.DateFormatpublic static int translateStringToLoggingLevel(String loggingLevel)
public void throwing(Throwable throwable)
Log a throwable at FINER level.
throwing in interface SessionLogthrowable - a Throwable
public void severe(String message)
This method is called when a severe level message needs to be logged. The message will be translated
severe in interface SessionLogmessage - the message key
public void warning(String message)
This method is called when a warning level message needs to be logged. The message will be translated
warning in interface SessionLogmessage - the message key
public void info(String message)
This method is called when a info level message needs to be logged. The message will be translated
info in interface SessionLogmessage - the message key
public void config(String message)
This method is called when a config level message needs to be logged. The message will be translated
config in interface SessionLogmessage - the message key
public void fine(String message)
This method is called when a fine level message needs to be logged. The message will be translated
fine in interface SessionLogmessage - the message key
public void finer(String message)
This method is called when a finer level message needs to be logged. The message will be translated
finer in interface SessionLogmessage - the message key
public void finest(String message)
This method is called when a finest level message needs to be logged. The message will be translated
finest in interface SessionLogmessage - the message key
public void logThrowable(int level,
Throwable throwable)
Log a throwable with level.
logThrowable in interface SessionLoglevel - the log request level value
throwable - a Throwable
public void logThrowable(int level,
String category,
Throwable throwable)
Log a throwable with level.
logThrowable in interface SessionLoglevel - the log request level value
throwable - a Throwable
public boolean isOff()
public Object clone()
clone in interface SessionLogclone in class Objectpublic static String translateLoggingLevelToString(int loggingLevel)