@Bean(name="amp", parent=SessionManager.class, active=true, exportable=true) public class MessageAmp extends XMPPProcessor implements XMPPPacketFilterIfc, XMPPPostprocessorIfc, XMPPPreprocessorIfc, XMPPProcessorIfc, RegistrarBean, MessageDeliveryProviderIfc
| Modifier and Type | Field and Description |
|---|---|
protected static String |
ID |
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) |
Set<JID> |
getJIDsForMessageDelivery(XMPPResourceConnection session) |
boolean |
hasConnectionForMessageDelivery(XMPPResourceConnection session) |
String |
id()
Method
id returns a unique ID of the plugin. |
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) |
void |
register(Kernel kernel)
Method called when bean is being registered allowing developer to programatically register other beans.
|
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. |
void |
unregister(Kernel kernel)
Method called while bean is being unregistered.
|
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, supStreamFeatures, supTypes, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcanHandle, concurrentQueuesNo, getComponentInfo, getStatistics, init, supStreamFeatures, supTypescompareToprotected static final String ID
public 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 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[] valuepublic void register(Kernel kernel)
RegistrarBeanregister in interface RegistrarBeankernel - - instance from local scopepublic void unregister(Kernel kernel)
RegistrarBeanunregister in interface RegistrarBeankernel - - instance from local scopepublic Set<JID> getJIDsForMessageDelivery(XMPPResourceConnection session) throws NotAuthorizedException
getJIDsForMessageDelivery in interface MessageDeliveryProviderIfcNotAuthorizedExceptionpublic boolean hasConnectionForMessageDelivery(XMPPResourceConnection session)
hasConnectionForMessageDelivery in interface MessageDeliveryProviderIfcCopyright © 2004–2021 "Tigase, Inc.". All rights reserved.