public abstract class XMPPProcessorAbstract extends AnnotatedXMPPProcessor implements XMPPProcessorIfc
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
XMPPProcessorAbstract() |
Modifier and Type | Method and Description |
---|---|
static boolean |
isFromUserSession(Packet packet,
XMPPResourceConnection session) |
static boolean |
isNullSession(Packet packet,
XMPPResourceConnection session) |
static boolean |
isServerSession(Packet packet,
XMPPResourceConnection session) |
static boolean |
isToUserSession(Packet packet,
XMPPResourceConnection session) |
void |
process(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings) |
void |
processFromUserOutPacket(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(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(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.
|
id, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, concurrentQueuesNo, getComponentInfo, getStatistics, id, init, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
compareTo
public static boolean isFromUserSession(Packet packet, XMPPResourceConnection session)
public static boolean isNullSession(Packet packet, XMPPResourceConnection session)
public static boolean isServerSession(Packet packet, XMPPResourceConnection session)
public static boolean isToUserSession(Packet packet, XMPPResourceConnection session)
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws XMPPException
process
in interface XMPPProcessorIfc
packet
- packet is which being processed. This parameter may never be null. Even though this is not
immutable object it mustn't be altered. None of it's fields or attributes can be changed during processing.session
- user session which keeps all the user session data and also gives an access to the user's
repository data. It allows for storing information in a permanent storage or in memory only during the live of
the online session. This parameter can be null if there is no online user session at the time of the packet
processing.repo
- this is a user data storage which is normally used when the user session (parameter above) is null.
This is repository allows for a very restricted access only. It allows for storing some user private data
(doesn't allow overwriting existing data) like messages for offline users and it also allows for reading user
public data like VCard.results
- this a collection with packets which have been generated as input packet processing results.
Regardless a response to a user request is sent or the packet is forwarded to it's destination it is always
required that a copy of the input packet is created and stored in the results queue.settings
- this map keeps plugin specific settings loaded from the Tigase server configuration. In most
cases it is unused, however if the plugin needs to access an external database that this is a way to pass
database connection string to the plugin.XMPPException
public void processFromUserOutPacket(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(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(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 © 2004–2020 "Tigase, Inc.". All rights reserved.