Package org.eclipse.persistence.logging
Class DefaultSessionLog
- 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
- 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 Description protected java.lang.StringfileNameThe 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, DBWS, 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, MOXY, OFF, OFF_LABEL, PROCESSOR, PROPAGATION, PROPERTIES, QUERY, SEQUENCING, SERVER, SEVERE, SEVERE_LABEL, SQL, THREAD, TRANSACTION, WARNING, WARNING_LABEL, WEAVER
-
-
Constructor Summary
Constructors Constructor Description DefaultSessionLog()DefaultSessionLog(java.io.Writer writer)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetLevel(java.lang.String category)PUBLIC:java.lang.StringgetWriterFilename()For the given writer, return it's associated filename.protected voidinitialize()Initialize the log to be backward-compatible with the original TopLink log.protected voidinitialize(java.io.Writer writer)Initialize the log.voidlog(SessionLogEntry entry)Log the entry.voidsetLevel(int level, java.lang.String category)PUBLIC:voidsetWriter(java.lang.String aFileName)Set the writer that will receive the formatted log entries for a file name.booleanshouldLog(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 voidwriteMessage(java.lang.String message)Append the specified message information to the writer.protected voidwriteSeparator()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
-
-
-
-
Method Detail
-
setLevel
public void setLevel(int level, java.lang.String category)Description copied from class:AbstractSessionLogPUBLIC:Set the log level for the category name space.
- Specified by:
setLevelin interfaceSessionLog- Overrides:
setLevelin classAbstractSessionLog- Parameters:
level- the new log levelcategory- the string representation of an EclipseLink category, e.g. "sql", "transaction" ...
-
getLevel
public int getLevel(java.lang.String category)
Description copied from class:AbstractSessionLogPUBLIC:Return the log level for the category name space.
- Specified by:
getLevelin interfaceSessionLog- Overrides:
getLevelin classAbstractSessionLog- 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:
shouldLogin interfaceSessionLog- Overrides:
shouldLogin classAbstractSessionLog- Parameters:
level- the log request levelcategory- 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:
login interfaceSessionLog- Specified by:
login classAbstractSessionLog- 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.IOExceptionAppend the specified message information to the writer.- Throws:
java.io.IOException
-
writeSeparator
protected void writeSeparator() throws java.io.IOExceptionAppend the separator string to the writer.- Throws:
java.io.IOException
-
-