org.eclipse.persistence.logging.SessionLogEntry Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of eclipselink Show documentation
Show all versions of eclipselink Show documentation
EclipseLink build based upon Git transaction f2b9fc5
/*******************************************************************************
* Copyright (c) 1998, 2013 Oracle and/or its affiliates. All rights reserved.
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
* which accompanies this distribution.
* The Eclipse Public License is available at http://www.eclipse.org/legal/epl-v10.html
* and the Eclipse Distribution License is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* Contributors:
* Oracle - initial API and implementation from Oracle TopLink
******************************************************************************/
package org.eclipse.persistence.logging;
import java.util.Date;
import java.io.Serializable;
import org.eclipse.persistence.internal.databaseaccess.Accessor;
import org.eclipse.persistence.internal.sessions.AbstractSession;
/**
* 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.
*
* @see SessionLog
* @see DefaultSessionLog
*
* @author Big Country
* @since TOPLink/Java 3.0
*/
public class SessionLogEntry implements Serializable {
protected Date date;
protected transient AbstractSession session;
protected transient Thread thread;
protected transient Accessor connection;
protected String message;
protected Throwable throwable;
protected int level;
protected String nameSpace;
protected Object[] parameters;
protected boolean shouldTranslate;
public SessionLogEntry(AbstractSession session) {
this.date = new Date();
this.thread = Thread.currentThread();
this.session = session;
this.message = "";
this.level = SessionLog.INFO;
}
public SessionLogEntry(AbstractSession session, Throwable throwable) {
this(session);
this.throwable = throwable;
this.level = SessionLog.SEVERE;
}
public SessionLogEntry(AbstractSession session, String message) {
this(session);
this.message = message;
}
public SessionLogEntry(AbstractSession session, String message, Accessor connection) {
this(session, message);
this.connection = connection;
}
/**
* 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 SessionLog
*/
public SessionLogEntry(int level, AbstractSession session, String message, Object[] params, Accessor connection, boolean shouldTranslate) {
this(session, message, connection);
this.level = level;
this.parameters = params;
this.shouldTranslate = 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 SessionLog
*/
public SessionLogEntry(int level, String category, AbstractSession session, String message, Object[] params, Accessor connection, boolean shouldTranslate) {
this(level, session, message, params, connection, shouldTranslate);
this.nameSpace = category;
}
/**
* 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 SessionLog
*/
public SessionLogEntry(AbstractSession session, int level, String category, Throwable throwable) {
this(session, throwable);
this.level = level;
this.nameSpace = category;
}
/**
* Return the connection that generated the log entry.
*/
public Accessor getConnection() {
return connection;
}
/**
* Return the date of the log entry.
*/
public Date getDate() {
return date;
}
/**
* Return the exception that caused the log entry.
*/
public Throwable getException() {
return throwable;
}
/**
* Return the log entry's message.
*/
public String getMessage() {
return message;
}
/**
* Return the session that generated the log entry.
*/
public AbstractSession getSession() {
return session;
}
/**
* Return the thread that was active when the log entry was generated.
*/
public Thread getThread() {
return thread;
}
/**
* Return the request level of the log entry.
* Possible values for log level are listed in SessionLog.
*
* @see SessionLog
*/
public int getLevel() {
return level;
}
/**
* Return the name space of the log entry.
* Possible values for log category (a String) are listed in SessionLog.
*
* @see SessionLog
*/
public String getNameSpace() {
return nameSpace;
}
/**
* @return the array of parameters to the message.
*/
public Object[] getParameters() {
return parameters;
}
/**
* @return if the message should be translated.
*/
public boolean shouldTranslate() {
return shouldTranslate;
}
/**
* @return if the log entry was for an exception.
*/
public boolean hasException() {
return getException() != null;
}
/**
* @return if the log entry has a message
*/
public boolean hasMessage() {
return getMessage() != null && !(getMessage().length() == 0);
}
/**
* Set the connection that generated the log entry.
*/
public void setConnection(Accessor connection) {
this.connection = connection;
}
/**
* Set the date of the log entry.
*/
public void setDate(Date date) {
this.date = date;
}
/**
* Set the exception that caused the log entry.
*/
public void setException(Throwable throwable) {
this.throwable = throwable;
}
/**
* Set the entry's message.
*/
public void setMessage(String message) {
this.message = message;
}
/**
* Set the session that generated the log entry.
*/
public void setSession(AbstractSession session) {
this.session = session;
}
/**
* Set the thread that was active when the log entry was generated.
*/
public void setThread(Thread thread) {
this.thread = thread;
}
/**
* Set the request level of the log entry.
* Possible values for log level are listed in SessionLog.
*
* @see SessionLog
*/
public void setLevel(int level) {
this.level = level;
}
/**
* Set the name space of the log entry.
* Possible values for log category (a String) are listed in SessionLog.
*
* @see SessionLog
*/
public void setNameSpace(String nameSpace) {
this.nameSpace = nameSpace;
}
/**
* Set the array of parameters to the message.
*/
public void setParameters(Object[] params) {
this.parameters = params;
}
/**
* Set if the message should be translated.
*/
public void setShouldTranslate(boolean shouldTranslate) {
this.shouldTranslate = shouldTranslate;
}
public String toString() {
return org.eclipse.persistence.internal.helper.Helper.getShortClassName(getClass()) + "(" + getMessage() + ")";
}
}