KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > ejbca > core > model > log > ILogDevice


1 /*************************************************************************
2  * *
3  * EJBCA: The OpenSource Certificate Authority *
4  * *
5  * This software is free software; you can redistribute it and/or *
6  * modify it under the terms of the GNU Lesser General Public *
7  * License as published by the Free Software Foundation; either *
8  * version 2.1 of the License, or any later version. *
9  * *
10  * See terms of license at gnu.org. *
11  * *
12  *************************************************************************/

13
14 package org.ejbca.core.model.log;
15
16 import java.io.Serializable JavaDoc;
17 import java.security.cert.X509Certificate JavaDoc;
18 import java.util.Date JavaDoc;
19
20 /**
21  * Interface used by EJBCA external log devices such as Log4j.
22  * @version $Id: ILogDevice.java,v 1.1 2006/01/17 20:28:08 anatom Exp $
23  */

24 public interface ILogDevice extends Serializable JavaDoc {
25
26     /**
27      * Function used by EJBCA to log information.
28      *
29      * @see #log(Admin, int, int, Date, String, X509Certificate, int, String, Exception)
30      */

31     public void log(Admin admininfo, int caid, int module, Date JavaDoc time, String JavaDoc username, X509Certificate JavaDoc certificate, int event, String JavaDoc comment);
32
33     /**
34      * Log information.
35      * @param admininfo contains information about the administrator performing the event.
36      * @param caid the id of the catch (connected to the event.
37      * @param module indicates the module using the bean.
38      * @param time the time the event occured.
39      * @param username the name of the user involved or null if no user is involved.
40      * @param certificate the certificate involved in the event or null if no certificate is involved.
41      * @param event id of the event, should be one of the org.ejbca.core.model.log.LogEntry.EVENT_ constants.
42      * @param comment comment of the event.
43      * @param exception the exception that has occurred (can be null)
44      */

45     public void log(Admin admininfo, int caid, int module, Date JavaDoc time, String JavaDoc username, X509Certificate JavaDoc certificate, int event, String JavaDoc comment, Exception JavaDoc exception);
46
47 }
48
Popular Tags