public class CAPS extends XMPPProcessor implements XMPPProcessorIfc
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
CAPS() |
Modifier and Type | Method and Description |
---|---|
static Set<JID> |
getJidsWithFeature(XMPPResourceConnection session,
String feature) |
String |
id()
Method
id returns a unique ID of the plugin. |
void |
process(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings) |
String[][] |
supElementNamePaths()
Method
supElementNamePaths returns an array of element names in form of a full path to the XML
element for stanzas which can be processed by this plugin. |
String[] |
supNamespaces()
Method
supNamespaces returns an array of name-spaces for stanzas which can be processed by this
plugin. |
canHandle, compareTo, concurrentThreadsPerQueue, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, isSupporting, supDiscoFeatures, supElements, supStreamFeatures, supTypes, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, concurrentQueuesNo, concurrentThreadsPerQueue, getComponentInfo, getStatistics, init, isSupporting, supDiscoFeatures, supElements, supStreamFeatures, supTypes
compareTo
public static Set<JID> getJidsWithFeature(XMPPResourceConnection session, String feature)
public String id()
XMPPImplIfc
id
returns a unique ID of the plugin. Each plugin has own, unique ID which is used in the
configuration file to determine whether it needs to be loaded or not. In most cases the ID can be equal to XMLNS
of the packages processed by the plugin.id
in interface XMPPImplIfc
String
valuepublic String[][] supElementNamePaths()
XMPPImplIfc
supElementNamePaths
returns an array of element names in form of a full path to the XML
element for stanzas which can be processed by this plugin. Each element name path corresponds to XMLNS returned
in array by supNamespaces()
method. The element path itself is represented by a String array with
each path element as a separate String.supElementNamePaths
in interface XMPPImplIfc
supElementNamePaths
in class XMPPProcessor
String[][]
value is an array for element paths for which the plugin offers processing
capabilities. Each path is in form of a String array in order to reduce parsing overhead.public String[] supNamespaces()
XMPPImplIfc
supNamespaces
returns an array of name-spaces for stanzas which can be processed by this
plugin. Each namespace corresponds to element name returned in array by supElemenets()
method.supNamespaces
in interface XMPPImplIfc
supNamespaces
in class XMPPProcessor
String[]
valuepublic 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
Copyright © 2004–2019 "Tigase, Inc.". All rights reserved.