@Bean(name="msgoffline", parent=SessionManager.class, active=false) public class OfflineMessages extends XMPPProcessor implements XMPPPostprocessorIfc, XMPPProcessorIfc
<presence>
.
Modifier and Type | Class and Description |
---|---|
static interface |
OfflineMessages.Notifier |
static interface |
OfflineMessages.OfflineMsgRepositoryIfc |
static class |
OfflineMessages.PubSubPublisherNotifier |
static class |
OfflineMessages.StampComparator
Comparator interface implementation for the purpose of sorting Elements retrieved from the repository by
the timestamp stored in delay element. |
Modifier and Type | Field and Description |
---|---|
protected static String |
ID
Field holds identification string for the plugin.
|
static String[] |
MESSAGE_EVENT_PATH
Field holds an array for element paths for which the plugin offers message saving capabilities.
|
static String[] |
MESSAGE_HEADER_PATH
Field holds an array for element paths for which the plugin offers processing capabilities.
|
static String[] |
MESSAGE_HINTS_NO_STORE |
static String |
MESSAGE_HINTS_XMLNS |
static String[] |
MESSAGE_RECEIVED_PATH |
static String |
MESSAGE_RECEIVED_XMLNS |
static String |
PUBSUB_NODE_KEY |
static String[] |
PUBSUB_NODE_PATH |
protected static String |
XMLNS
Field holds default client namespace for stanzas.
|
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
OfflineMessages() |
Modifier and Type | Method and Description |
---|---|
protected OfflineMessages.OfflineMsgRepositoryIfc |
getMsgRepoImpl(NonAuthUserRepository repo,
XMPPResourceConnection conn)
Method allows obtaining instance of
MsgRepositoryIfc interface implementation. |
String[] |
getOfflineStorageMatchers() |
String |
id()
Method
id returns a unique ID of the plugin. |
protected boolean |
isAllowedForOfflineStorage(Packet pac)
Method determines whether packet sent to offline user should be stored in offline storage or not
|
protected boolean |
isAllowedForOfflineStorageDefaults(Packet pac) |
protected boolean |
loadOfflineMessages(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 void |
notifyNewOfflineMessage(Packet packet,
XMPPResourceConnection conn,
Queue<Packet> queue,
Map<String,Object> settings) |
protected void |
notifyOfflineMessagesRetrieved(XMPPResourceConnection conn,
Queue<Packet> queue) |
void |
postProcess(Packet packet,
XMPPResourceConnection conn,
NonAuthUserRepository repo,
Queue<Packet> queue,
Map<String,Object> settings)
Performs processing of
packet for which there was no processor. |
void |
process(Packet packet,
XMPPResourceConnection conn,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
OfflineMessages processor is triggered by <presence> stanza. |
void |
processIq(Packet packet,
XMPPResourceConnection conn,
NonAuthUserRepository repo,
Queue<Packet> results) |
Queue<Packet> |
restorePacketForOffLineUser(XMPPResourceConnection conn,
OfflineMsgRepositoryIfc repo)
Method restores all messages from repository for the JID of the current session.
|
Authorization |
savePacketForOffLineUser(Packet pac,
OfflineMsgRepositoryIfc repo,
NonAuthUserRepository userRepo)
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. |
void |
setOfflineStorageMatchers(String[] matcherStrs) |
Element[] |
supDiscoFeatures(XMPPResourceConnection session)
Method
supDiscoFeatures returns an array of XML Element s 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, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, supStreamFeatures, supTypes, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, concurrentQueuesNo, getComponentInfo, getStatistics, init, supStreamFeatures, supTypes
compareTo
public static final String[] MESSAGE_EVENT_PATH
msgoffline
plugin it is presence stanzapublic static final String[] MESSAGE_HEADER_PATH
msgoffline
plugin it is presence stanzapublic static final String[] MESSAGE_HINTS_NO_STORE
public static final String MESSAGE_HINTS_XMLNS
public static final String[] MESSAGE_RECEIVED_PATH
public static final String MESSAGE_RECEIVED_XMLNS
public static final String[] PUBSUB_NODE_PATH
public static final String PUBSUB_NODE_KEY
protected static final String XMLNS
msgoffline
plugin it is
jabber:clientprotected static final String ID
msgoffline
plugin it is msgofflinepublic 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 void postProcess(Packet packet, XMPPResourceConnection conn, NonAuthUserRepository repo, Queue<Packet> queue, Map<String,Object> settings)
packet
for which there was no processor.
savePacketForOffLineUser
method to store packet to offline
repository.postProcess
in interface XMPPPostprocessorIfc
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.public void process(Packet packet, XMPPResourceConnection conn, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws 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 userprocess
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.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.NotAuthorizedException
public void processIq(Packet packet, XMPPResourceConnection conn, NonAuthUserRepository repo, Queue<Packet> results) throws NotAuthorizedException
NotAuthorizedException
public Queue<Packet> restorePacketForOffLineUser(XMPPResourceConnection conn, OfflineMsgRepositoryIfc repo) throws UserNotFoundException, NotAuthorizedException
Packet
objects added to LinkedList
collection and, if possible, sorted by
timestamp.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
interfaceQueue
of Packet
objects based on all stored payloads for the JID of the current
session.UserNotFoundException
NotAuthorizedException
public Authorization savePacketForOffLineUser(Packet pac, OfflineMsgRepositoryIfc repo, NonAuthUserRepository userRepo) throws UserNotFoundException
<body>
, <event>
or <header>
child element and only messages
of type normal, chat.delay
element and appropriate timestamp. pac
- a Packet
object containing packet that should be verified and savedrepo
- a MsgRepositoryIfc
repository handler responsible for storing messagestrue
if the packet was correctly saved to repository, false
otherwise.UserNotFoundException
public String[] getOfflineStorageMatchers()
public void setOfflineStorageMatchers(String[] matcherStrs)
public Element[] supDiscoFeatures(XMPPResourceConnection session)
XMPPImplIfc
supDiscoFeatures
returns an array of XML Element
s 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 XMPPImplIfc
supDiscoFeatures
in class XMPPProcessor
session
- a XMPPResourceConnection
valueElement[]
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[]
valueprotected OfflineMessages.OfflineMsgRepositoryIfc getMsgRepoImpl(NonAuthUserRepository repo, XMPPResourceConnection conn)
MsgRepositoryIfc
interface implementation.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
interfaceMsgRepositoryIfc
interface implementation.protected boolean isAllowedForOfflineStorage(Packet pac)
protected boolean isAllowedForOfflineStorageDefaults(Packet pac)
protected boolean loadOfflineMessages(Packet packet, XMPPResourceConnection conn)
packet
- a Packet
object 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.true
if the messages should be loaded, false
otherwise.protected void notifyNewOfflineMessage(Packet packet, XMPPResourceConnection conn, Queue<Packet> queue, Map<String,Object> settings)
protected void notifyOfflineMessagesRetrieved(XMPPResourceConnection conn, Queue<Packet> queue)
Copyright © 2004–2020 "Tigase, Inc.". All rights reserved.