DefaultSessionLog (EclipseLink 2.6.0, API Reference)

java.lang.Object
- org.eclipse.persistence.logging.AbstractSessionLog
- - org.eclipse.persistence.logging.DefaultSessionLog

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, SessionLog
```
public class DefaultSessionLog
extends AbstractSessionLog
implements java.io.Serializable
```
Purpose: Default log used for the session when message logging is enabled. The session can log information such as,
- all SQL executed
- informational messages
- debugging information
- all exceptions that occur within TopLink
As well information about the message can be logged such as,
- the session logging the message
- the connection executing the SQL
- the thread in which the log entry occurred
- the exact time (to milliseconds) that the log entry occurred
- the stack trace to the exception
See Also:
SessionLog, AbstractSessionLog, Serialized Form
Author:

Big Country

Field Summary

Fields
Modifier and Type Field and Description

protected java.lang.String fileName
The filename associated with this DefaultSessionLog, if it is being written out to a file
- Fields inherited from class org.eclipse.persistence.logging.AbstractSessionLog
  CONFIG_PREFIX, CONNECTION_STRING, DATE_FORMAT_STR, dateFormat, defaultLog, FINE_PREFIX, FINER_PREFIX, FINEST_PREFIX, INFO_PREFIX, level, session, SEVERE_PREFIX, shouldDisplayData, shouldLogExceptionStackTrace, shouldPrintConnection, shouldPrintDate, shouldPrintSession, shouldPrintThread, THREAD_STRING, TOPLINK_PREFIX, WARNING_PREFIX, writer
- Fields inherited from interface org.eclipse.persistence.logging.SessionLog
  ALL, 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, MISC, MONITORING, OFF, OFF_LABEL, PROPAGATION, PROPERTIES, QUERY, SEQUENCING, SERVER, SEVERE, SEVERE_LABEL, SQL, TRANSACTION, WARNING, WARNING_LABEL, WEAVER

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`fileName` The filename associated with this DefaultSessionLog, if it is being written out to a file

Constructor Summary

Constructors
Constructor and Description

DefaultSessionLog()

DefaultSessionLog(java.io.Writer writer)

Constructors
Constructor and Description
`DefaultSessionLog()`
`DefaultSessionLog(java.io.Writer writer)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getLevel(java.lang.String category)` PUBLIC: Return the log level for the category name space.
`java.lang.String`	`getWriterFilename()` For the given writer, return it's associated filename.
`protected void`	`initialize()` Initialize the log to be backward-compatible with the original TopLink log.
`protected void`	`initialize(java.io.Writer writer)` Initialize the log.
`void`	`log(SessionLogEntry entry)` Log the entry.
`void`	`setLevel(int level, java.lang.String category)` PUBLIC: Set the log level for the category name space.
`void`	`setWriter(java.lang.String aFileName)` Set the writer that will receive the formatted log entries for a file name.
`boolean`	`shouldLog(int level, java.lang.String category)` Check if a message of the given level would actually be logged by the logger with name space built from the given session and category.
`protected void`	`writeMessage(java.lang.String message)` Append the specified message information to the writer.
`protected void`	`writeSeparator()` Append the separator string to the writer.

Methods inherited from class org.eclipse.persistence.logging.AbstractSessionLog
clone, config, fine, finer, finest, formatMessage, getConnectionString, getDateFormat, getDateString, getDefaultLoggingLevel, getLevel, getLevelString, getLog, getSession, getSessionString, getSupplementDetailString, getThreadString, getWriter, info, isOff, log, log, log, log, log, log, log, log, log, log, log, log, log, logThrowable, logThrowable, printPrefixString, setDateFormat, setLevel, setLog, setSession, setShouldDisplayData, setShouldLogExceptionStackTrace, setShouldPrintConnection, setShouldPrintDate, setShouldPrintSession, setShouldPrintThread, setWriter, setWriter, severe, shouldDisplayData, shouldLog, shouldLogExceptionStackTrace, shouldPrintConnection, shouldPrintDate, shouldPrintSession, shouldPrintThread, throwing, translateLoggingLevelToString, translateStringToLoggingLevel, warning

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - fileName
```
protected java.lang.String fileName
```
    The filename associated with this DefaultSessionLog, if it is being written out to a file
- Constructor Detail
  - DefaultSessionLog
```
public DefaultSessionLog()
```
  - DefaultSessionLog
```
public DefaultSessionLog(java.io.Writer writer)
```
- Method Detail
  - setLevel
```
public void setLevel(int level,
            java.lang.String category)
```
    Description copied from class: AbstractSessionLog
    
    PUBLIC:
    Set the log level for the category name space.
    
    Specified by:
    
    setLevel in interface SessionLog
    
    Overrides:
    
    setLevel in class AbstractSessionLog
    
    Parameters:
    level - the new log level
    category - the string representation of an EclipseLink category, e.g. "sql", "transaction" ...
  - getLevel
```
public int getLevel(java.lang.String category)
```
    Description copied from class: AbstractSessionLog
    
    PUBLIC:
    Return the log level for the category name space.
    
    Specified by:
    
    getLevel in interface SessionLog
    
    Overrides:
    
    getLevel in class AbstractSessionLog
    
    Parameters:
    category - the string representation of a EclipseLink category, e.g. "sql", "transaction" ...
    
    Returns:
    the log level
  - shouldLog
```
public boolean shouldLog(int level,
                java.lang.String category)
```
    Check if a message of the given level would actually be logged by the logger with name space built from the given session and category.
    
    Specified by:
    
    shouldLog in interface SessionLog
    
    Overrides:
    
    shouldLog in class AbstractSessionLog
    
    Parameters:
    level - the log request level
    category - the string representation of an EclipseLink category, e.g. "sql", "transaction" ...*
    
    Returns:
    true if the given message level will be logged for the given category
  - initialize
```
protected void initialize()
```
    Initialize the log to be backward-compatible with the original TopLink log.
  - initialize
```
protected void initialize(java.io.Writer writer)
```
    Initialize the log.
  - log
```
public void log(SessionLogEntry entry)
```
    Log the entry. This writes the log entries information to a writer such as System.out or a file.
    
    Specified by:
    
    log in interface SessionLog
    
    Specified by:
    
    log in class AbstractSessionLog
    
    Parameters:
    entry - SessionLogEntry that holds all the information for an EclipseLink logging event
  - setWriter
```
public void setWriter(java.lang.String aFileName)
```
    Set the writer that will receive the formatted log entries for a file name.
  - getWriterFilename
```
public java.lang.String getWriterFilename()
```
    For the given writer, return it's associated filename. If associated writer does not have a filename, return null.
  - writeMessage
```
protected void writeMessage(java.lang.String message)
                     throws java.io.IOException
```
    Append the specified message information to the writer.
    
    Throws:
    
    java.io.IOException
  - writeSeparator
```
protected void writeSeparator()
                       throws java.io.IOException
```
    Append the separator string to the writer.
    
    Throws:
    
    java.io.IOException

Class DefaultSessionLog

Field Summary

Fields inherited from class org.eclipse.persistence.logging.AbstractSessionLog

Fields inherited from interface org.eclipse.persistence.logging.SessionLog

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.persistence.logging.AbstractSessionLog

Methods inherited from class java.lang.Object

Field Detail

fileName

Constructor Detail

DefaultSessionLog

DefaultSessionLog

Method Detail

setLevel

getLevel

shouldLog

initialize

initialize

log

setWriter

getWriterFilename

writeMessage

writeSeparator