org.eclipse.persistence.logging.SessionLog Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.persistence.core Show documentation
EclipseLink build based upon Git transaction ecdf3c32c4
There is a newer version: 4.0.2
Show newest version
/*
 * Copyright (c) 1998, 2018 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 v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Oracle - initial API and implementation from Oracle TopLink
package org.eclipse.persistence.logging;

import java.io.Writer;

import org.eclipse.persistence.sessions.Session;

/**
 * SessionLog is the ever-so-simple interface used by
 * EclipseLink to log generated messages and SQL. An implementor of
 * this interface can be passed to the EclipseLink session
 * (via the #setSessionLog(SessionLog) method); and
 * all logging data will be passed through to the implementor
 * via an instance of SessionLogEntry. This can be used
 * to supplement debugging; or the entries could be stored
 * in a database instead of logged to System.out, etc.
 * 
 * This class defines Eclipselink logging levels (that are used throughout EclipseLink code) with the following integer values:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 *   ALL       = {@value #ALL}
  FINEST    = {@value #FINEST}
  FINER     = {@value #FINER}
  FINE      = {@value #FINE}
  CONFIG    = {@value #CONFIG}
  INFO      = {@value #INFO}
  WARNING   = {@value #WARNING}
  SEVERE    = {@value #SEVERE}
  OFF       = {@value #OFF}
 * 
 * In addition, EclipseLink categories used for logging name space are defined with the following String values:
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 *   {@link #CACHE}            = {@value #CACHE}
  {@link #CONNECTION}       = {@value #CONNECTION}
  {@link #DMS}              = {@value #DMS}
  {@link #EJB}              = {@value #EJB}
  {@link #EVENT}            = {@value #EVENT}
  {@link #DBWS}             = {@value #DBWS}
  {@link #JPARS}            = {@value #JPARS}
  {@link #METADATA}         = {@value #METADATA} 
  {@link #METAMODEL}        = {@value #METAMODEL}
  {@link #MOXY}             = {@value #MOXY}
  {@link #PROCESSOR}        = {@value #PROCESSOR}
  {@link #PROPAGATION}      = {@value #PROPAGATION}
  {@link #PROPERTIES}       = {@value #PROPERTIES}
  {@link #QUERY}            = {@value #QUERY}
  {@link #SEQUENCING}       = {@value #SEQUENCING}
  {@link #SERVER}           = {@value #SERVER}
  {@link #SQL}              = {@value #SQL}
  {@link #TRANSACTION}      = {@value #TRANSACTION}
  {@link #WEAVER}           = {@value #WEAVER}
 *
 * @see AbstractSessionLog
 * @see SessionLogEntry
 * @see Session
 *
 * @since TOPLink/Java 3.0
 */
public interface SessionLog extends Cloneable {
    // EclipseLink log levels. They are mapped to java.util.logging.Level values.
    // Numeric constants can't be replaced with LogLevel..getId();
    public static final int OFF = 8;
    public static final String OFF_LABEL = LogLevel.OFF.getName();

    //EL is not in a state to continue
    public static final int SEVERE = 7;
    public static final String SEVERE_LABEL = LogLevel.SEVERE.getName();

    //Exceptions that don't force a stop
    public static final int WARNING = 6;
    public static final String WARNING_LABEL = LogLevel.WARNING.getName();

    //Login and logout per server session with name
    public static final int INFO = 5;
    public static final String INFO_LABEL = LogLevel.INFO.getName();

    //Configuration info
    public static final int CONFIG = 4;
    public static final String CONFIG_LABEL = LogLevel.CONFIG.getName();

    //SQL
    public static final int FINE = 3;
    public static final String FINE_LABEL = LogLevel.FINE.getName();

    //Previously logged under logMessage and stack trace of exceptions at WARNING level
    public static final int FINER = 2;
    public static final String FINER_LABEL = LogLevel.FINER.getName();

    //Previously logged under logDebug
    public static final int FINEST = 1;
    public static final String FINEST_LABEL = LogLevel.FINEST.getName();
    public static final int ALL = 0;
    public static final String ALL_LABEL = LogLevel.ALL.getName();

    //EclipseLink categories used for logging name space.
    public static final String SQL = "sql";
    public static final String TRANSACTION = "transaction";
    public static final String EVENT = "event";
    public static final String CONNECTION = "connection";
    public static final String QUERY = "query";
    public static final String CACHE = "cache";
    public static final String PROPAGATION = "propagation";
    public static final String SEQUENCING = "sequencing";
    public static final String JPA = "jpa";
    public static final String EJB = "ejb";
    public static final String DMS = "dms";
    public static final String METADATA = "metadata";
    public static final String MONITORING = "monitoring";
    public static final String MISC = "misc";
    public static final String MOXY = "moxy";

    /** @deprecated use {@link #METADATA}. */
    @Deprecated
    public static final String EJB_OR_METADATA = METADATA;
    public static final String METAMODEL = "metamodel";
    public static final String WEAVER = "weaver";
    public static final String PROPERTIES = "properties";
    public static final String SERVER = "server";
    public static final String DDL = "ddl";
    public static final String DBWS = "dbws";
    public static final String JPARS = "jpars";
    /** ModelGen logging name space. */
    public static final String PROCESSOR = "processor";

    public final String[] loggerCatagories = new String[] {
        SQL,
        TRANSACTION,
        EVENT,
        CONNECTION,
        QUERY,
        CACHE,
        PROPAGATION,
        SEQUENCING,
        JPA,
        DBWS,
        JPARS,
        EJB,
        DMS,
        METADATA,
        MONITORING,
        MOXY,
        METAMODEL,
        WEAVER,
        PROPERTIES,
        SERVER,
        DDL,
        PROCESSOR
    };

    /**
     * PUBLIC:
     * EclipseLink will call this method whenever something
     * needs to be logged (messages, SQL, etc.).
     * All the pertinent information will be contained in
     * the specified entry.
     *
     * @param entry org.eclipse.persistence.sessions.LogEntry
     */
    public void log(SessionLogEntry entry);

    /**
     * By default the stack trace is logged for SEVERE all the time and at FINER level for WARNING or less,
     * this can be turned off.
     */
    public boolean shouldLogExceptionStackTrace();

    /**
     * By default the date is always printed, this can be turned off.
     */
    public boolean shouldPrintDate();

    /**
     * By default the thread is logged at FINE or less level, this can be turned off.
     */
    public boolean shouldPrintThread();

    /**
     * Return whether bind parameters should be displayed when logging SQL, default is true.
     */
    public boolean shouldDisplayData();

    /**
     * By default the connection is always printed whenever available, this can be turned off.
     */
    public boolean shouldPrintConnection();

    /**
     * By default the Session is always printed whenever available, this can be turned off.
     */
    public boolean shouldPrintSession();

    /**
     * Set whether bind parameters should be displayed when logging SQL.
     */
    public void setShouldDisplayData(Boolean shouldDisplayData);

    /**
     * By default stack trace is logged for SEVERE all the time and at FINER level for WARNING or less.
     * This can be turned off.
     */
    public void setShouldLogExceptionStackTrace(boolean flag);

    /**
     * By default date is printed, this can be turned off.
     */
    public void setShouldPrintDate(boolean flag);

    /**
     * By default the thread is logged at FINE or less level, this can be turned off.
     */
    public void setShouldPrintThread(boolean flag);

    /**
     * By default the connection is always printed whenever available, this can be turned off.
     */
    public void setShouldPrintConnection(boolean flag);

    /**
     * By default the Session is always printed whenever available, this can be turned off.
     */
    public void setShouldPrintSession(boolean flag);

    /**
     * PUBLIC:
     * Return the writer to which an accessor writes logged messages and SQL.
     * If not set, this reference usually defaults to a writer on System.out.
     * To enable logging, logMessages must be turned on in the session.
     */
    public Writer getWriter();

    /**
     * PUBLIC:
     * Set the writer to which an accessor writes logged messages and SQL.
     * If not set, this reference usually defaults to a writer on System.out.
     * To enable logging, logMessages() is used on the session.
     */
    public void setWriter(Writer log);

    /**
     * PUBLIC:
     * Return the log level.  Used when session is not available.
     * 
     * The EclipseLink logging levels returned correspond to:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public int getLevel();

    /**
     * PUBLIC:
     * 
     * Return the log level as a string value.
     */
    public String getLevelString();

    /**
     * PUBLIC:
     * Return the log level; category is only needed where name space
     * is available.
     * 

     * The EclipseLink logging levels returned correspond to:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     * 
     * The EclipseLink categories for the logging name space are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     *   {@link #CACHE}              = {@value #CACHE}
  {@link #CONNECTION}         = {@value #CONNECTION}
  {@link #DMS}                = {@value #DMS}
  {@link #EJB}                = {@value #EJB}
  {@link #EJB_OR_METADATA}    = {@value #EJB_OR_METADATA}
  {@link #EVENT}              = {@value #EVENT}
  {@link #DBWS}               = {@value #DBWS}
  {@link #JPARS}              = {@value #JPARS}
  {@link #METAMODEL}          = {@value #METAMODEL}
  {@link #MOXY}               = {@value #MOXY}
  {@link #PROCESSOR}          = {@value #PROCESSOR}
  {@link #PROPAGATION}        = {@value #PROPAGATION}
  {@link #PROPERTIES}         = {@value #PROPERTIES}
  {@link #QUERY}              = {@value #QUERY}
  {@link #SEQUENCING}         = {@value #SEQUENCING}
  {@link #SERVER}             = {@value #SERVER}
  {@link #SQL}                = {@value #SQL}
  {@link #TRANSACTION}        = {@value #TRANSACTION}
  {@link #WEAVER}             = {@value #WEAVER}
     */
    public int getLevel(String category);

    /**
     * PUBLIC:
     * Set the log level.  Used when session is not available.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void setLevel(int level);

    /**
     * PUBLIC:
     * Set the log level.  Category is only needed where name space
     * is available.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     * 
     * The EclipseLink categories for the logging name space are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     *   {@link #CACHE}              = {@value #CACHE}
  {@link #CONNECTION}         = {@value #CONNECTION}
  {@link #DMS}                = {@value #DMS}
  {@link #EJB}                = {@value #EJB}
  {@link #EJB_OR_METADATA}    = {@value #EJB_OR_METADATA}
  {@link #EVENT}              = {@value #EVENT}
  {@link #DBWS}               = {@value #DBWS}
  {@link #JPARS}              = {@value #JPARS}
  {@link #METAMODEL}          = {@value #METAMODEL}
  {@link #MOXY}               = {@value #MOXY}
  {@link #PROCESSOR}          = {@value #PROCESSOR}
  {@link #PROPAGATION}        = {@value #PROPAGATION}
  {@link #PROPERTIES}         = {@value #PROPERTIES}
  {@link #QUERY}              = {@value #QUERY}
  {@link #SEQUENCING}         = {@value #SEQUENCING}
  {@link #SERVER}             = {@value #SERVER}
  {@link #SQL}                = {@value #SQL}
  {@link #TRANSACTION}        = {@value #TRANSACTION}
  {@link #WEAVER}             = {@value #WEAVER}
     */
    public void setLevel(int level, String category);

    /**
     * PUBLIC:
     * Check if a message of the given level would actually be logged.
     * Used when session is not available.
     * 
     * The EclipseLink logging levels available are:
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public boolean shouldLog(int level);

    /**
     * PUBLIC:
     * Check if a message of the given level would actually be logged.
     * Category is only needed where name space is available.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     * 
     * The EclipseLink categories for the logging name space are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     *   {@link #CACHE}              = {@value #CACHE}
  {@link #CONNECTION}         = {@value #CONNECTION}
  {@link #DMS}                = {@value #DMS}
  {@link #EJB}                = {@value #EJB}
  {@link #EJB_OR_METADATA}    = {@value #EJB_OR_METADATA}
  {@link #EVENT}              = {@value #EVENT}
  {@link #DBWS}               = {@value #DBWS}
  {@link #JPARS}              = {@value #JPARS}
  {@link #METAMODEL}          = {@value #METAMODEL}
  {@link #MOXY}               = {@value #MOXY}
  {@link #PROCESSOR}          = {@value #PROCESSOR}
  {@link #PROPAGATION}        = {@value #PROPAGATION}
  {@link #PROPERTIES}         = {@value #PROPERTIES}
  {@link #QUERY}              = {@value #QUERY}
  {@link #SEQUENCING}         = {@value #SEQUENCING}
  {@link #SERVER}             = {@value #SERVER}
  {@link #SQL}                = {@value #SQL}
  {@link #TRANSACTION}        = {@value #TRANSACTION}
  {@link #WEAVER}             = {@value #WEAVER}
     */
    public boolean shouldLog(int level, String category);

    /**
     * PUBLIC:
     * Log a message that does not need to be translated.  This method is intended for
     * external use when logging messages are wanted within the EclipseLink output.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String message);

    /**
     * PUBLIC:
     * Log a message with one parameter that needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String message, Object param);

    /**
     * PUBLIC:
     * Log a message with one parameter that needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String category, String message, Object param);

    /**
     * PUBLIC:
     * Log a message with two parameters that needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String message, Object param1, Object param2);

    /**
     * PUBLIC:
     * Log a message with two parameters that needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String category, String message, Object param1, Object param2);

    /**
     * PUBLIC:
     * Log a message with three parameters that needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String message, Object param1, Object param2, Object param3);

    /**
     * PUBLIC:
     * Log a message with three parameters that needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String category, String message, Object param1, Object param2, Object param3);

    /**
     * PUBLIC:
     * Log a message with four parameters that needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String message, Object param1, Object param2, Object param3, Object param4);

    /**
     * PUBLIC:
     * Log a message with four parameters that needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String category, String message, Object param1, Object param2, Object param3, Object param4);

    /**
     * PUBLIC:
     * This method is called when the log request is from somewhere session is not available.
     * The message needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String message, Object[] arguments);

    /**
     * PUBLIC:
     * This method is called when the log request is from somewhere session is not available.
     * The message needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String category, String message, Object[] arguments);

    /**
     * PUBLIC:
     * This method is called when the log request is from somewhere session is not available.
     * shouldTranslate flag determines if the message needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String message, Object[] arguments, boolean shouldTranslate);

    /**
     * PUBLIC:
     * This method is called when the log request is from somewhere session is not available.
     * shouldTranslate flag determines if the message needs to be translated.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void log(int level, String category, String message, Object[] arguments, boolean shouldTranslate);

    /**
     * PUBLIC:
     * This method is called when a throwable at finer level needs to be logged.
     */
    public void throwing(Throwable throwable);

    /**
     * PUBLIC:
     * This method is called when a severe level message needs to be logged.
     * The message will be translated
     */
    public void severe(String message);

    /**
     * PUBLIC:
     * This method is called when a warning level message needs to be logged.
     * The message will be translated
     */
    public void warning(String message);

    /**
     * PUBLIC:
     * This method is called when a info level message needs to be logged.
     * The message will be translated
     */
    public void info(String message);

    /**
     * PUBLIC:
     * This method is called when a config level message needs to be logged.
     * The message will be translated
     */
    public void config(String message);

    /**
     * PUBLIC:
     * This method is called when a fine level message needs to be logged.
     * The message will be translated
     */
    public void fine(String message);

    /**
     * PUBLIC:
     * This method is called when a finer level message needs to be logged.
     * The message will be translated
     */
    public void finer(String message);

    /**
     * PUBLIC:
     * This method is called when a finest level message needs to be logged.
     * The message will be translated
     */
    public void finest(String message);

    /**
     * PUBLIC:
     * Log a {@link Throwable} with level.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void logThrowable(int level, Throwable throwable);

    /**
     * PUBLIC:
     * Log a throwable with level.
     * 
     * The EclipseLink logging levels available are:

     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * 
     * {@link #ALL}       = {@value #ALL}
{@link #FINEST}    = {@value #FINEST}
{@link #FINER}     = {@value #FINER}
{@link #FINE}      = {@value #FINE}
{@link #CONFIG}    = {@value #CONFIG}
{@link #INFO}      = {@value #INFO}
{@link #WARNING}   = {@value #WARNING}
{@link #SEVERE}    = {@value #SEVERE}
{@link #OFF}       = {@value #OFF}
     */
    public void logThrowable(int level, String category, Throwable throwable);

    /**
     * PUBLIC:
     * Get the session that owns this SessionLog.
     */
    public Session getSession();

    /**
     * PUBLIC:
     * Set the session that owns this SessionLog.
     */
    public void setSession(Session session);

    /**
     * PUBLIC:
     * Clone the log.
     */
    public Object clone();
}
	ALL		= {@value #ALL}
	FINEST		= {@value #FINEST}
	FINER		= {@value #FINER}
	FINE		= {@value #FINE}
	CONFIG		= {@value #CONFIG}
	INFO		= {@value #INFO}
	WARNING		= {@value #WARNING}
	SEVERE		= {@value #SEVERE}
	OFF		= {@value #OFF}
	{@link #CACHE}		= {@value #CACHE}
	{@link #CONNECTION}		= {@value #CONNECTION}
	{@link #DMS}		= {@value #DMS}
	{@link #EJB}		= {@value #EJB}
	{@link #EVENT}		= {@value #EVENT}
	{@link #DBWS}		= {@value #DBWS}
	{@link #JPARS}		= {@value #JPARS}
	{@link #METADATA}		= {@value #METADATA}
	{@link #METAMODEL}		= {@value #METAMODEL}
	{@link #MOXY}		= {@value #MOXY}
	{@link #PROCESSOR}		= {@value #PROCESSOR}
	{@link #PROPAGATION}		= {@value #PROPAGATION}
	{@link #PROPERTIES}		= {@value #PROPERTIES}
	{@link #QUERY}		= {@value #QUERY}
	{@link #SEQUENCING}		= {@value #SEQUENCING}
	{@link #SERVER}		= {@value #SERVER}
	{@link #SQL}		= {@value #SQL}
	{@link #TRANSACTION}		= {@value #TRANSACTION}
	{@link #WEAVER}		= {@value #WEAVER}
{@link #ALL}		= {@value #ALL}
{@link #FINEST}		= {@value #FINEST}
{@link #FINER}		= {@value #FINER}
{@link #FINE}		= {@value #FINE}
{@link #CONFIG}		= {@value #CONFIG}
{@link #INFO}		= {@value #INFO}
{@link #WARNING}		= {@value #WARNING}
{@link #SEVERE}		= {@value #SEVERE}
{@link #OFF}		= {@value #OFF}