Constructors Constructor Description
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
canHandle(Packet packet, XMPPResourceConnection conn)
generateId(BareJID channel, java.lang.String packetID)
process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> settings)
sendToChannel(BareJID userJID, BareJID channel, java.lang.String id, Element actionEl, java.util.function.Consumer<Packet> writer)
sendToUser(BareJID userJID, java.lang.String resource, JID connectionJID, StanzaType stanzaType, java.lang.String id, Element actionEl, Element errorEl, java.util.function.Consumer<Packet> writer)
Methods inherited from class tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
id, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures, supTypes
Methods inherited from class tigase.xmpp.XMPPProcessor
compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public static final java.lang.String ID
- See Also:
- Constant Field Values
public Authorization canHandle(Packet packet, XMPPResourceConnection conn)Description copied from interface:
XMPPImplIfcBy default the method uses
XMPPImplIfc.supTypes()method results to determine whether the plugin would process given packet. However, a plugin can implement own logic to determine packet processing capabilities or conditions. Please note, this method must be very fast and efficient. No I/O processing is recommended as it may impact performance of the whole system.
- Specified by:
packet- is a
conn- is a user session object or null.
Authorizationenum value or null. Null means the plugin is simply not processing the packet.
Authorization.AUTHORIZEDmeans the plugin can process the packet, any other
Authorizationenum value means an error which has to be returned to the sender.
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, java.util.Queue<Packet> results, java.util.Map<java.lang.String,java.lang.Object> settings) throws XMPPException
- Specified by:
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.