|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SessionLog
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:
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:
SQL | = "sql" | ||
TRANSACTION | = "transaction" | ||
EVENT | = "event" | ||
QUERY | = "query" | ||
CACHE | = "cache" | ||
PROPAGATION | = "propagation" | ||
SEQUENCING | = "sequencing" | ||
EJB | = "ejb" | ||
DMS | = "dms" | ||
EJB_ANNOTATION | = "ejb_annotation" | ||
WEAVER | = "weaver" |
AbstractSessionLog
,
SessionLogEntry
,
Session
Field Summary | |
---|---|
static int |
ALL
|
static String |
ALL_LABEL
|
static String |
CACHE
|
static int |
CONFIG
|
static String |
CONFIG_LABEL
|
static String |
CONNECTION
|
static String |
DMS
|
static String |
EJB
|
static String |
EJB_OR_METADATA
|
static String |
EVENT
|
static int |
FINE
|
static String |
FINE_LABEL
|
static int |
FINER
|
static String |
FINER_LABEL
|
static int |
FINEST
|
static String |
FINEST_LABEL
|
static int |
INFO
|
static String |
INFO_LABEL
|
static String[] |
loggerCatagories
|
static String |
METAMODEL
|
static int |
OFF
|
static String |
OFF_LABEL
|
static String |
PROPAGATION
|
static String |
PROPERTIES
|
static String |
QUERY
|
static String |
SEQUENCING
|
static String |
SERVER
|
static int |
SEVERE
|
static String |
SEVERE_LABEL
|
static String |
SQL
|
static String |
TRANSACTION
|
static int |
WARNING
|
static String |
WARNING_LABEL
|
static String |
WEAVER
|
Method Summary | |
---|---|
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(SessionLogEntry entry)
PUBLIC: EclipseLink will call this method whenever something needs to be logged (messages, SQL, etc.). |
void |
logThrowable(int level,
Throwable throwable)
PUBLIC: Log a throwable 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 |
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 |
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 |
---|
static final int OFF
static final String OFF_LABEL
static final int SEVERE
static final String SEVERE_LABEL
static final int WARNING
static final String WARNING_LABEL
static final int INFO
static final String INFO_LABEL
static final int CONFIG
static final String CONFIG_LABEL
static final int FINE
static final String FINE_LABEL
static final int FINER
static final String FINER_LABEL
static final int FINEST
static final String FINEST_LABEL
static final int ALL
static final String ALL_LABEL
static final String SQL
static final String TRANSACTION
static final String EVENT
static final String CONNECTION
static final String QUERY
static final String CACHE
static final String PROPAGATION
static final String SEQUENCING
static final String EJB
static final String DMS
static final String EJB_OR_METADATA
static final String METAMODEL
static final String WEAVER
static final String PROPERTIES
static final String SERVER
static final String[] loggerCatagories
Method Detail |
---|
void log(SessionLogEntry entry)
entry
- org.eclipse.persistence.sessions.LogEntryboolean shouldLogExceptionStackTrace()
boolean shouldPrintDate()
boolean shouldPrintThread()
boolean shouldPrintConnection()
boolean shouldPrintSession()
void setShouldLogExceptionStackTrace(boolean flag)
void setShouldPrintDate(boolean flag)
void setShouldPrintThread(boolean flag)
void setShouldPrintConnection(boolean flag)
void setShouldPrintSession(boolean flag)
Writer getWriter()
void setWriter(Writer log)
int getLevel()
The EclipseLink logging levels returned correspond to:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
String getLevelString()
Return the log level as a string value.
int getLevel(String category)
The EclipseLink logging levels returned correspond to:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
The EclipseLink categories for logging name space are:
SQL | = "sql" | |
TRANSACTION | = "transaction" | |
EVENT | = "event" | |
QUERY | = "query" | |
CACHE | = "cache" | |
PROPAGATION | = "propagation" | |
SEQUENCING | = "sequencing" | |
EJB | = "ejb" | |
DMS | = "dms" | |
EJB_ANNOTATION | = "ejb_annotation" | |
WEAVER | = "weaver" | |
PROPERTIES | = "properties" | |
SERVER | = "server" |
void setLevel(int level)
The EclipseLink logging levels available are:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
void setLevel(int level, String category)
The EclipseLink logging levels available are:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
The EclipseLink categories for logging name space are:
SQL | = "sql" | |
TRANSACTION | = "transaction" | |
EVENT | = "event" | |
QUERY | = "query" | |
CACHE | = "cache" | |
PROPAGATION | = "propagation" | |
SEQUENCING | = "sequencing" | |
EJB | = "ejb" | |
DMS | = "dms" | |
EJB_ANNOTATION | = "ejb_annotation" | |
WEAVER | = "weaver" |
boolean shouldLog(int level)
The EclipseLink logging levels available are:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
boolean shouldLog(int level, String category)
The EclipseLink logging levels available are:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
The EclipseLink categories for logging name space are:
SQL | = "sql" | |
TRANSACTION | = "transaction" | |
EVENT | = "event" | |
QUERY | = "query" | |
CACHE | = "cache" | |
PROPAGATION | = "propagation" | |
SEQUENCING | = "sequencing" | |
EJB | = "ejb" | |
DMS | = "dms" | |
EJB_ANNOTATION | = "ejb_annotation" | |
WEAVER | = "weaver" |
void log(int level, String message)
The EclipseLink logging levels available are:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
void log(int level, String message, Object param)
The EclipseLink logging levels available are:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
void log(int level, String message, Object param1, Object param2)
The EclipseLink logging levels available are:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
void log(int level, String message, Object param1, Object param2, Object param3)
The EclipseLink logging levels available are:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
void log(int level, String message, Object[] arguments)
The EclipseLink logging levels available are:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
void log(int level, String message, Object[] arguments, boolean shouldTranslate)
The EclipseLink logging levels available are:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
void throwing(Throwable throwable)
void severe(String message)
void warning(String message)
void info(String message)
void config(String message)
void fine(String message)
void finer(String message)
void finest(String message)
void logThrowable(int level, Throwable throwable)
The EclipseLink logging levels available are:
ALL | = 0 | |
FINEST | = 1 | |
FINER | = 2 | |
FINE | = 3 | |
CONFIG | = 4 | |
INFO | = 5 | |
WARNING | = 6 | |
SEVERE | = 7 | |
OFF | = 8 |
Session getSession()
void setSession(Session session)
Object clone()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |