Interface SessionLog
-
- All Superinterfaces:
Cloneable
- All Known Implementing Classes:
AbstractSessionLog
,DefaultSessionLog
,JavaLog
,ServerLog
public interface SessionLog extends Cloneable
SessionLog is the ever-so-simple interface used by EclipseLink to log generated messages and SQL. An implementor of this interface can be passed to the EclipseLink 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.This class defines EclipseLink logging levels (that are used throughout EclipseLink code) with the following integer values:
Logging levels ALL = 0 FINEST = 1 FINER = 2 FINE = 3 CONFIG = 4 INFO = 5 WARNING = 6 SEVERE = 7 OFF = 8 In addition, EclipseLink categories used for logging name space are defined with the following String values:
Logging categories CACHE
= "cache" CONNECTION
= "connection" DMS
= "dms" EJB
= "ejb" EVENT
= "event" DBWS
= "dbws" JPARS
= "jpars" METADATA
= "metadata" METAMODEL
= "metamodel" MOXY
= "moxy" PROCESSOR
= "processor" PROPAGATION
= "propagation" PROPERTIES
= "properties" QUERY
= "query" SEQUENCING
= "sequencing" SERVER
= "server" SQL
= "sql" THREAD
= "thread" TRANSACTION
= "transaction" WEAVER
= "weaver" - See Also:
AbstractSessionLog
,SessionLogEntry
,Session
- Since:
- TOPLink/Java 3.0
-
-
Field Summary
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Object
clone()
PUBLIC: Clone the log.void
config(String message)
PUBLIC: This method is called when a config level message needs to be logged.void
fine(String message)
PUBLIC: This method is called when a fine level message needs to be logged.void
finer(String message)
PUBLIC: This method is called when a finer level message needs to be logged.void
finest(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(String category)
PUBLIC: Return the log level; category is only needed where name space is available.String
getLevelString()
PUBLIC:Session
getSession()
PUBLIC: Get the session that owns this SessionLog.Writer
getWriter()
PUBLIC: Return the writer to which an accessor writes logged messages and SQL.void
info(String message)
PUBLIC: This method is called when a info level message needs to be logged.void
log(int level, String message)
PUBLIC: Log a message that does not need to be translated.void
log(int level, String message, Object param)
PUBLIC: Log a message with one parameter that needs to be translated.void
log(int level, String message, Object[] arguments)
PUBLIC: This method is called when the log request is from somewhere session is not available.void
log(int level, String message, Object[] arguments, boolean shouldTranslate)
PUBLIC: This method is called when the log request is from somewhere session is not available.void
log(int level, String message, Object param1, Object param2)
PUBLIC: Log a message with two parameters that needs to be translated.void
log(int level, String message, Object param1, Object param2, Object param3)
PUBLIC: Log a message with three parameters that needs to be translated.void
log(int level, String message, Object param1, Object param2, Object param3, Object param4)
PUBLIC: Log a message with four parameters that needs to be translated.void
log(int level, String category, String message, Object param)
PUBLIC: Log a message with one parameter that needs to be translated.void
log(int level, String category, String message, Object[] arguments)
PUBLIC: This method is called when the log request is from somewhere session is not available.void
log(int level, String category, String message, Object[] arguments, boolean shouldTranslate)
PUBLIC: This method is called when the log request is from somewhere session is not available.void
log(int level, String category, String message, Object param1, Object param2)
PUBLIC: Log a message with two parameters that needs to be translated.void
log(int level, String category, String message, Object param1, Object param2, Object param3)
PUBLIC: Log a message with three parameters that needs to be translated.void
log(int level, String category, String message, Object param1, Object param2, Object param3, Object param4)
PUBLIC: Log a message with four parameters that needs to be translated.void
log(SessionLogEntry entry)
PUBLIC: EclipseLink will call this method whenever something needs to be logged (messages, SQL, etc.).void
logThrowable(int level, String category, Throwable throwable)
PUBLIC: Log a throwable with level.void
logThrowable(int level, Throwable throwable)
PUBLIC: Log aThrowable
with level.void
setLevel(int level)
PUBLIC: Set the log level.void
setLevel(int level, String category)
PUBLIC: Set the log level.void
setSession(Session session)
PUBLIC: Set the session that owns this SessionLog.void
setShouldDisplayData(Boolean shouldDisplayData)
Set whether bind parameters should be displayed when logging SQL.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(Writer log)
PUBLIC: Set the writer to which an accessor writes logged messages and SQL.void
severe(String message)
PUBLIC: This method is called when a severe level message needs to be logged.boolean
shouldDisplayData()
Return whether bind parameters should be displayed when logging SQL, default is true.boolean
shouldLog(int level)
PUBLIC: Check if a message of the given level would actually be logged.boolean
shouldLog(int level, 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(Throwable throwable)
PUBLIC: This method is called when a throwable at finer level needs to be logged.void
warning(String message)
PUBLIC: This method is called when a warning level message needs to be logged.
-
-
-
Field Detail
-
OFF
static final int OFF
- See Also:
- Constant Field Values
-
OFF_LABEL
static final String OFF_LABEL
-
SEVERE
static final int SEVERE
- See Also:
- Constant Field Values
-
SEVERE_LABEL
static final String SEVERE_LABEL
-
WARNING
static final int WARNING
- See Also:
- Constant Field Values
-
WARNING_LABEL
static final String WARNING_LABEL
-
INFO
static final int INFO
- See Also:
- Constant Field Values
-
INFO_LABEL
static final String INFO_LABEL
-
CONFIG
static final int CONFIG
- See Also:
- Constant Field Values
-
CONFIG_LABEL
static final String CONFIG_LABEL
-
FINE
static final int FINE
- See Also:
- Constant Field Values
-
FINE_LABEL
static final String FINE_LABEL
-
FINER
static final int FINER
- See Also:
- Constant Field Values
-
FINER_LABEL
static final String FINER_LABEL
-
FINEST
static final int FINEST
- See Also:
- Constant Field Values
-
FINEST_LABEL
static final String FINEST_LABEL
-
ALL
static final int ALL
- See Also:
- Constant Field Values
-
ALL_LABEL
static final String ALL_LABEL
-
SQL
static final String SQL
- See Also:
- Constant Field Values
-
TRANSACTION
static final String TRANSACTION
- See Also:
- Constant Field Values
-
EVENT
static final String EVENT
- See Also:
- Constant Field Values
-
CONNECTION
static final String CONNECTION
- See Also:
- Constant Field Values
-
QUERY
static final String QUERY
- See Also:
- Constant Field Values
-
CACHE
static final String CACHE
- See Also:
- Constant Field Values
-
PROPAGATION
static final String PROPAGATION
- See Also:
- Constant Field Values
-
SEQUENCING
static final String SEQUENCING
- See Also:
- Constant Field Values
-
JPA
static final String JPA
- See Also:
- Constant Field Values
-
EJB
static final String EJB
- See Also:
- Constant Field Values
-
DMS
static final String DMS
- See Also:
- Constant Field Values
-
METADATA
static final String METADATA
- See Also:
- Constant Field Values
-
MONITORING
static final String MONITORING
- See Also:
- Constant Field Values
-
MISC
static final String MISC
- See Also:
- Constant Field Values
-
MOXY
static final String MOXY
- See Also:
- Constant Field Values
-
METAMODEL
static final String METAMODEL
- See Also:
- Constant Field Values
-
WEAVER
static final String WEAVER
- See Also:
- Constant Field Values
-
PROPERTIES
static final String PROPERTIES
- See Also:
- Constant Field Values
-
SERVER
static final String SERVER
- See Also:
- Constant Field Values
-
DDL
static final String DDL
- See Also:
- Constant Field Values
-
DBWS
static final String DBWS
- See Also:
- Constant Field Values
-
JPARS
static final String JPARS
- See Also:
- Constant Field Values
-
PROCESSOR
static final String PROCESSOR
ModelGen logging name space.- See Also:
- Constant Field Values
-
THREAD
static final String THREAD
- See Also:
- Constant Field Values
-
loggerCatagories
static final String[] loggerCatagories
-
-
Method Detail
-
log
void log(SessionLogEntry entry)
PUBLIC: EclipseLink will call this method whenever something needs to be logged (messages, SQL, etc.). All the pertinent information will be contained in the specified entry.- Parameters:
entry
- org.eclipse.persistence.sessions.LogEntry
-
shouldLogExceptionStackTrace
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.
-
shouldPrintDate
boolean shouldPrintDate()
By default the date is always printed, this can be turned off.
-
shouldPrintThread
boolean shouldPrintThread()
By default the thread is logged at FINE or less level, this can be turned off.
-
shouldDisplayData
boolean shouldDisplayData()
Return whether bind parameters should be displayed when logging SQL, default is true.
-
shouldPrintConnection
boolean shouldPrintConnection()
By default the connection is always printed whenever available, this can be turned off.
-
shouldPrintSession
boolean shouldPrintSession()
By default the Session is always printed whenever available, this can be turned off.
-
setShouldDisplayData
void setShouldDisplayData(Boolean shouldDisplayData)
Set whether bind parameters should be displayed when logging SQL.
-
setShouldLogExceptionStackTrace
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.
-
setShouldPrintDate
void setShouldPrintDate(boolean flag)
By default date is printed, this can be turned off.
-
setShouldPrintThread
void setShouldPrintThread(boolean flag)
By default the thread is logged at FINE or less level, this can be turned off.
-
setShouldPrintConnection
void setShouldPrintConnection(boolean flag)
By default the connection is always printed whenever available, this can be turned off.
-
setShouldPrintSession
void setShouldPrintSession(boolean flag)
By default the Session is always printed whenever available, this can be turned off.
-
getWriter
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.
-
setWriter
void setWriter(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.
-
getLevel
int getLevel()
-
getLevelString
String getLevelString()
PUBLIC:Return the log level as a string value.
-
getLevel
int getLevel(String category)
PUBLIC: Return the log level; category is only needed where name space is available.The EclipseLink logging levels returned correspond to:
Logging levels ALL
= 0 FINEST
= 1 FINER
= 2 FINE
= 3 CONFIG
= 4 INFO
= 5 WARNING
= 6 SEVERE
= 7 OFF
= 8 The EclipseLink categories for the logging name space are:
Logging categories CACHE
= "cache" CONNECTION
= "connection" DMS
= "dms" EJB
= "ejb" EVENT
= "event" DBWS
= "dbws" JPARS
= "jpars" METAMODEL
= "metamodel" MOXY
= "moxy" PROCESSOR
= "processor" PROPAGATION
= "propagation" PROPERTIES
= "properties" QUERY
= "query" SEQUENCING
= "sequencing" SERVER
= "server" SQL
= "sql" THREAD
= "thread" TRANSACTION
= "transaction" WEAVER
= "weaver"
-
setLevel
void setLevel(int level)
-
setLevel
void setLevel(int level, String category)
PUBLIC: Set the log level. Category is only needed where name space is available.The EclipseLink logging levels available are:
Logging levels ALL
= 0 FINEST
= 1 FINER
= 2 FINE
= 3 CONFIG
= 4 INFO
= 5 WARNING
= 6 SEVERE
= 7 OFF
= 8 The EclipseLink categories for the logging name space are:
Logging categories CACHE
= "cache" CONNECTION
= "connection" DMS
= "dms" EJB
= "ejb" EVENT
= "event" DBWS
= "dbws" JPARS
= "jpars" METAMODEL
= "metamodel" MOXY
= "moxy" PROCESSOR
= "processor" PROPAGATION
= "propagation" PROPERTIES
= "properties" QUERY
= "query" SEQUENCING
= "sequencing" SERVER
= "server" SQL
= "sql" THREAD
= "thread" TRANSACTION
= "transaction" WEAVER
= "weaver"
-
shouldLog
boolean shouldLog(int level)
-
shouldLog
boolean shouldLog(int level, String category)
PUBLIC: Check if a message of the given level would actually be logged. Category is only needed where name space is available.The EclipseLink logging levels available are:
Logging levels ALL
= 0 FINEST
= 1 FINER
= 2 FINE
= 3 CONFIG
= 4 INFO
= 5 WARNING
= 6 SEVERE
= 7 OFF
= 8 The EclipseLink categories for the logging name space are:
Logging categories CACHE
= "cache" CONNECTION
= "connection" DMS
= "dms" EJB
= "ejb" EVENT
= "event" DBWS
= "dbws" JPARS
= "jpars" METAMODEL
= "metamodel" MOXY
= "moxy" PROCESSOR
= "processor" PROPAGATION
= "propagation" PROPERTIES
= "properties" QUERY
= "query" SEQUENCING
= "sequencing" SERVER
= "server" SQL
= "sql" THREAD
= "thread" TRANSACTION
= "transaction" WEAVER
= "weaver"
-
log
void log(int level, 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 EclipseLink output.The EclipseLink logging levels available are:
Logging levels ALL
= 0 FINEST
= 1 FINER
= 2 FINE
= 3 CONFIG
= 4 INFO
= 5 WARNING
= 6 SEVERE
= 7 OFF
= 8
-
log
void log(int level, String category, String message, Object param1, Object param2, Object param3)
-
log
void log(int level, String message, Object param1, Object param2, Object param3, Object param4)
-
log
void log(int level, String category, String message, Object param1, Object param2, Object param3, Object param4)
-
log
void log(int level, String message, Object[] arguments, boolean shouldTranslate)
PUBLIC: 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.The EclipseLink logging levels available are:
Logging levels ALL
= 0 FINEST
= 1 FINER
= 2 FINE
= 3 CONFIG
= 4 INFO
= 5 WARNING
= 6 SEVERE
= 7 OFF
= 8
-
log
void log(int level, String category, String message, Object[] arguments, boolean shouldTranslate)
PUBLIC: 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.The EclipseLink logging levels available are:
Logging levels ALL
= 0 FINEST
= 1 FINER
= 2 FINE
= 3 CONFIG
= 4 INFO
= 5 WARNING
= 6 SEVERE
= 7 OFF
= 8
-
throwing
void throwing(Throwable throwable)
PUBLIC: This method is called when a throwable at finer level needs to be logged.
-
severe
void severe(String message)
PUBLIC: This method is called when a severe level message needs to be logged. The message will be translated
-
warning
void warning(String message)
PUBLIC: This method is called when a warning level message needs to be logged. The message will be translated
-
info
void info(String message)
PUBLIC: This method is called when a info level message needs to be logged. The message will be translated
-
config
void config(String message)
PUBLIC: This method is called when a config level message needs to be logged. The message will be translated
-
fine
void fine(String message)
PUBLIC: This method is called when a fine level message needs to be logged. The message will be translated
-
finer
void finer(String message)
PUBLIC: This method is called when a finer level message needs to be logged. The message will be translated
-
finest
void finest(String message)
PUBLIC: This method is called when a finest level message needs to be logged. The message will be translated
-
logThrowable
void logThrowable(int level, Throwable throwable)
-
getSession
Session getSession()
PUBLIC: Get the session that owns this SessionLog.
-
setSession
void setSession(Session session)
PUBLIC: Set the session that owns this SessionLog.
-
clone
Object clone()
PUBLIC: Clone the log.
-
-