org.eclipse.persistence.logging

Class SessionLogEntry

java.lang.Object

org.eclipse.persistence.logging.SessionLogEntry

All Implemented Interfaces:

java.io.Serializable

public class SessionLogEntry
extends java.lang.Object
implements java.io.Serializable

SessionLogEntry is a simple container object that holds all the information pertinent to an EclipseLink logging event. It has a date/time stamp indicating when the event took place. It holds the session, thread, and accessor responsible for the event. And it holds whatever message was passed through to be logged.

Since:

TOPLink/Java 3.0

Author:

Big Country

See Also:

SessionLog, DefaultSessionLog, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SessionLogEntry(AbstractSession session)
SessionLogEntry(AbstractSession session, int level, java.lang.String category, java.lang.Throwable throwable) Create a new session log entry for a session, a level, a category and an exception.
SessionLogEntry(AbstractSession session, java.lang.String message)
SessionLogEntry(AbstractSession session, java.lang.String message, Accessor connection)
SessionLogEntry(AbstractSession session, java.lang.Throwable throwable)
SessionLogEntry(int level, AbstractSession session, java.lang.String message, java.lang.Object[] params, Accessor connection, boolean shouldTranslate) Create a new session log entry for a request level, a session, a message and an accessor.
SessionLogEntry(int level, java.lang.String category, AbstractSession session, java.lang.String message, java.lang.Object[] params, Accessor connection, boolean shouldTranslate) Create a new session log entry for a request level, a session, a message and an accessor.

Method Summary

Modifier and Type	Method and Description
Accessor	getConnection() Return the connection that generated the log entry.
java.util.Date	getDate() Return the date of the log entry.
java.lang.Throwable	getException() Return the exception that caused the log entry.
int	getLevel() Return the request level of the log entry.
java.lang.String	getMessage() Return the log entry's message.
java.lang.String	getNameSpace() Return the name space of the log entry.
java.lang.Object[]	getParameters()
AbstractSession	getSession() Return the session that generated the log entry.
java.lang.Thread	getThread() Return the thread that was active when the log entry was generated.
boolean	hasException()
boolean	hasMessage()
void	setConnection(Accessor connection) Set the connection that generated the log entry.
void	setDate(java.util.Date date) Set the date of the log entry.
void	setException(java.lang.Throwable throwable) Set the exception that caused the log entry.
void	setLevel(int level) Set the request level of the log entry.
void	setMessage(java.lang.String message) Set the entry's message.
void	setNameSpace(java.lang.String nameSpace) Set the name space of the log entry.
void	setParameters(java.lang.Object[] params) Set the array of parameters to the message.
void	setSession(AbstractSession session) Set the session that generated the log entry.
void	setShouldTranslate(boolean shouldTranslate) Set if the message should be translated.
void	setThread(java.lang.Thread thread) Set the thread that was active when the log entry was generated.
boolean	shouldTranslate()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SessionLogEntry

public SessionLogEntry(AbstractSession session)

SessionLogEntry

public SessionLogEntry(AbstractSession session,
                       java.lang.Throwable throwable)

SessionLogEntry

public SessionLogEntry(AbstractSession session,
                       java.lang.String message)

SessionLogEntry

public SessionLogEntry(AbstractSession session,
                       java.lang.String message,
                       Accessor connection)

SessionLogEntry

public SessionLogEntry(int level,
                       AbstractSession session,
                       java.lang.String message,
                       java.lang.Object[] params,
                       Accessor connection,
                       boolean shouldTranslate)

Create a new session log entry for a request level, a session, a message and an accessor.
Possible values for log level are listed in SessionLog.

See Also:

SessionLog

SessionLogEntry

public SessionLogEntry(int level,
                       java.lang.String category,
                       AbstractSession session,
                       java.lang.String message,
                       java.lang.Object[] params,
                       Accessor connection,
                       boolean shouldTranslate)

Create a new session log entry for a request level, a session, a message and an accessor.
Possible values for log level and category are listed in SessionLog.

See Also:

SessionLog

SessionLogEntry

public SessionLogEntry(AbstractSession session,
                       int level,
                       java.lang.String category,
                       java.lang.Throwable throwable)

Create a new session log entry for a session, a level, a category and an exception.
Possible values for log level and category are listed in SessionLog.

See Also:

SessionLog

Method Detail

getConnection

public Accessor getConnection()

Return the connection that generated the log entry.

getDate

public java.util.Date getDate()

Return the date of the log entry.

getException

public java.lang.Throwable getException()

Return the exception that caused the log entry.

getMessage

public java.lang.String getMessage()

Return the log entry's message.

getSession

public AbstractSession getSession()

Return the session that generated the log entry.

getThread

public java.lang.Thread getThread()

Return the thread that was active when the log entry was generated.

getLevel

public int getLevel()

Return the request level of the log entry.
Possible values for log level are listed in SessionLog.

See Also:

SessionLog

getNameSpace

public java.lang.String getNameSpace()

Return the name space of the log entry.
Possible values for log category (a String) are listed in SessionLog.

See Also:

SessionLog

getParameters

public java.lang.Object[] getParameters()

Returns:

the array of parameters to the message.

shouldTranslate

public boolean shouldTranslate()

Returns:

if the message should be translated.

hasException

public boolean hasException()

Returns:

if the log entry was for an exception.

hasMessage

public boolean hasMessage()

Returns:

if the log entry has a message

setConnection

public void setConnection(Accessor connection)

Set the connection that generated the log entry.

setDate

public void setDate(java.util.Date date)

Set the date of the log entry.

setException

public void setException(java.lang.Throwable throwable)

Set the exception that caused the log entry.

setMessage

public void setMessage(java.lang.String message)

Set the entry's message.

setSession

public void setSession(AbstractSession session)

Set the session that generated the log entry.

setThread

public void setThread(java.lang.Thread thread)

Set the thread that was active when the log entry was generated.

setLevel

public void setLevel(int level)

Set the request level of the log entry.
Possible values for log level are listed in SessionLog.

See Also:

SessionLog

setNameSpace

public void setNameSpace(java.lang.String nameSpace)

Set the name space of the log entry.
Possible values for log category (a String) are listed in SessionLog.

See Also:

SessionLog

setParameters

public void setParameters(java.lang.Object[] params)

Set the array of parameters to the message.

setShouldTranslate

public void setShouldTranslate(boolean shouldTranslate)

Set if the message should be translated.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object