tigase.xmpp
Class XMPPProcessorAbstract

java.lang.Object
  extended by tigase.xmpp.XMPPProcessor
      extended by tigase.xmpp.XMPPProcessorAbstract
All Implemented Interfaces:
Comparable<XMPPProcessor>, XMPPImplIfc, XMPPProcessorIfc
Direct Known Subclasses:
JabberIqVersion, PepPlugin, ServiceDiscovery, UrnXmppPing, VCardTemp

public abstract class XMPPProcessorAbstract
extends XMPPProcessor
implements XMPPProcessorIfc

Utility abstract class detecting what kind of packet is processed. Releases developers from checking whether the packet is addressed to the user of the session or from the user of the sesion or packet to the server itself. Created: Mar 1, 2010 10:21:29 AM

Version:
$Rev: 2090 $
Author:
Artur Hefczyc

Field Summary
 
Fields inherited from class tigase.xmpp.XMPPProcessor
ALL
 
Constructor Summary
XMPPProcessorAbstract()
           
 
Method Summary
 void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings)
          Method description
 void processFromUserOutPacket(tigase.xmpp.JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings)
          The method is called when a packet is sent from the user, owner of the session somewhere else to other XMPP entity (other user on the server, other user on a different server, different server, component, transport, etc....).
 void processFromUserPacket(tigase.xmpp.JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings)
          The method is called for all packets sent by the user, owner of this connection/session.
abstract  void processFromUserToServerPacket(tigase.xmpp.JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings)
          The method is called when a packet is send from the user who is owner of the session to the local server (ping, roster management, privacy lists, etc...).
 void processNullSessionPacket(Packet packet, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings)
          The method is called for packets received by the server for which no user session is found - neither sender session or receiver session.
abstract  void processServerSessionPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings)
          The method is called when a packet addressed to the server domain is received.
 void processToUserPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings)
          Method is called for all the packets sent TO the user - owner of the session.
 
Methods inherited from class tigase.xmpp.XMPPProcessor
compareTo, concurrentQueuesNo, concurrentThreadsPerQueue, getInstance, init, isSupporting, supDiscoFeatures, supElements, supNamespaces, supStreamFeatures
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface tigase.xmpp.XMPPImplIfc
concurrentQueuesNo, concurrentThreadsPerQueue, id, init, isSupporting, supDiscoFeatures, supElements, supNamespaces, supStreamFeatures
 

Constructor Detail

XMPPProcessorAbstract

public XMPPProcessorAbstract()
Method Detail

processFromUserToServerPacket

public abstract void processFromUserToServerPacket(tigase.xmpp.JID connectionId,
                                                   Packet packet,
                                                   XMPPResourceConnection session,
                                                   NonAuthUserRepository repo,
                                                   Queue<Packet> results,
                                                   Map<String,Object> settings)
                                            throws PacketErrorTypeException
The method is called when a packet is send from the user who is owner of the session to the local server (ping, roster management, privacy lists, etc...). There is no default implementation for the method.

Parameters:
connectionId - is a JID instance with the session connection ID.
session - is a XMPPResourceConnection instance with all the sending user session data.
packet - is a Packet sent by the user.
repo - is a NonAuthUserRepository instance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.
results - is a packets Queue with all the processing results from the plugin.
settings - is a Map with all the configuration settings passed to the plugin.
Throws:
PacketErrorTypeException - on attempt to send an error response to the error packet.

processServerSessionPacket

public abstract void processServerSessionPacket(Packet packet,
                                                XMPPResourceConnection session,
                                                NonAuthUserRepository repo,
                                                Queue<Packet> results,
                                                Map<String,Object> settings)
                                         throws PacketErrorTypeException
The method is called when a packet addressed to the server domain is received. Please note, if a local user sends a packet to the server, the packet is handled by the processFromUserPacket(...) method. This method is not called for such packets.

Parameters:
session - is a XMPPResourceConnection instance with all the server session data.
packet - is a Packet received by the server and addressed to the server - the server virtual domain name.
repo - is a NonAuthUserRepository instance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.
results - is a packets Queue with all the processing results from the plugin.
settings - is a Map with all the configuration settings passed to the plugin.
Throws:
PacketErrorTypeException - on attempt to send an error response to the error packet.

process

public void process(Packet packet,
                    XMPPResourceConnection session,
                    NonAuthUserRepository repo,
                    Queue<Packet> results,
                    Map<String,Object> settings)
             throws XMPPException
Method description

Specified by:
process in interface XMPPProcessorIfc
Parameters:
packet -
session -
repo -
results -
settings -
Throws:
XMPPException

processFromUserOutPacket

public void processFromUserOutPacket(tigase.xmpp.JID connectionId,
                                     Packet packet,
                                     XMPPResourceConnection session,
                                     NonAuthUserRepository repo,
                                     Queue<Packet> results,
                                     Map<String,Object> settings)
                              throws PacketErrorTypeException
The method is called when a packet is sent from the user, owner of the session somewhere else to other XMPP entity (other user on the server, other user on a different server, different server, component, transport, etc....). The default implementation just forwards the packet doing nothing else, which is good enough in most cases. You can overwrite the method to change the default behaviour.

Parameters:
connectionId - is a JID instance with the session connection ID.
session - is a XMPPResourceConnection instance with all the sending user session data.
packet - is a Packet sent by the user.
repo - is a NonAuthUserRepository instance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.
results - is a packets Queue with all the processing results from the plugin.
settings - is a Map with all the configuration settings passed to the plugin.
Throws:
PacketErrorTypeException - on attempt to send an error response to the error packet.

processFromUserPacket

public void processFromUserPacket(tigase.xmpp.JID connectionId,
                                  Packet packet,
                                  XMPPResourceConnection session,
                                  NonAuthUserRepository repo,
                                  Queue<Packet> results,
                                  Map<String,Object> settings)
                           throws PacketErrorTypeException
The method is called for all packets sent by the user, owner of this connection/session. Please note, it is likely that a user sends a packet addressed to his own server, like get server version information. In such a case only this method is called. Such a packet is not later passed to the processServerSessionPacket(...). Note, the default implementation checks whether the packet is addressed to the server or is being sent to another XMPP entity. In the first case it calls processFromUserToServerPacket(...) method, otherwise it calls processFromUserOutPacket. You can overwite the method to change the default bahaviour or implement the two called methods to handle each case separately.

Parameters:
connectionId - is a JID instance with the session connection ID.
session - is a XMPPResourceConnection instance with all the sending user session data.
packet - is a Packet sent by the user.
repo - is a NonAuthUserRepository instance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.
results - is a packets Queue with all the processing results from the plugin.
settings - is a Map with all the configuration settings passed to the plugin.
Throws:
PacketErrorTypeException - on attempt to send an error response to the error packet.

processNullSessionPacket

public void processNullSessionPacket(Packet packet,
                                     NonAuthUserRepository repo,
                                     Queue<Packet> results,
                                     Map<String,Object> settings)
                              throws PacketErrorTypeException
The method is called for packets received by the server for which no user session is found - neither sender session or receiver session. The default implementation does nothing, just ignores such a packet. To change the default behaviour the method has to be overwritten.

Parameters:
packet - is a Packet received by the server.
repo - is a NonAuthUserRepository instance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.
results - is a packets Queue with all the processing results from the plugin.
settings - is a Map with all the configuration settings passed to the plugin.
Throws:
PacketErrorTypeException - on attempt to send an error response to the error packet.

processToUserPacket

public void processToUserPacket(Packet packet,
                                XMPPResourceConnection session,
                                NonAuthUserRepository repo,
                                Queue<Packet> results,
                                Map<String,Object> settings)
                         throws PacketErrorTypeException
Method is called for all the packets sent TO the user - owner of the session. The default implementation just forwards the packet to the user connection. To change the default behavviour the method has to be overwritten.

Parameters:
session - is a XMPPResourceConnection instance with all the receiving user session data.
packet - is a Packet received by the server and addressed to the server - the server virtual domain name.
repo - is a NonAuthUserRepository instance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.
results - is a packets Queue with all the processing results from the plugin.
settings - is a Map with all the configuration settings passed to the plugin.
Throws:
PacketErrorTypeException - on attempt to send an error response to the error packet.


Copyright © 2001-2006 Tigase Developers Team. All rights Reserved.