SessionLog (toplink-essentials 2.0.46 API)

All Known Implementing Classes:

AbstractSessionLog, DefaultSessionLog, JavaLog, ServerLog
```
public interface SessionLog
```
SessionLog is the ever-so-simple interface used by TopLink to log generated messages and SQL. An implementor of this interface can be passed to the TopLink 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.

Since:

TOPLink/Java 3.0

See Also:

AbstractSessionLog, SessionLogEntry

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL`
`static String`	`CACHE`
`static int`	`CONFIG`
`static String`	`CONNECTION`
`static String`	`DMS`
`static String`	`EJB`
`static String`	`EJB_OR_METADATA`
`static String`	`EVENT`
`static int`	`FINE`
`static int`	`FINER`
`static int`	`FINEST`
`static int`	`INFO`
`static String[]`	`loggerCategories`
`static int`	`OFF`
`static String`	`PROPAGATION`
`static String`	`PROPERTIES`
`static String`	`QUERY`
`static String`	`SEQUENCING`
`static int`	`SEVERE`
`static String`	`SQL`
`static String`	`TRANSACTION`
`static int`	`WARNING`
`static String`	`WEAVER`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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.
`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)` INTERNAL: Log a message with one parameter that needs to be translated.
`void`	`log(int level, String message, Object[] arguments)` INTERNAL: 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)` INTERNAL: 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)` INTERNAL: Log a message with two parameters that needs to be translated.
`void`	`log(int level, String message, Object param1, Object param2, Object param3)` INTERNAL: Log a message with three parameters that needs to be translated.
`void`	`log(SessionLogEntry entry)` INTERNAL: TopLink 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
  - OFF
```
static final int OFF
```
    See Also:
    
    Constant Field Values
  - SEVERE
```
static final int SEVERE
```
    See Also:
    
    Constant Field Values
  - WARNING
```
static final int WARNING
```
    See Also:
    
    Constant Field Values
  - INFO
```
static final int INFO
```
    See Also:
    
    Constant Field Values
  - CONFIG
```
static final int CONFIG
```
    See Also:
    
    Constant Field Values
  - FINE
```
static final int FINE
```
    See Also:
    
    Constant Field Values
  - FINER
```
static final int FINER
```
    See Also:
    
    Constant Field Values
  - FINEST
```
static final int FINEST
```
    See Also:
    
    Constant Field Values
  - ALL
```
static final int ALL
```
    See Also:
    
    Constant Field Values
  - 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
  - EJB
```
static final String EJB
```
    See Also:
    
    Constant Field Values
  - DMS
```
static final String DMS
```
    See Also:
    
    Constant Field Values
  - EJB_OR_METADATA
```
static final String EJB_OR_METADATA
```
    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
  - loggerCategories
```
static final String[] loggerCategories
```
- Method Detail
  - log
```
void log(SessionLogEntry entry)
```
    INTERNAL: TopLink 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 - oracle.toplink.essentials.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.
  - 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.
  - 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()
```
    PUBLIC: Return the log level. Used when session is not available.
  - getLevel
```
int getLevel(String category)
```
    PUBLIC: Return the log level. category is only needed where name space is available.
  - setLevel
```
void setLevel(int level)
```
    PUBLIC: Set the log level. Used when session is not available.
  - setLevel
```
void setLevel(int level,
              String category)
```
    PUBLIC: Set the log level. Category is only needed where name space is available.
  - shouldLog
```
boolean shouldLog(int level)
```
    PUBLIC: Check if a message of the given level would actually be logged. Used when session is not available.
  - 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.
  - 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 TopLink output.
  - log
```
void log(int level,
         String message,
         Object param)
```
    INTERNAL: Log a message with one parameter that needs to be translated.
  - log
```
void log(int level,
         String message,
         Object param1,
         Object param2)
```
    INTERNAL: Log a message with two parameters that needs to be translated.
  - log
```
void log(int level,
         String message,
         Object param1,
         Object param2,
         Object param3)
```
    INTERNAL: Log a message with three parameters that needs to be translated.
  - log
```
void log(int level,
         String message,
         Object[] arguments)
```
    INTERNAL: This method is called when the log request is from somewhere session is not available. The message needs to be translated.
  - log
```
void log(int level,
         String message,
         Object[] arguments,
         boolean shouldTranslate)
```
    INTERNAL: 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.
  - 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)
```
    PUBLIC: Log a throwable with level.
  - getSession
```
Session getSession()
```
    PUBLIC: Get the session that owns this SessionLog.
  - setSession
```
void setSession(Session session)
```
    PUBLIC: Set the session that owns this SessionLog.

Interface SessionLog

Field Summary

Method Summary

Field Detail

OFF

SEVERE

WARNING

INFO

CONFIG

FINE

FINER

FINEST

ALL

SQL

TRANSACTION

EVENT

CONNECTION

QUERY

CACHE

PROPAGATION

SEQUENCING

EJB

DMS

EJB_OR_METADATA

WEAVER

PROPERTIES

loggerCategories

Method Detail

log

shouldLogExceptionStackTrace

shouldPrintDate

shouldPrintThread

shouldPrintConnection

shouldPrintSession

setShouldLogExceptionStackTrace

setShouldPrintDate

setShouldPrintThread

setShouldPrintConnection

setShouldPrintSession

getWriter

setWriter

getLevel

getLevel

setLevel

setLevel

shouldLog

shouldLog

log

log

log

log

log

log

throwing

severe

warning

info

config

fine

finer

finest

logThrowable

getSession

setSession