Package tigase.xmpp.impl
Class BlockingCommand
java.lang.Object
tigase.xmpp.XMPPProcessor
tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
tigase.xmpp.XMPPProcessorAbstract
tigase.xmpp.impl.BlockingCommand
- All Implemented Interfaces:
Comparable<XMPPImplIfc>,XMPPImplIfc,XMPPProcessorConcurrencyAwareIfc,XMPPProcessorIfc
@Bean(name="urn:xmpp:blocking",
parent=SessionManager.class,
active=true)
public class BlockingCommand
extends XMPPProcessorAbstract
implements XMPPProcessorIfc
XEP-0191: Blocking Command. Based on privacy lists.
- Author:
- Andrzej Wójcik
Originally submitted by:, Daniele Ricci, Behnam Hatami
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final Stringprotected static final Stringprotected static final Stringprotected static final Stringprotected static final Stringprotected static final StringFields inherited from class tigase.xmpp.XMPPProcessor
ALL_NAMES, ALL_PATHS, cmpInfoFields inherited from interface tigase.xmpp.XMPPImplIfc
CLIENT_XMLNS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidprocess(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) voidprocessFromUserToServerPacket(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...).voidprocessServerSessionPacket(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.voidsetSpamReportsConsumers(List<SpamReportsConsumer> spamReportsConsumers) Element[]supDiscoFeatures(XMPPResourceConnection session) MethodsupDiscoFeaturesreturns an array of XMLElements with service discovery features which have to be returned to the client uppon request.Methods inherited from class tigase.xmpp.XMPPProcessorAbstract
isFromUserSession, isNullSession, isServerSession, isToUserSession, processFromUserOutPacket, processFromUserPacket, processNullSessionPacket, processToUserPacketMethods inherited from class tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
id, supElementNamePaths, supNamespaces, supStreamFeatures, supTypesMethods inherited from class tigase.xmpp.XMPPProcessor
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.Comparable
compareToMethods inherited from interface tigase.xmpp.XMPPImplIfc
canHandle, concurrentQueuesNo, getComponentInfo, getStatistics, id, init, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
-
Field Details
-
XMLNS
- See Also:
-
XMLNS_ERRORS
- See Also:
-
ID
- See Also:
-
BLOCKLIST
- See Also:
-
BLOCK
- See Also:
-
UNBLOCK
- See Also:
-
-
Constructor Details
-
BlockingCommand
public BlockingCommand()
-
-
Method Details
-
supDiscoFeatures
Description copied from interface:XMPPImplIfcMethodsupDiscoFeaturesreturns an array of XMLElements with service discovery features which have to be returned to the client uppon request. Service discovery features returned by this method correspond to services supported by this plugin.- Specified by:
supDiscoFeaturesin interfaceXMPPImplIfc- Overrides:
supDiscoFeaturesin classAnnotatedXMPPProcessor- Parameters:
session- aXMPPResourceConnectionvalue- Returns:
- an
Element[]value
-
setSpamReportsConsumers
-
process
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws XMPPException- Specified by:
processin interfaceXMPPProcessorIfc- Overrides:
processin classXMPPProcessorAbstract- Parameters:
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.- Throws:
XMPPException
-
processFromUserToServerPacket
public void processFromUserToServerPacket(JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws PacketErrorTypeExceptionDescription copied from class:XMPPProcessorAbstractThe 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.- Specified by:
processFromUserToServerPacketin classXMPPProcessorAbstract- Parameters:
connectionId- is aJIDinstance with the session connection ID.packet- is aPacketsent by the user.session- is aXMPPResourceConnectioninstance with all the sending user session data.repo- is aNonAuthUserRepositoryinstance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.results- is a packetsQueuewith all the processing results from the plugin.settings- is aMapwith all the configuration settings passed to the plugin.- Throws:
PacketErrorTypeException- on attempt to send an error response to the error packet.
-
processServerSessionPacket
public void processServerSessionPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws PacketErrorTypeExceptionDescription copied from class:XMPPProcessorAbstractThe 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 theprocessFromUserPacket(...)method. This method is not called for such packets.- Specified by:
processServerSessionPacketin classXMPPProcessorAbstract- Parameters:
packet- is aPacketreceived by the server and addressed to the server - the server virtual domain name.session- is aXMPPResourceConnectioninstance with all the server session data.repo- is aNonAuthUserRepositoryinstance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.results- is a packetsQueuewith all the processing results from the plugin.settings- is aMapwith all the configuration settings passed to the plugin.- Throws:
PacketErrorTypeException- on attempt to send an error response to the error packet.
-