/*************************************************************************
 *                                                                       *
 *  SignServer: The OpenSource Automated Signing Server                  *
 *                                                                       *
 *  This software is free software; you can redistribute it and/or       *
 *  modify it under the terms of the GNU Lesser General Public           *
 *  License as published by the Free Software Foundation; either         *
 *  version 2.1 of the License, or any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/
package org.signserver.server.log;

import java.util.Map;
import java.util.Properties;
import org.signserver.server.log.WorkerLoggerException;

/**
 * Logger for events (transactions) performed by a worker processing a request.
 * Audit events not associated with a worker transaction should be logged by a
 * ISystemLogger instead.
 *
 * @author Markus Kilås
 * @version $Id: IWorkerLogger.java 3441 2013-04-17 07:42:13Z malu9369 $
 */
public interface IWorkerLogger {

    // Log constants
    String LOG_ID = "LOG_ID";
    String LOG_TIME = "LOG_TIME";
    String LOG_REPLY_TIME = "REPLY_TIME";
    String LOG_CLIENT_AUTHORIZED = "CLIENT_AUTHORIZED";
    String LOG_CLIENT_IP = "CLIENT_IP";
    String LOG_EXCEPTION = "EXCEPTION";
    String LOG_PROCESS_SUCCESS = "PROCESS_SUCCESS";
    String LOG_WORKER_AUTHTYPE = "WORKER_AUTHTYPE";
    String LOG_WORKER_ID = "WORKER_ID";
    String LOG_WORKER_NAME = "WORKER_NAME";
    String LOG_CLIENT_CERT_SUBJECTDN = "CLIENT_CERT_SUBJECTDN";
    String LOG_CLIENT_CERT_ISSUERDN = "CLIENT_CERT_ISSUERDN";
    String LOG_CLIENT_CERT_SERIALNUMBER = "CLIENT_CERT_SERIALNUMBER";
    String LOG_SIGNER_CERT_SUBJECTDN = "SIGNER_CERT_SUBJECTDN";
    String LOG_SIGNER_CERT_ISSUERDN = "SIGNER_CERT_ISSUERDN";
    String LOG_SIGNER_CERT_SERIALNUMBER = "SIGNER_CERT_SERIALNUMBER";

    String LOG_REQUEST_FULLURL = "REQUEST_FULLURL";
    String LOG_REQUEST_LENGTH = "REQUEST_LENGTH";
    String LOG_FILENAME = "FILENAME";
    String LOG_XFORWARDEDFOR = "XFORWARDEDFOR";

    String LOG_PURCHASED = "PURCHASED";

    String LOG_PDF_PASSWORD_SUPPLIED = "PDF_PASSWORD_SUPPLIED";
    
    String LOG_ARCHIVE_IDS = "ARCHIVE_IDS";

    /**
     * Method called after creation of instance.
     * @param props the signers properties.
     */
    void init(Properties props);

    /**
     * Write out the log line. What fields that are placed in the actual log
     * and in which order etc is up to the implementing IWorkerLogger.
     * @param fields Fields that potentially could be placed in the log entry.
     * @throws WorkerLoggerException In case there is a problem writing the log.
     */
    void log(final AdminInfo adminInfo, Map<String,String> fields) throws WorkerLoggerException;
    
    /**
     * Sets EJB session mapping.
     * 
     * @param ejbs EJB map
     */
    void setEjbs(final Map<Class<?>, ?> ejbs);
}