Auditor.java 1.38 KB
Newer Older
Matt Tucker's avatar
Matt Tucker committed
1 2 3 4 5 6 7 8 9 10 11 12 13
/**
 * $RCSfile$
 * $Revision$
 * $Date$
 *
 * Copyright (C) 2004 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.messenger.audit;

14
import org.xmpp.packet.Packet;
Matt Tucker's avatar
Matt Tucker committed
15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31

/**
 * <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
     */
32
    void audit(Packet packet);
Matt Tucker's avatar
Matt Tucker committed
33 34 35 36 37 38

    /**
     * Audit any packet that was dropped (undeliverables, etc).
     *
     * @param packet the packet that was dropped.
     */
39
    //void auditDroppedPacket(XMPPPacket packet);
Matt Tucker's avatar
Matt Tucker committed
40 41 42 43 44 45

    /**
     * Audit a non-packet event.
     *
     * @param event the event being audited.
     */
46
    //void audit(AuditEvent event);
Matt Tucker's avatar
Matt Tucker committed
47 48 49 50

    /**
     * Prepares the auditor for system shutdown.
     */
51 52 53 54 55 56 57 58 59
    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();
Matt Tucker's avatar
Matt Tucker committed
60
}