public class MessageAmp extends XMPPProcessor implements XMPPPacketFilterIfc, XMPPPostprocessorIfc, XMPPPreprocessorIfc, XMPPProcessorIfc
ALL_NAMES, ALL_PATHS, cmpInfoCLIENT_XMLNS| Constructor and Description |
|---|
MessageAmp() |
| Modifier and Type | Method and Description |
|---|---|
void |
filter(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results) |
String |
id()
Method
id returns a unique ID of the plugin. |
void |
init(Map<String,Object> settings)
Method
init is called just after the plugin has been loaded
into memory. |
void |
postProcess(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
Performs processing of
packet for which there was no processor. |
boolean |
preProcess(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
Performs pre-processing of
packet. |
void |
process(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings) |
Element[] |
supDiscoFeatures(XMPPResourceConnection session)
Method
supDiscoFeatures returns an array of XML
Elements with service discovery features which have to be
returned to the client uppon request. |
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, getStatistics, isSupporting, supElements, supStreamFeatures, supTypes, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcanHandle, concurrentQueuesNo, concurrentThreadsPerQueue, getComponentInfo, getStatistics, isSupporting, supElements, supStreamFeatures, supTypescompareTopublic String id()
XMPPImplIfcid 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 XMPPImplIfcString valuepublic void init(Map<String,Object> settings) throws TigaseDBException
XMPPImplIfcinit is called just after the plugin has been loaded
into memory. The idea behind this is to allow it to initialize or check the
database. This might be especially useful for plugins which want to have a
database access via non-standard stored procedures or need schema upgrade.init in interface XMPPImplIfcinit in class XMPPProcessorsettings - is a Map with initial processor settings from the configuration
file.TigaseDBExceptionpublic void filter(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results)
filter in interface XMPPPacketFilterIfcpublic void postProcess(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings)
XMPPPostprocessorIfcpacket for which there was no processor.postProcess in interface XMPPPostprocessorIfcpacket - 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.public boolean preProcess(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings)
XMPPPreprocessorIfcpacket. Intention for the pre-processors is to allow them for
packet blocking.preProcess in interface XMPPPreprocessorIfcpacket - 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.public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws XMPPException
process in interface XMPPProcessorIfcpacket - 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.XMPPExceptionpublic Element[] supDiscoFeatures(XMPPResourceConnection session)
XMPPImplIfcsupDiscoFeatures returns an array of XML
Elements 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.supDiscoFeatures in interface XMPPImplIfcsupDiscoFeatures in class XMPPProcessorsession - a XMPPResourceConnection valueElement[] valuepublic String[][] supElementNamePaths()
XMPPImplIfcsupElementNamePaths 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 XMPPImplIfcsupElementNamePaths in class XMPPProcessorString[][] 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()
XMPPImplIfcsupNamespaces 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 XMPPImplIfcsupNamespaces in class XMPPProcessorString[] valueCopyright © 2018 "Tigase, Inc.". All rights reserved.