View Javadoc

1   /*
2    * The MIT License
3    *
4    * Original work sponsored and donated by National Board of e-Health (NSI), Denmark (http://www.nsi.dk)
5    *
6    * Copyright (C) 2011 National Board of e-Health (NSI), Denmark (http://www.nsi.dk)
7    *
8    * Permission is hereby granted, free of charge, to any person obtaining a copy of
9    * this software and associated documentation files (the "Software"), to deal in
10   * the Software without restriction, including without limitation the rights to
11   * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
12   * of the Software, and to permit persons to whom the Software is furnished to do
13   * so, subject to the following conditions:
14   *
15   * The above copyright notice and this permission notice shall be included in all
16   * copies or substantial portions of the Software.
17   *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24   * SOFTWARE.
25   *
26   * $HeadURL: https://svn.softwareborsen.dk/sosi/trunk/modules/seal/src/main/java/dk/sosi/seal/pki/AuditEventHandler.java $
27   * $Id: AuditEventHandler.java 8697 2011-09-02 10:33:55Z chg@lakeside.dk $
28   */
29  
30  package dk.sosi.seal.pki;
31  
32  /**
33   * Interface to be implemented by users wishing to handle auditing events.
34   * 
35   * @author peter@signaturgruppen.dk
36   * @author $LastChangedBy: chg@lakeside.dk $
37   * @version $Revision: 8697 $
38   * @since 1.0
39   */
40  public interface AuditEventHandler {
41  
42  	public static final String EVENT_TYPE_INFO_FEDERATION_INITIALIZED = "EVENT_TYPE_INFO_FEDERATION_INITIALIZED";
43  	public static final String EVENT_TYPE_INFO_CREDENTIAL_VAULT_INITIALIZED = "EVENT_TYPE_INFO_CREDENTIAL_VAULT_INITIALIZED";
44  	public static final String EVENT_TYPE_INFO_SOSI_XML_VALIDATED = "EVENT_TYPE_INFO_SOSI_XML_VALIDATED";
45  	public static final String EVENT_TYPE_INFO_CERTIFICATE_VALIDATED = "EVENT_TYPE_INFO_CERTIFICATE_VALIDATED";
46  	public static final String EVENT_TYPE_INFO_FULL_CRL_DOWNLOADED = "EVENT_TYPE_INFO_FULL_CRL_DOWNLOADED";
47  	
48  	/**
49  	 * callback Method in case of an informational auditing event
50  	 * 
51  	 * EVENT_TYPE_INFO_FEDERATION_INITIALIZED
52  	 * params[0] federation
53  	 * 
54  	 * EVENT_TYPE_INFO_CREDENTIAL_VAULT_INITIALIZED
55  	 * params[0] vault
56  	 * 
57  	 * EVENT_TYPE_INFO_SOSI_XML_VALIDATED
58  	 * params[0] XML document
59  	 * 
60  	 * EVENT_TYPE_INFO_CERTIFICATE_VALIDATED
61  	 * params[0] X509Certificate
62  	 * 
63  	 * EVENT_TYPE_INFO_FULL_CRL_DOWNLOADED
64  	 * params[0] CRLURL
65  	 * params[1] CRL
66  	 * 
67  
68  	 * @param event
69  	 * 		description of event
70  	 * @param params
71  	 * 		Array of parameters 
72  	 */
73  	void onInformationalAuditingEvent(String event, Object[] params);
74  	
75  	String EVENT_TYPE_WARNING_NO_REVOCATION_CHECK = "EVENT_TYPE_WARNING_NO_REVOCATION_CHECK";
76  	/**
77  	 * callback Method in case of a warning auditing event
78  	 * 
79  	 * EVENT_TYPE_WARNING_NO_REVOCATION_CHECK
80  	 * params[0] X509Certificate
81  	 * 
82  	 * 
83  	 * @param event
84  	 * 		description of event
85  	 * @param params
86  	 * 		Array of parameters 
87  	 */
88  	void onWarningAuditingEvent(String event, Object[] params);
89  	
90  	String EVENT_TYPE_ERROR_DOWNLOADING_FULL_CRL = "EVENT_TYPE_ERROR_DOWNLOADING_FULL_CRL";
91  	String EVENT_TYPE_ERROR_FULL_CRL_EXPIRED = "EVENT_TYPE_ERROR_FULL_CRL_EXPIRED";
92  	String EVENT_TYPE_ERROR_PARSING_SOSI_XML = "EVENT_TYPE_ERROR_PARSING_SOSI_XML";
93  	String EVENT_TYPE_ERROR_VALIDATING_SOSI_MESSAGE = "EVENT_TYPE_ERROR_VALIDATING_SOSI_XML";
94  	String EVENT_TYPE_ERROR_VALIDATING_STS_CERTIFICATE = "EVENT_TYPE_ERROR_VALIDATING_STS_CERTIFICATE";
95  	String EVENT_TYPE_ERROR_VALIDATING_CERTIFICATE = "EVENT_TYPE_ERROR_VALIDATING_CERTIFICATE";
96  	/**
97  	 * callback Method in case of an error auditing event
98  	 * 
99  	 * EVENT_TYPE_ERROR_DOWNLOADING_FULL_CRL
100 	 * params[0] CRLURL
101 	 * 
102 	 * EVENT_TYPE_ERROR_FULL_CRL_EXPIRED
103 	 * params[0] CRLURL
104 	 * params[1] CRL
105 	 * params[2] Date 
106 	 * 
107 	 * EVENT_TYPE_ERROR_PARSING_SOSI_XML
108 	 * params[0] XML document
109 	 * 
110 	 * EVENT_TYPE_ERROR_VALIDATING_SOSI_MESSAGE
111 	 * params[0] SOSI Message
112 	 * 
113 	 * EVENT_TYPE_ERROR_VALIDATING_STS_CERTIFICATE
114 	 * params[0] X509Certificate
115 	 * 
116 	 * EVENT_TYPE_ERROR_VALIDATING_CERTIFICATE
117 	 * params[0] X509Certificate
118 	 *
119 	 * 
120 	 * @param event
121 	 * 		description of event
122 	 * @param params
123 	 * 		Array of parameters 
124 	 */
125 	void onErrorAuditingEvent(String event, Object[] params);
126 	
127 }