|
Openfire 3.7.1 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PacketInterceptor
A packet interceptor encapsulates an action that is invoked on a packet immediately before or after it was received by a SocketReader and also when the packet is about to be sent in SocketConnection. These types of actions fall into two broad categories:
InterceptorManager
Method Summary | |
---|---|
void |
interceptPacket(org.xmpp.packet.Packet packet,
Session session,
boolean incoming,
boolean processed)
Invokes the interceptor on the specified packet. |
Method Detail |
---|
void interceptPacket(org.xmpp.packet.Packet packet, Session session, boolean incoming, boolean processed) throws PacketRejectedException
An exception can only be thrown when processed is false which means that the read packet has not been processed yet or the packet was not sent yet. If the exception is thrown with a "read" packet then the sender of the packet will receive an answer with an error. But if the exception is thrown with a "sent" packet then nothing will happen.
Note that for each packet, every interceptor will be called twice: once before processing is complete (processing==true) and once after processing is complete. Typically, an interceptor will want to ignore one or the other case.
packet
- the packet to take action on.session
- the session that received or is sending the packet.incoming
- flag that indicates if the packet was read by the server or sent from
the server.processed
- flag that indicates if the action (read/send) was performed. (PRE vs. POST).
PacketRejectedException
- if the packet should be prevented from being processed.
|
Openfire 3.7.1 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |