tigase.xmpp
public abstract class XMPPProcessorAbstract extends XMPPProcessor implements XMPPProcessorIfc
ALL_NAMES, ALL_PATHS
CLIENT_XMLNS
Constructor and Description |
---|
XMPPProcessorAbstract() |
Modifier and Type | Method and Description |
---|---|
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.
|
canHandle, compareTo, concurrentQueuesNo, concurrentThreadsPerQueue, getInstance, getStatistics, init, isSupporting, supDiscoFeatures, supElementNamePaths, supElements, supNamespaces, supStreamFeatures, supTypes
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
canHandle, concurrentQueuesNo, concurrentThreadsPerQueue, getStatistics, id, init, isSupporting, supDiscoFeatures, supElementNamePaths, supElements, supNamespaces, supStreamFeatures, supTypes
compareTo
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws XMPPException
process
in interface XMPPProcessorIfc
packet
- session
- repo
- results
- settings
- XMPPException
public void processFromUserOutPacket(tigase.xmpp.JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
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.PacketErrorTypeException
- on attempt to send an error response to the error
packet.public void processFromUserPacket(tigase.xmpp.JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
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 overwrite the method to change
the default behavior or implement the two called methods to handle each case
separately.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.PacketErrorTypeException
- on attempt to send an error response to the error
packet.public abstract void processFromUserToServerPacket(tigase.xmpp.JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
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.PacketErrorTypeException
- on attempt to send an error response to the error
packet.public void processNullSessionPacket(Packet packet, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
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.PacketErrorTypeException
- on attempt to send an error response to the error
packet.public abstract void processServerSessionPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
processFromUserPacket(...)
method. This method is not called for such
packets.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.PacketErrorTypeException
- on attempt to send an error response to the error
packet.public void processToUserPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
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.PacketErrorTypeException
- on attempt to send an error response to the error
packet.Copyright © 2013 Tigase. All rights reserved.