01: /*
02: * JOSSO: Java Open Single Sign-On
03: *
04: * Copyright 2004-2008, Atricore, Inc.
05: *
06: * This is free software; you can redistribute it and/or modify it
07: * under the terms of the GNU Lesser General Public License as
08: * published by the Free Software Foundation; either version 2.1 of
09: * the License, or (at your option) any later version.
10: *
11: * This software is distributed in the hope that it will be useful,
12: * but WITHOUT ANY WARRANTY; without even the implied warranty of
13: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14: * Lesser General Public License for more details.
15: *
16: * You should have received a copy of the GNU Lesser General Public
17: * License along with this software; if not, write to the Free
18: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
19: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
20: */
21: package org.josso.gateway.audit;
22:
23: import java.util.Date;
24: import java.util.Properties;
25:
26: /**
27: * Represents an audit trail, it provides information about security relevant events.
28: *
29: * @author <a href="mailto:sgonzalez@josso.org">Sebastian Gonzalez Oyuela</a>
30: * @version $Id: SSOAuditTrail.java 508 2008-02-18 13:32:29Z sgonzalez $
31: */
32: public interface SSOAuditTrail {
33:
34: /**
35: * This trail category
36: */
37: String getCategory();
38:
39: /**
40: * This trail severity
41: */
42: String getSeverity();
43:
44: /**
45: * The action performed by the subject.
46: */
47: String getAction();
48:
49: /**
50: * The action outcome.
51: */
52: String getOutcome();
53:
54: /**
55: * The subject name that performed the action.
56: */
57: String getSubject();
58:
59: /**
60: * The time when the action was performed.
61: */
62: Date getTime();
63:
64: /**
65: * Action relevant properties.
66: */
67: Properties getProperties();
68:
69: /**
70: * The error, if any, associated with this action.
71: */
72: Throwable getError();
73: }
|