/*
    * Copyright (c) 2002-2022, City of Paris
    * All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    *
    *  1. Redistributions of source code must retain the above copyright notice
   *     and the following disclaimer.
   *
   *  2. Redistributions in binary form must reproduce the above copyright notice
   *     and the following disclaimer in the documentation and/or other materials
   *     provided with the distribution.
   *
   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
   *     contributors may be used to endorse or promote products derived from
   *     this software without specific prior written permission.
   *
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   * POSSIBILITY OF SUCH DAMAGE.
   *
   * License 1.0
   */
  package fr.paris.lutece.portal.service.security;
  
  import fr.paris.lutece.api.user.User;
  import fr.paris.lutece.portal.service.spring.SpringContextService;
  import java.util.List;
  
  /**
   * Access Log service
   *
   * - Report all actions regarding authentication, user or rights management. - All messages should contain the application Id, the event type, a specific
   * application event code, the logged user, and specific contextual data. - The logger should implement the interface IAccessLogger of lutece core
   * 
   * Use "debug" or "trace" level for fine access control history, use "info" level otherwise
   * 
   * By default : - Lutece authentication, user and rights management are logged at INFO level, - action requests at DEBUG level, - views requests are logged at
   * TRACE level.
   * 
   * To log specific actions, use :
   * 
   * AccessLogService.getInstance( ).warn( String strEventType, String strAppEventCode, String strConnectedUserLogin, Object data ); AccessLogService.getInstance(
   * ).info( String strEventType, String strAppEventCode, String strConnectedUserLogin, Object data ); AccessLogService.getInstance( ).debug( String strEventType,
   * String strAppEventCode, String strConnectedUserLogin, Object data ); AccessLogService.getInstance( ).trace( String strEventType, String strAppEventCode,
   * String strConnectedUserLogin, Object data );
   * 
   * Event types are available in AccessLoggerConstants class.
   * 
   */
  public final class AccessLogService
  {
      // constants
      public static final String ACCESS_LOG_FO = "fo";
      public static final String ACCESS_LOG_BO = "bo";
  
      private final List<IAccessLogger> _accessLoggerList;
      private static AccessLogServiceity/AccessLogService.html#AccessLogService">AccessLogService _singleton = new AccessLogService( );
  
      /**
       * Creates a new AppLogService object.
       */
      private AccessLogService( )
      {
          _accessLoggerList = SpringContextService.getBeansOfType( IAccessLogger.class );
      }
  
      /**
       * Get the unique instance of the Service
       * 
       * @return The instance
       */
      public static AccessLogService getInstance( )
      {
          return _singleton;
      }
  
      /**
       * Log action with info level
       * 
       * @param strEventType
       *            the event type
       * @param strAppEventCode
       *            the event code
       * @param connectedUser
       *            the user connected
       * @param data
       *            the message object to log
       * @param specificOrigin
      *            specific origin of the event to log
      */
     public void info( String strEventType, String strAppEventCode, User connectedUser, Object data, String specificOrigin )
     {
         _accessLoggerList.forEach( accessLogger -> {
             accessLogger.info( strEventType, strAppEventCode, connectedUser, data, specificOrigin );
         } );
     }
 
     /**
      * Log action with info level
      * 
      * @param strEventType
      *            the event type
      * @param strAppEventCode
      *            the event code
      * @param connectedUser
      *            the user connected
      * @param data
      *            the message object to log
      */
     public void info( String strEventType, String strAppEventCode, User connectedUser, Object data )
     {
         info( strEventType, strAppEventCode, connectedUser, data, null );
     }
 
     /**
      * Log action with Debug level
      * 
      * @param strEventType
      * @param strAppEventCode
      * @param connectedUser
      * @param data
      * @param specificOrigin
      */
     public void debug( String strEventType, String strAppEventCode, User connectedUser, Object data, String specificOrigin )
     {
         _accessLoggerList.forEach( accessLogger -> {
             accessLogger.debug( strEventType, strAppEventCode, connectedUser, data, specificOrigin );
         } );
     }
 
     /**
      * Log action with Debug level
      * 
      * @param strEventType
      * @param strAppEventCode
      * @param connectedUser
      * @param data
      */
     public void debug( String strEventType, String strAppEventCode, User connectedUser, Object data )
     {
         debug( strEventType, strAppEventCode, connectedUser, data, null );
     }
 
     /**
      * Log action with trace level
      * 
      * @param strEventType
      * @param strAppEventCode
      * @param connectedUser
      * @param data
      * @param specificOrigin
      */
     public void trace( String strEventType, String strAppEventCode, User connectedUser, Object data, String specificOrigin )
     {
         _accessLoggerList.forEach( accessLogger -> {
             accessLogger.trace( strEventType, strAppEventCode, connectedUser, data, specificOrigin );
         } );
     }
 
     /**
      * Log action with trace level
      * 
      * @param strEventType
      * @param strAppEventCode
      * @param connectedUser
      * @param data
      */
     public void trace( String strEventType, String strAppEventCode, User connectedUser, Object data )
     {
         trace( strEventType, strAppEventCode, connectedUser, data, null );
     }
 
     /**
      * Log action with warn level
      * 
      * @param strEventType
      * @param strAppEventCode
      * @param connectedUser
      * @param data
      * @param specificOrigin
      */
     public void warn( String strEventType, String strAppEventCode, User connectedUser, Object data, String specificOrigin )
     {
         _accessLoggerList.forEach( accessLogger -> {
             accessLogger.warn( strEventType, strAppEventCode, connectedUser, data, specificOrigin );
         } );
     }
 
     /**
      * Log action with warn level
      * 
      * @param strEventType
      * @param strAppEventCode
      * @param connectedUser
      * @param data
      */
     public void warn( String strEventType, String strAppEventCode, User connectedUser, Object data )
     {
         warn( strEventType, strAppEventCode, connectedUser, data, null );
     }
 
 }