public class BlockingCommand extends XMPPProcessorAbstract implements XMPPProcessorIfc
Modifier and Type | Field and Description |
---|---|
protected static String |
BLOCK |
protected static String |
BLOCKLIST |
protected static String |
ID |
protected static String |
UNBLOCK |
protected static String |
XMLNS |
protected static String |
XMLNS_ERRORS |
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
BlockingCommand() |
Modifier and Type | Method and Description |
---|---|
void |
process(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings) |
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 |
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.
|
processFromUserOutPacket, processFromUserPacket, processNullSessionPacket, processToUserPacket
id, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
canHandle, compareTo, concurrentThreadsPerQueue, getComponentInfo, getInstance, getStatistics, init, isSupporting, supElements, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, concurrentQueuesNo, concurrentThreadsPerQueue, getComponentInfo, getStatistics, id, init, isSupporting, supDiscoFeatures, supElementNamePaths, supElements, supNamespaces, supStreamFeatures, supTypes
compareTo
protected static final String XMLNS
protected static final String XMLNS_ERRORS
protected static final String ID
protected static final String BLOCKLIST
protected static final String BLOCK
protected static final String UNBLOCK
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws XMPPException
process
in interface XMPPProcessorIfc
process
in class XMPPProcessorAbstract
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 processFromUserToServerPacket(JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
XMPPProcessorAbstract
processFromUserToServerPacket
in class XMPPProcessorAbstract
connectionId
- is a JID
instance with the session connection ID.packet
- is a Packet
sent by the user.session
- is a XMPPResourceConnection
instance with all the sending
user session data.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 processServerSessionPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
XMPPProcessorAbstract
processFromUserPacket(...)
method. This method is not called for such
packets.processServerSessionPacket
in class XMPPProcessorAbstract
packet
- is a Packet
received by the server and addressed to the
server - the server virtual domain name.session
- is a XMPPResourceConnection
instance with all the server
session data.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 © 2019 "Tigase, Inc.". All rights reserved.