net.bluemind.xmpp.server

Class BMOfflineMessages

java.lang.Object

tigase.xmpp.XMPPProcessor

net.bluemind.xmpp.server.BMOfflineMessages

All Implemented Interfaces:

java.lang.Comparable<tigase.xmpp.XMPPImplIfc>, tigase.xmpp.XMPPImplIfc, tigase.xmpp.XMPPPostprocessorIfc, tigase.xmpp.XMPPProcessorIfc

public class BMOfflineMessages
extends tigase.xmpp.XMPPProcessor
implements tigase.xmpp.XMPPPostprocessorIfc, tigase.xmpp.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 <presence>. Created: Mon Oct 16 13:28:53 2006

Author:

Artur Hefczyc

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	MESSAGE_EVENT_PATH Field holds an array for element paths for which the plugin offers message saving capabilities.
static java.lang.String[]	MESSAGE_HEADER_PATH Field holds an array for element paths for which the plugin offers processing capabilities.
protected static java.lang.String	XMLNS Field holds default client namespace for stanzas.

Fields inherited from class tigase.xmpp.XMPPProcessor

ALL_NAMES, ALL_PATHS, cmpInfo

Fields inherited from interface tigase.xmpp.XMPPImplIfc

CLIENT_XMLNS

Constructor Summary

Constructors

Constructor and Description
BMOfflineMessages()

Method Summary

Modifier and Type	Method and Description
int	concurrentQueuesNo()
protected tigase.db.MsgRepositoryIfc	getMsgRepoImpl(tigase.db.NonAuthUserRepository repo, tigase.xmpp.XMPPResourceConnection conn) Method allows obtaining instance of MsgRepositoryIfc interface implementation.
java.lang.String	id()
protected boolean	loadOfflineMessages(tigase.server.Packet packet, tigase.xmpp.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.
void	postProcess(tigase.server.Packet packet, tigase.xmpp.XMPPResourceConnection conn, tigase.db.NonAuthUserRepository repo, java.util.Queue<tigase.server.Packet> queue, java.util.Map<java.lang.String,java.lang.Object> settings) OfflineMessages postprocessor simply calls savePacketForOffLineUser method to store packet to offline repository.
void	process(tigase.server.Packet packet, tigase.xmpp.XMPPResourceConnection conn, tigase.db.NonAuthUserRepository repo, java.util.Queue<tigase.server.Packet> results, java.util.Map<java.lang.String,java.lang.Object> settings) OfflineMessages processor is triggered by <presence> stanza.
java.util.Queue<tigase.server.Packet>	restorePacketForOffLineUser(tigase.xmpp.XMPPResourceConnection conn, tigase.db.MsgRepositoryIfc repo) Method restores all messages from repository for the JID of the current session.
boolean	savePacketForOffLineUser(tigase.server.Packet pac, tigase.db.MsgRepositoryIfc repo) Method stores messages to offline repository with the following rules applied, i.e.
tigase.xml.Element[]	supDiscoFeatures(tigase.xmpp.XMPPResourceConnection session)
java.lang.String[][]	supElementNamePaths()
java.lang.String[]	supNamespaces()

Methods inherited from class tigase.xmpp.XMPPProcessor

canHandle, compareTo, concurrentThreadsPerQueue, getComponentInfo, getInstance, getStatistics, init, isSupporting, supElements, supStreamFeatures, supTypes, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface tigase.xmpp.XMPPImplIfc

canHandle, concurrentThreadsPerQueue, getComponentInfo, getStatistics, init, isSupporting, supElements, supStreamFeatures, supTypes

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

XMLNS

protected static final java.lang.String XMLNS

Field holds default client namespace for stanzas. In case of msgoffline plugin it is jabber:client

See Also:

Constant Field Values

MESSAGE_EVENT_PATH

public static final java.lang.String[] MESSAGE_EVENT_PATH

Field holds an array for element paths for which the plugin offers message saving capabilities. In case of msgoffline plugin it is presence stanza

MESSAGE_HEADER_PATH

public static final java.lang.String[] MESSAGE_HEADER_PATH

Field holds an array for element paths for which the plugin offers processing capabilities. In case of msgoffline plugin it is presence stanza

Constructor Detail

BMOfflineMessages

public BMOfflineMessages()

Method Detail

concurrentQueuesNo

public int concurrentQueuesNo()

Specified by:

concurrentQueuesNo in interface tigase.xmpp.XMPPImplIfc

id

public java.lang.String id()

Specified by:

id in interface tigase.xmpp.XMPPImplIfc

postProcess

public void postProcess(tigase.server.Packet packet,
                        tigase.xmpp.XMPPResourceConnection conn,
                        tigase.db.NonAuthUserRepository repo,
                        java.util.Queue<tigase.server.Packet> queue,
                        java.util.Map<java.lang.String,java.lang.Object> settings)

OfflineMessages postprocessor simply calls savePacketForOffLineUser method to store packet to offline repository.

Specified by:

postProcess in interface tigase.xmpp.XMPPPostprocessorIfc

Parameters:

conn -

queue -

process

public void process(tigase.server.Packet packet,
                    tigase.xmpp.XMPPResourceConnection conn,
                    tigase.db.NonAuthUserRepository repo,
                    java.util.Queue<tigase.server.Packet> results,
                    java.util.Map<java.lang.String,java.lang.Object> settings)
             throws tigase.xmpp.NotAuthorizedException

OfflineMessages processor 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:

process in interface tigase.xmpp.XMPPProcessorIfc

Parameters:

conn -

Throws:

tigase.xmpp.NotAuthorizedException

restorePacketForOffLineUser

public java.util.Queue<tigase.server.Packet> restorePacketForOffLineUser(tigase.xmpp.XMPPResourceConnection conn,
                                                                         tigase.db.MsgRepositoryIfc repo)
                                                                  throws tigase.db.UserNotFoundException,
                                                                         tigase.xmpp.NotAuthorizedException

Method restores all messages from repository for the JID of the current session. All retrieved elements are then instantiated as Packet objects added to LinkedList collection 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 of MsgRepositoryIfc interface

Returns:

a Queue of Packet objects based on all stored payloads for the JID of the current session.

Throws:

tigase.db.UserNotFoundException

tigase.xmpp.NotAuthorizedException

savePacketForOffLineUser

public boolean savePacketForOffLineUser(tigase.server.Packet pac,
                                        tigase.db.MsgRepositoryIfc repo)
                                 throws tigase.db.UserNotFoundException

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 the delay element and appropriate timestamp.

Parameters:

pac - a Packet object containing packet that should be verified and saved

repo - a MsgRepositoryIfc repository handler responsible for storing messages

Returns:

true if the packet was correctly saved to repository, false otherwise.

Throws:

tigase.db.UserNotFoundException

supDiscoFeatures

public tigase.xml.Element[] supDiscoFeatures(tigase.xmpp.XMPPResourceConnection session)

Specified by:

supDiscoFeatures in interface tigase.xmpp.XMPPImplIfc

Overrides:

supDiscoFeatures in class tigase.xmpp.XMPPProcessor

supElementNamePaths

public java.lang.String[][] supElementNamePaths()

Specified by:

supElementNamePaths in interface tigase.xmpp.XMPPImplIfc

Overrides:

supElementNamePaths in class tigase.xmpp.XMPPProcessor

supNamespaces

public java.lang.String[] supNamespaces()

Specified by:

supNamespaces in interface tigase.xmpp.XMPPImplIfc

Overrides:

supNamespaces in class tigase.xmpp.XMPPProcessor

getMsgRepoImpl

protected tigase.db.MsgRepositoryIfc getMsgRepoImpl(tigase.db.NonAuthUserRepository repo,
                                                    tigase.xmpp.XMPPResourceConnection conn)

Method allows obtaining instance of MsgRepositoryIfc interface implementation.

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 of MsgRepositoryIfc interface

Returns:

instance of MsgRepositoryIfc interface implementation.

loadOfflineMessages

protected boolean loadOfflineMessages(tigase.server.Packet packet,
                                      tigase.xmpp.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.

Parameters:

packet - a Packet object containing packet that should be verified and saved

conn - user session which keeps all the user session data and also gives an access to the user's repository data.

Returns:

true if the messages should be loaded, false otherwise.