Package tigase.xmpp.impl
Class OfflineMessages
java.lang.Object
tigase.xmpp.XMPPProcessor
tigase.xmpp.impl.OfflineMessages
- All Implemented Interfaces:
Comparable<XMPPImplIfc>,XMPPImplIfc,XMPPPostprocessorIfc,XMPPProcessorConcurrencyAwareIfc,XMPPProcessorIfc
@Bean(name="msgoffline",
parent=SessionManager.class,
active=false)
public class OfflineMessages
extends XMPPProcessor
implements XMPPPostprocessorIfc, XMPPProcessorIfc
OfflineMessages plugin implementation which follows XEP-0160: Best
Practices for Handling Offline Messages specification. Responsible for storing messages send to offline users -
either as a standalone plugin or as a processor for other plugins (e.g. AMP). Is registered to handle packets of type
Created: Mon Oct 16 13:28:53 2006
<presence>.
Created: Mon Oct 16 13:28:53 2006
- Author:
- Artur Hefczyc
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfacestatic interfacestatic classstatic classComparatorinterface implementation for the purpose of sorting Elements retrieved from the repository by the timestamp stored indelayelement. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final StringField holds identification string for the plugin.static final String[]Field holds an array for element paths for which the plugin offers message saving capabilities.static final String[]Field holds an array for element paths for which the plugin offers processing capabilities.static final String[]static final String[]static final Stringstatic final String[]static final Stringstatic final Stringstatic final String[]protected static final StringField holds default client namespace for stanzas.Fields 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 TypeMethodDescriptionprotected OfflineMessages.OfflineMsgRepositoryIfcMethod allows obtaining instance ofMsgRepositoryIfcinterface implementation.String[]id()Methodidreturns a unique ID of the plugin.protected booleanMethod determines whether packet sent to offline user should be stored in offline storage or notprotected booleanprotected booleanloadOfflineMessages(Packet packet, XMPPResourceConnection conn) Method determines whether offline messages should be loaded - the process should be run only once per user session and only for available/null presence with priority greater than 0.protected voidnotifyNewOfflineMessage(Packet packet, XMPPResourceConnection conn, Queue<Packet> queue, Map<String, Object> settings) protected voidnotifyOfflineMessagesRetrieved(XMPPResourceConnection conn, Queue<Packet> queue) voidpostProcess(Packet packet, XMPPResourceConnection conn, NonAuthUserRepository repo, Queue<Packet> queue, Map<String, Object> settings) Performs processing ofpacketfor which there was no processor.voidprocess(Packet packet, XMPPResourceConnection conn, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings)
OfflineMessagesprocessor is triggered by<presence>stanza.voidprocessIq(Packet packet, XMPPResourceConnection conn, NonAuthUserRepository repo, Queue<Packet> results) Method restores all messages from repository for the JID of the current session.savePacketForOffLineUser(Packet packet, OfflineMsgRepositoryIfc repo, NonAuthUserRepository userRepo) Method stores messages to offline repository with the following rules applied, i.e.voidsetOfflineStorageMatchers(String[] matcherStrs) Element[]supDiscoFeatures(XMPPResourceConnection session) MethodsupDiscoFeaturesreturns an array of XMLElements with service discovery features which have to be returned to the client uppon request.String[][]MethodsupElementNamePathsreturns 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[]MethodsupNamespacesreturns an array of name-spaces for stanzas which can be processed by this plugin.Methods inherited from class tigase.xmpp.XMPPProcessor
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, supStreamFeatures, supTypes, 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, init, supStreamFeatures, supTypes
-
Field Details
-
MESSAGE_EVENT_PATH
Field holds an array for element paths for which the plugin offers message saving capabilities. In case ofmsgofflineplugin it is presence stanza -
MESSAGE_HEADER_PATH
Field holds an array for element paths for which the plugin offers processing capabilities. In case ofmsgofflineplugin it is presence stanza -
MESSAGE_HINTS_NO_STORE
-
MESSAGE_HINTS_STORE
-
MESSAGE_HINTS_XMLNS
- See Also:
-
MESSAGE_RECEIVED_PATH
-
MESSAGE_RECEIVED_XMLNS
- See Also:
-
PUBSUB_NODE_PATH
-
PUBSUB_NODE_KEY
- See Also:
-
XMLNS
Field holds default client namespace for stanzas. In case ofmsgofflineplugin it is jabber:client- See Also:
-
ID
Field holds identification string for the plugin. In case ofmsgofflineplugin it is msgoffline- See Also:
-
-
Constructor Details
-
OfflineMessages
public OfflineMessages()
-
-
Method Details
-
id
Description copied from interface:XMPPImplIfcMethodidreturns 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.- Specified by:
idin interfaceXMPPImplIfc- Returns:
- a
Stringvalue
-
postProcess
public void postProcess(Packet packet, XMPPResourceConnection conn, NonAuthUserRepository repo, Queue<Packet> queue, Map<String, Object> settings) Performs processing ofpacketfor which there was no processor.
OfflineMessages postprocessor simply callssavePacketForOffLineUsermethod to store packet to offline repository.- Specified by:
postProcessin interfaceXMPPPostprocessorIfc- 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.conn- 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.queue- 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.
-
process
public void process(Packet packet, XMPPResourceConnection conn, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws NotAuthorizedException
OfflineMessagesprocessor is triggered by<presence>stanza. Upon receiving it plugin tries to load messages from repository and, if the result is not empty, sends them to the user- Specified by:
processin interfaceXMPPProcessorIfc- 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.conn- 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:
NotAuthorizedException
-
processIq
public void processIq(Packet packet, XMPPResourceConnection conn, NonAuthUserRepository repo, Queue<Packet> results) throws NotAuthorizedException - Throws:
NotAuthorizedException
-
restorePacketForOffLineUser
public Queue<Packet> restorePacketForOffLineUser(XMPPResourceConnection conn, OfflineMsgRepositoryIfc repo) throws UserNotFoundException, NotAuthorizedException, TigaseDBException Method restores all messages from repository for the JID of the current session. All retrieved elements are then instantiated asPacketobjects added toLinkedListcollection and, if possible, sorted by timestamp.- Parameters:
conn- user session which keeps all the user session data and also gives an access to the user's repository data.repo- an implementation ofMsgRepositoryIfcinterface- Returns:
- a
QueueofPacketobjects based on all stored payloads for the JID of the current session. - Throws:
UserNotFoundExceptionNotAuthorizedExceptionTigaseDBException
-
savePacketForOffLineUser
public Authorization savePacketForOffLineUser(Packet packet, OfflineMsgRepositoryIfc repo, NonAuthUserRepository userRepo) throws UserNotFoundException, TigaseDBException Method stores messages to offline repository with the following rules applied, i.e. saves only:- message
stanza with either nonempty
<body>,<event>or<header>child element and only messages of type normal, chat. - presence stanza of type subscribe, subscribed, unsubscribe and unsubscribed.
Processed messages are stamped with thedelayelement and appropriate timestamp.- Parameters:
packet- aPacketobject containing packet that should be verified and savedrepo- aMsgRepositoryIfcrepository handler responsible for storing messages- Returns:
trueif the packet was correctly saved to repository,falseotherwise.- Throws:
UserNotFoundExceptionTigaseDBException
- message
stanza with either nonempty
-
getOfflineStorageMatchers
-
setOfflineStorageMatchers
-
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 classXMPPProcessor- Parameters:
session- aXMPPResourceConnectionvalue- Returns:
- an
Element[]value
-
supElementNamePaths
Description copied from interface:XMPPImplIfcMethodsupElementNamePathsreturns 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 bysupNamespaces()method. The element path itself is represented by a String array with each path element as a separate String.- Specified by:
supElementNamePathsin interfaceXMPPImplIfc- Overrides:
supElementNamePathsin classXMPPProcessor- Returns:
- a
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.
-
supNamespaces
Description copied from interface:XMPPImplIfcMethodsupNamespacesreturns an array of name-spaces for stanzas which can be processed by this plugin. Each namespace corresponds to element name returned in array bysupElemenets()method.- Specified by:
supNamespacesin interfaceXMPPImplIfc- Overrides:
supNamespacesin classXMPPProcessor- Returns:
- a
String[]value
-
getMsgRepoImpl
protected OfflineMessages.OfflineMsgRepositoryIfc getMsgRepoImpl(NonAuthUserRepository repo, XMPPResourceConnection conn) Method allows obtaining instance ofMsgRepositoryIfcinterface implementation.- Parameters:
repo- an implementation ofMsgRepositoryIfcinterfaceconn- user session which keeps all the user session data and also gives an access to the user's repository data.- Returns:
- instance of
MsgRepositoryIfcinterface implementation.
-
isAllowedForOfflineStorage
Method determines whether packet sent to offline user should be stored in offline storage or not -
isAllowedForOfflineStorageDefaults
-
loadOfflineMessages
Method determines whether offline messages should be loaded - the process should be run only once per user session and only for available/null presence with priority greater than 0.- Parameters:
packet- aPacketobject containing packet that should be verified and savedconn- user session which keeps all the user session data and also gives an access to the user's repository data.- Returns:
trueif the messages should be loaded,falseotherwise.
-
notifyNewOfflineMessage
-
notifyOfflineMessagesRetrieved
-