/*
* Copyright (C) 2005-2008 Jive Software. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
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>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();
}