oracle.toplink.essentials.logging

Class SessionLogEntry

java.lang.Object

oracle.toplink.essentials.logging.SessionLogEntry

All Implemented Interfaces:

Serializable

public class SessionLogEntry
extends Object
implements Serializable

SessionLogEntry is a simple container object that holds all the information pertinent to a TopLink 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

Field Summary

Fields

Modifier and Type	Field and Description
protected Accessor	connection
protected Date	date
protected int	level
protected String	message
protected String	nameSpace
protected Object[]	parameters
protected AbstractSession	session
protected boolean	shouldTranslate
protected Thread	thread
protected Throwable	throwable

Constructor Summary

Constructors

Constructor and Description
SessionLogEntry(AbstractSession session) PUBLIC: Create a new session log entry for a session
SessionLogEntry(AbstractSession session, int level, String category, Throwable throwable) PUBLIC: Create a new session log entry for a session, a level, a category and an exception
SessionLogEntry(AbstractSession session, String message) PUBLIC: Create a new session log entry for a session and a message
SessionLogEntry(AbstractSession session, String message, Accessor connection) PUBLIC: Create a new session log entry for a session, a message and an accessor
SessionLogEntry(AbstractSession session, Throwable throwable) PUBLIC: Create a new session log entry for a session and an exception
SessionLogEntry(int level, AbstractSession session, String message, Object[] params, Accessor connection, boolean shouldTranslate) PUBLIC: Create a new session log entry for a request level, a session, a message and an accessor
SessionLogEntry(int level, String category, AbstractSession session, String message, Object[] params, Accessor connection, boolean shouldTranslate) PUBLIC: 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() PUBLIC: Return the connection that generated the log entry.
Date	getDate() PUBLIC: Return the date of the log entry.
Throwable	getException() PUBLIC: Return the exception that caused the log entry.
int	getLevel() PUBLIC: Return the request level of the log entry.
String	getMessage() PUBLIC: Return the log entry's message.
String	getNameSpace() PUBLIC: Return the name space of the log entry.
Object[]	getParameters() PUBLIC: Return the array of parameters to the message.
AbstractSession	getSession() PUBLIC: Return the session that generated the log entry.
Thread	getThread() PUBLIC: Return the thread that was active when the log entry was generated.
boolean	hasException() PUBLIC: Return if the log entry was for an exception.
void	setConnection(Accessor connection) PUBLIC: Set the connection that generated the log entry.
void	setDate(Date date) PUBLIC: Set the date of the log entry.
void	setException(Throwable throwable) PUBLIC: Set the exception that caused the log entry.
void	setLevel(int level) PUBLIC: Set the request level of the log entry.
void	setMessage(String message) PUBLIC: Set the entry's message.
void	setNameSpace(String nameSpace) PUBLIC: Set the name space of the log entry.
void	setParameters(Object[] params) PUBLIC: Set the array of parameters to the message.
void	setSession(AbstractSession session) PUBLIC: Set the session that generated the log entry.
void	setShouldTranslate(boolean shouldTranslate) PUBLIC: Set if the message should be translated.
void	setThread(Thread thread) PUBLIC: Set the thread that was active when the log entry was generated.
boolean	shouldTranslate() PUBLIC: Return if the message should be translated.
String	toString() PUBLIC: Print message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

date

protected Date date

session

protected transient AbstractSession session

thread

protected transient Thread thread

connection

protected transient Accessor connection

message

protected String message

throwable

protected Throwable throwable

level

protected int level

nameSpace

protected String nameSpace

parameters

protected Object[] parameters

shouldTranslate

protected boolean shouldTranslate

Constructor Detail

SessionLogEntry

public SessionLogEntry(AbstractSession session)

PUBLIC: Create a new session log entry for a session

SessionLogEntry

public SessionLogEntry(AbstractSession session,
                       Throwable throwable)

PUBLIC: Create a new session log entry for a session and an exception

SessionLogEntry

public SessionLogEntry(AbstractSession session,
                       String message)

PUBLIC: Create a new session log entry for a session and a message

SessionLogEntry

public SessionLogEntry(AbstractSession session,
                       String message,
                       Accessor connection)

PUBLIC: Create a new session log entry for a session, a message and an accessor

SessionLogEntry

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

PUBLIC: Create a new session log entry for a request level, a session, a message and an accessor

SessionLogEntry

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

PUBLIC: Create a new session log entry for a request level, a session, a message and an accessor

SessionLogEntry

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

PUBLIC: Create a new session log entry for a session, a level, a category and an exception

Method Detail

getConnection

public Accessor getConnection()

PUBLIC: Return the connection that generated the log entry.

getDate

public Date getDate()

PUBLIC: Return the date of the log entry.

getException

public Throwable getException()

PUBLIC: Return the exception that caused the log entry.

getMessage

public String getMessage()

PUBLIC: Return the log entry's message.

getSession

public AbstractSession getSession()

PUBLIC: Return the session that generated the log entry.

getThread

public Thread getThread()

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

getLevel

public int getLevel()

PUBLIC: Return the request level of the log entry.

getNameSpace

public String getNameSpace()

PUBLIC: Return the name space of the log entry.

getParameters

public Object[] getParameters()

PUBLIC: Return the array of parameters to the message.

shouldTranslate

public boolean shouldTranslate()

PUBLIC: Return if the message should be translated.

hasException

public boolean hasException()

PUBLIC: Return if the log entry was for an exception.

setConnection

public void setConnection(Accessor connection)

PUBLIC: Set the connection that generated the log entry.

setDate

public void setDate(Date date)

PUBLIC: Set the date of the log entry.

setException

public void setException(Throwable throwable)

PUBLIC: Set the exception that caused the log entry.

setMessage

public void setMessage(String message)

PUBLIC: Set the entry's message.

setSession

public void setSession(AbstractSession session)

PUBLIC: Set the session that generated the log entry.

setThread

public void setThread(Thread thread)

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

setLevel

public void setLevel(int level)

PUBLIC: Set the request level of the log entry.

setNameSpace

public void setNameSpace(String nameSpace)

PUBLIC: Set the name space of the log entry.

setParameters

public void setParameters(Object[] params)

PUBLIC: Set the array of parameters to the message.

setShouldTranslate

public void setShouldTranslate(boolean shouldTranslate)

PUBLIC: Set if the message should be translated.

toString

public String toString()

PUBLIC: Print message.

Overrides:

toString in class Object