1 /* 2 * Copyright (c) 2002-2021, City of Paris 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright notice 10 * and the following disclaimer. 11 * 12 * 2. Redistributions in binary form must reproduce the above copyright notice 13 * and the following disclaimer in the documentation and/or other materials 14 * provided with the distribution. 15 * 16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its 17 * contributors may be used to endorse or promote products derived from 18 * this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE 24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 * 32 * License 1.0 33 */ 34 package fr.paris.lutece.plugins.accesslogger.service; 35 36 /** 37 * This class provides writing services in the application logs files 38 */ 39 public interface IAccessLogger 40 { 41 42 // constants 43 public static final String EVENT_TYPE_READ = "READ"; 44 public static final String EVENT_TYPE_CREATE = "CREATE"; 45 public static final String EVENT_TYPE_DELETE = "DELETE"; 46 public static final String EVENT_TYPE_MODIFY = "MODIFY"; 47 public static final String EVENT_TYPE_ACTION = "ACTION"; 48 49 public static final String EVENT_TYPE_CONNECT = "CONNECT"; 50 public static final String EVENT_TYPE_DISCONNECT = "DISCONNECT"; 51 public static final String EVENT_TYPE_RIGHTS = "RIGHTS"; 52 53 public static final String PROPERTY_SITE_CODE = "lutece.code"; 54 public static final String LOGGER_ACCESS_LOG = "lutece.accessLogger"; 55 56 /** 57 * Log a message object with the INFO level. It is logged in application.log 58 * 59 * @param strEventType 60 * @param strAppEventCode 61 * @param strConnectedUserLogin 62 * @param data 63 * the message object to log 64 */ 65 public void info( String strEventType, String strAppEventCode, String strConnectedUserLogin, Object data ); 66 67 /** 68 * Log a message object with the DEBUG level. It is logged in application.log 69 * 70 * @param strEventType 71 * @param strAppEventCode 72 * @param strConnectedUserLogin 73 * @param data 74 * the message object to log 75 */ 76 public void debug( String strEventType, String strAppEventCode, String strConnectedUserLogin, Object data ); 77 78 /** 79 * Log a message object with the TRACE level.It is logged in application.log 80 * 81 * @param strEventType 82 * @param strAppEventCode 83 * @param strConnectedUserLogin 84 * @param data 85 */ 86 public void trace( String strEventType, String strAppEventCode, String strConnectedUserLogin, Object data ); 87 88 }