1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/**
* $RCSfile$
* $Revision: 719 $
* $Date: 2004-12-20 13:16:01 -0300 (Mon, 20 Dec 2004) $
*
* Copyright (C) 2007 Jive Software. All rights reserved.
*
* This software is published under the terms of the GNU Public License (GPL),
* a copy of which is included in this distribution.
*/
package org.jivesoftware.openfire.audit;
import org.jivesoftware.openfire.session.Session;
import org.xmpp.packet.Packet;
/**
* <p>Use auditors to audit events and messages on the server.</p>
* <p/>
* <p>All events and messages are sent to the auditor for recording.
* The auditor will determine if auditing should take place, and what
* to do with the data.</p>
*
* @author Iain Shigeoka
*/
public interface Auditor {
/**
* Audit an XMPP packet.
*
* @param packet the packet being audited
* @param session the session used for sending or receiving the packet
*/
void audit(Packet packet, Session session);
/**
* Audit any packet that was dropped (undeliverables, etc).
*
* @param packet the packet that was dropped.
*/
//void auditDroppedPacket(XMPPPacket packet);
/**
* Audit a non-packet event.
*
* @param event the event being audited.
*/
//void audit(AuditEvent event);
/**
* Prepares the auditor for system shutdown.
*/
void stop();
/**
* Returns the number of queued packets that are still in memory and need to be saved to a
* permanent store.
*
* @return the number of queued packets that are still in memory.
*/
int getQueuedPacketsNumber();
}