Package org.eclipse.persistence.logging
Interface SessionLog
-
- All Superinterfaces:
java.lang.Cloneable
- All Known Implementing Classes:
AbstractSessionLog,DefaultSessionLog,JavaLog,ServerLog
public interface SessionLog extends java.lang.CloneableSessionLog 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:
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
Fields Modifier and Type Field Description static intALLstatic java.lang.StringALL_LABELstatic java.lang.StringCACHEstatic intCONFIGstatic java.lang.StringCONFIG_LABELstatic java.lang.StringCONNECTIONstatic java.lang.StringDBWSstatic java.lang.StringDDLstatic java.lang.StringDMSstatic java.lang.StringEJBstatic java.lang.StringEJB_OR_METADATADeprecated.useMETADATA.static java.lang.StringEVENTstatic intFINEstatic java.lang.StringFINE_LABELstatic intFINERstatic java.lang.StringFINER_LABELstatic intFINESTstatic java.lang.StringFINEST_LABELstatic intINFOstatic java.lang.StringINFO_LABELstatic java.lang.StringJPAstatic java.lang.StringJPARSstatic java.lang.String[]loggerCatagoriesstatic java.lang.StringMETADATAstatic java.lang.StringMETAMODELstatic java.lang.StringMISCstatic java.lang.StringMONITORINGstatic java.lang.StringMOXYstatic intOFFstatic java.lang.StringOFF_LABELstatic java.lang.StringPROCESSORModelGen logging name space.static java.lang.StringPROPAGATIONstatic java.lang.StringPROPERTIESstatic java.lang.StringQUERYstatic java.lang.StringSEQUENCINGstatic java.lang.StringSERVERstatic intSEVEREstatic java.lang.StringSEVERE_LABELstatic java.lang.StringSQLstatic java.lang.StringTHREADstatic java.lang.StringTRANSACTIONstatic intWARNINGstatic java.lang.StringWARNING_LABELstatic java.lang.StringWEAVER
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.Objectclone()PUBLIC: Clone the log.voidconfig(java.lang.String message)PUBLIC: This method is called when a config level message needs to be logged.voidfine(java.lang.String message)PUBLIC: This method is called when a fine level message needs to be logged.voidfiner(java.lang.String message)PUBLIC: This method is called when a finer level message needs to be logged.voidfinest(java.lang.String message)PUBLIC: This method is called when a finest level message needs to be logged.intgetLevel()PUBLIC: Return the log level.intgetLevel(java.lang.String category)PUBLIC: Return the log level; category is only needed where name space is available.java.lang.StringgetLevelString()PUBLIC:SessiongetSession()PUBLIC: Get the session that owns this SessionLog.java.io.WritergetWriter()PUBLIC: Return the writer to which an accessor writes logged messages and SQL.voidinfo(java.lang.String message)PUBLIC: This method is called when a info level message needs to be logged.voidlog(int level, java.lang.String message)PUBLIC: Log a message that does not need to be translated.voidlog(int level, java.lang.String message, java.lang.Object param)PUBLIC: Log a message with one parameter that needs to be translated.voidlog(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.voidlog(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.voidlog(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.voidlog(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.voidlog(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.voidlog(int level, java.lang.String category, java.lang.String message, java.lang.Object param)PUBLIC: Log a message with one parameter that needs to be translated.voidlog(int level, java.lang.String category, java.lang.String message, java.lang.Object[] arguments)PUBLIC: This method is called when the log request is from somewhere session is not available.voidlog(int level, java.lang.String category, 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.voidlog(int level, java.lang.String category, java.lang.String message, java.lang.Object param1, java.lang.Object param2)PUBLIC: Log a message with two parameters that needs to be translated.voidlog(int level, java.lang.String category, 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.voidlog(int level, java.lang.String category, 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.voidlog(SessionLogEntry entry)PUBLIC: EclipseLink will call this method whenever something needs to be logged (messages, SQL, etc.).voidlogThrowable(int level, java.lang.String category, java.lang.Throwable throwable)PUBLIC: Log a throwable with level.voidlogThrowable(int level, java.lang.Throwable throwable)PUBLIC: Log aThrowablewith level.voidsetLevel(int level)PUBLIC: Set the log level.voidsetLevel(int level, java.lang.String category)PUBLIC: Set the log level.voidsetSession(Session session)PUBLIC: Set the session that owns this SessionLog.voidsetShouldDisplayData(java.lang.Boolean shouldDisplayData)Set whether bind parameters should be displayed when logging SQL.voidsetShouldLogExceptionStackTrace(boolean flag)By default stack trace is logged for SEVERE all the time and at FINER level for WARNING or less.voidsetShouldPrintConnection(boolean flag)By default the connection is always printed whenever available, this can be turned off.voidsetShouldPrintDate(boolean flag)By default date is printed, this can be turned off.voidsetShouldPrintSession(boolean flag)By default the Session is always printed whenever available, this can be turned off.voidsetShouldPrintThread(boolean flag)By default the thread is logged at FINE or less level, this can be turned off.voidsetWriter(java.io.Writer log)PUBLIC: Set the writer to which an accessor writes logged messages and SQL.voidsevere(java.lang.String message)PUBLIC: This method is called when a severe level message needs to be logged.booleanshouldDisplayData()Return whether bind parameters should be displayed when logging SQL, default is true.booleanshouldLog(int level)PUBLIC: Check if a message of the given level would actually be logged.booleanshouldLog(int level, java.lang.String category)PUBLIC: Check if a message of the given level would actually be logged.booleanshouldLogExceptionStackTrace()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.booleanshouldPrintConnection()By default the connection is always printed whenever available, this can be turned off.booleanshouldPrintDate()By default the date is always printed, this can be turned off.booleanshouldPrintSession()By default the Session is always printed whenever available, this can be turned off.booleanshouldPrintThread()By default the thread is logged at FINE or less level, this can be turned off.voidthrowing(java.lang.Throwable throwable)PUBLIC: This method is called when a throwable at finer level needs to be logged.voidwarning(java.lang.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 java.lang.String OFF_LABEL
-
SEVERE
static final int SEVERE
- See Also:
- Constant Field Values
-
SEVERE_LABEL
static final java.lang.String SEVERE_LABEL
-
WARNING
static final int WARNING
- See Also:
- Constant Field Values
-
WARNING_LABEL
static final java.lang.String WARNING_LABEL
-
INFO
static final int INFO
- See Also:
- Constant Field Values
-
INFO_LABEL
static final java.lang.String INFO_LABEL
-
CONFIG
static final int CONFIG
- See Also:
- Constant Field Values
-
CONFIG_LABEL
static final java.lang.String CONFIG_LABEL
-
FINE
static final int FINE
- See Also:
- Constant Field Values
-
FINE_LABEL
static final java.lang.String FINE_LABEL
-
FINER
static final int FINER
- See Also:
- Constant Field Values
-
FINER_LABEL
static final java.lang.String FINER_LABEL
-
FINEST
static final int FINEST
- See Also:
- Constant Field Values
-
FINEST_LABEL
static final java.lang.String FINEST_LABEL
-
ALL
static final int ALL
- See Also:
- Constant Field Values
-
ALL_LABEL
static final java.lang.String ALL_LABEL
-
SQL
static final java.lang.String SQL
- See Also:
- Constant Field Values
-
TRANSACTION
static final java.lang.String TRANSACTION
- See Also:
- Constant Field Values
-
EVENT
static final java.lang.String EVENT
- See Also:
- Constant Field Values
-
CONNECTION
static final java.lang.String CONNECTION
- See Also:
- Constant Field Values
-
QUERY
static final java.lang.String QUERY
- See Also:
- Constant Field Values
-
CACHE
static final java.lang.String CACHE
- See Also:
- Constant Field Values
-
PROPAGATION
static final java.lang.String PROPAGATION
- See Also:
- Constant Field Values
-
SEQUENCING
static final java.lang.String SEQUENCING
- See Also:
- Constant Field Values
-
JPA
static final java.lang.String JPA
- See Also:
- Constant Field Values
-
EJB
static final java.lang.String EJB
- See Also:
- Constant Field Values
-
DMS
static final java.lang.String DMS
- See Also:
- Constant Field Values
-
METADATA
static final java.lang.String METADATA
- See Also:
- Constant Field Values
-
MONITORING
static final java.lang.String MONITORING
- See Also:
- Constant Field Values
-
MISC
static final java.lang.String MISC
- See Also:
- Constant Field Values
-
MOXY
static final java.lang.String MOXY
- See Also:
- Constant Field Values
-
EJB_OR_METADATA
@Deprecated static final java.lang.String EJB_OR_METADATA
Deprecated.useMETADATA.- See Also:
- Constant Field Values
-
METAMODEL
static final java.lang.String METAMODEL
- See Also:
- Constant Field Values
-
WEAVER
static final java.lang.String WEAVER
- See Also:
- Constant Field Values
-
PROPERTIES
static final java.lang.String PROPERTIES
- See Also:
- Constant Field Values
-
SERVER
static final java.lang.String SERVER
- See Also:
- Constant Field Values
-
DDL
static final java.lang.String DDL
- See Also:
- Constant Field Values
-
DBWS
static final java.lang.String DBWS
- See Also:
- Constant Field Values
-
JPARS
static final java.lang.String JPARS
- See Also:
- Constant Field Values
-
PROCESSOR
static final java.lang.String PROCESSOR
ModelGen logging name space.- See Also:
- Constant Field Values
-
THREAD
static final java.lang.String THREAD
- See Also:
- Constant Field Values
-
loggerCatagories
static final java.lang.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(java.lang.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
java.io.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(java.io.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
java.lang.String getLevelString()
PUBLIC:Return the log level as a string value.
-
getLevel
int getLevel(java.lang.String category)
PUBLIC: Return the log level; category is only needed where name space is available.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 the logging name space are:
CACHE= "cache" CONNECTION= "connection" DMS= "dms" EJB= "ejb" EJB_OR_METADATA= "metadata" 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, java.lang.String category)PUBLIC: Set the log level. Category is only needed where name space is available.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 the logging name space are:
CACHE= "cache" CONNECTION= "connection" DMS= "dms" EJB= "ejb" EJB_OR_METADATA= "metadata" 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, java.lang.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:
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:
CACHE= "cache" CONNECTION= "connection" DMS= "dms" EJB= "ejb" EJB_OR_METADATA= "metadata" EVENT= "event" DBWS= "dbws" JPARS= "jpars" METAMODEL= "metamodel" MOXY= "moxy" PROCESSOR= "processor" PROPAGATION= "propagation" PROPERTIES= "properties" QUERY= "query" SEQUENCING= "sequencing" SERVER= "server" SQL= "sql" TRANSACTION= "transaction" WEAVER= "weaver"
-
log
void log(int level, java.lang.String message)
-
log
void log(int level, java.lang.String message, java.lang.Object param)
-
log
void log(int level, java.lang.String category, java.lang.String message, java.lang.Object param)
-
log
void log(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2)
-
log
void log(int level, java.lang.String category, java.lang.String message, java.lang.Object param1, java.lang.Object param2)
-
log
void log(int level, java.lang.String message, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3)
-
log
void log(int level, java.lang.String category, java.lang.String message, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3)
-
log
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
void log(int level, java.lang.String category, java.lang.String message, java.lang.Object param1, java.lang.Object param2, java.lang.Object param3, java.lang.Object param4)
-
log
void log(int level, java.lang.String message, java.lang.Object[] arguments)
-
log
void log(int level, java.lang.String category, java.lang.String message, java.lang.Object[] arguments)
-
log
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. shouldTranslate flag determines if the message needs to be translated.The EclipseLink logging levels available are:
ALL= 0 FINEST= 1 FINER= 2 FINE= 3 CONFIG= 4 INFO= 5 WARNING= 6 SEVERE= 7 OFF= 8
-
log
void log(int level, java.lang.String category, 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. shouldTranslate flag determines if the message needs to be translated.The EclipseLink logging levels available are:
ALL= 0 FINEST= 1 FINER= 2 FINE= 3 CONFIG= 4 INFO= 5 WARNING= 6 SEVERE= 7 OFF= 8
-
throwing
void throwing(java.lang.Throwable throwable)
PUBLIC: This method is called when a throwable at finer level needs to be logged.
-
severe
void severe(java.lang.String message)
PUBLIC: This method is called when a severe level message needs to be logged. The message will be translated
-
warning
void warning(java.lang.String message)
PUBLIC: This method is called when a warning level message needs to be logged. The message will be translated
-
info
void info(java.lang.String message)
PUBLIC: This method is called when a info level message needs to be logged. The message will be translated
-
config
void config(java.lang.String message)
PUBLIC: This method is called when a config level message needs to be logged. The message will be translated
-
fine
void fine(java.lang.String message)
PUBLIC: This method is called when a fine level message needs to be logged. The message will be translated
-
finer
void finer(java.lang.String message)
PUBLIC: This method is called when a finer level message needs to be logged. The message will be translated
-
finest
void finest(java.lang.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, java.lang.Throwable throwable)
-
logThrowable
void logThrowable(int level, java.lang.String category, java.lang.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
java.lang.Object clone()
PUBLIC: Clone the log.
-
-