Module org.eclipse.persistence.core
Package org.eclipse.persistence.logging

Class SessionLogEntry

java.lang.Object
org.eclipse.persistence.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 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
See Also:

  • Field Details

    • 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

    • sourceClassName

      protected String sourceClassName

    • sourceMethodName

      protected String sourceMethodName

  • Constructor Details

    • SessionLogEntry

      public SessionLogEntry(AbstractSession session)
      Create a new session log entry for a session.
      Parameters:
      session - the session

    • SessionLogEntry

      public SessionLogEntry(AbstractSession session, Throwable throwable)
      Create a new session log entry for a session and a throwable.
      Parameters:
      session - the session
      throwable - the throwable

    • SessionLogEntry

      public SessionLogEntry(AbstractSession session, String message)
      Create a new session log entry for a session and a message.
      Parameters:
      session - the session
      message - the message

    • SessionLogEntry

      public SessionLogEntry(AbstractSession session, String message, Accessor connection)
      Create a new session log entry for a session, a message and an accessor.
      Parameters:
      session - the session
      message - the message
      connection - the accessor

    • SessionLogEntry

      public SessionLogEntry(int level, AbstractSession session, String message, Object[] params, Accessor connection, boolean shouldTranslate)
      Create a new session log entry for a request level, a session, a message, parameters and an accessor.
      Possible values for log level are listed in SessionLog.
      Parameters:
      level - the log level
      session - the session
      message - the message
      params - array of parameters
      connection - the accessor
      shouldTranslate - true if the entry should be translated
      See Also:

    • SessionLogEntry

      public SessionLogEntry(int level, String category, AbstractSession session, String message, Object[] params, Accessor connection, boolean shouldTranslate)
      Create a new session log entry for a request level, a category, a session, a message, parameters and an accessor.
      Possible values for log level and category are listed in SessionLog.
      Parameters:
      level - the log level
      category - the category
      session - the session
      message - the message
      params - array of parameters
      connection - the accessor
      shouldTranslate - true if the entry should be translated
      See Also:

    • SessionLogEntry

      public SessionLogEntry(AbstractSession session, int level, String category, 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.
      Parameters:
      session - the session
      level - the log level
      category - the category
      throwable - the exception
      See Also:

  • Method Details

    • getConnection

      public Accessor getConnection()
      Return the connection that generated the log entry.
      Returns:
      the connection accessor

    • getDate

      public Date getDate()
      Return the date of the log entry.
      Returns:
      the date

    • getException

      public Throwable getException()
      Return the exception that caused the log entry.
      Returns:
      the exception

    • getMessage

      public String getMessage()
      Return the log entry's message.
      Returns:
      the message

    • getSession

      public AbstractSession getSession()
      Return the session that generated the log entry.
      Returns:
      the session

    • getThread

      public Thread getThread()
      Return the thread that was active when the log entry was generated.
      Returns:
      the thread

    • getLevel

      public int getLevel()
      Return the request level of the log entry.
      Possible values for log level are listed in SessionLog.
      Returns:
      the request level of the log entry
      See Also:

    • getNameSpace

      public String getNameSpace()
      Return the name space of the log entry.
      Possible values for log category (a String) are listed in SessionLog.
      Returns:
      the name space of the log entry
      See Also:

    • getParameters

      public Object[] getParameters()
      Returns:
      the array of parameters to the message.

    • getSourceClassName

      public String getSourceClassName()
      Returns:
      the source class name to the message

    • getSourceMethodName

      public String getSourceMethodName()
      Returns:
      the source method name 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.
      Parameters:
      connection - the connection

    • setDate

      public void setDate(Date date)
      Set the date of the log entry.
      Parameters:
      date - the date

    • setException

      public void setException(Throwable throwable)
      Set the exception that caused the log entry.
      Parameters:
      throwable - the exception

    • setMessage

      public void setMessage(String message)
      Set the entry's message.
      Parameters:
      message - the message

    • setSession

      public void setSession(AbstractSession session)
      Set the session that generated the log entry.
      Parameters:
      session - the session

    • setThread

      public void setThread(Thread thread)
      Set the thread that was active when the log entry was generated.
      Parameters:
      thread - the thread

    • setLevel

      public void setLevel(int level)
      Set the request level of the log entry.
      Possible values for log level are listed in SessionLog.
      Parameters:
      level - the log level
      See Also:

    • setNameSpace

      public void setNameSpace(String nameSpace)
      Set the name space of the log entry.
      Possible values for log category (a String) are listed in SessionLog.
      Parameters:
      nameSpace - the log category
      See Also:

    • setParameters

      public void setParameters(Object[] params)
      Set the array of parameters to the message.
      Parameters:
      params - array of parameters

    • setShouldTranslate

      public void setShouldTranslate(boolean shouldTranslate)
      Set if the message should be translated.
      Parameters:
      shouldTranslate - true if the message should be translated, false otherwise

    • setSourceClassName

      public void setSourceClassName(String sourceClassName)
      Set the source class name to the message.
      Parameters:
      sourceClassName - source class name

    • setSourceMethodName

      public void setSourceMethodName(String sourceMethodName)
      Set the source method name to the message.
      Parameters:
      sourceMethodName - source method name

    • toString

      public String toString()
      Overrides:
      toString in class Object