public class OfflineMessages extends XMPPProcessor implements XMPPPostprocessorIfc, XMPPProcessorIfc
<presence>
.
Created: Mon Oct 16 13:28:53 2006Modifier and Type | Class and Description |
---|---|
static interface |
OfflineMessages.OfflineMsgRepositoryIfc |
Modifier and Type | Field and Description |
---|---|
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.
|
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 |
---|---|
int |
concurrentQueuesNo()
Methods returns a preferable number of threads/packets queues for the plugin.
|
protected MsgRepositoryIfc |
getMsgRepoImpl(NonAuthUserRepository repo,
XMPPResourceConnection conn)
Method allows obtaining instance of
MsgRepositoryIfc interface
implementation. |
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. |
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.
|
void |
postProcess(Packet packet,
XMPPResourceConnection conn,
NonAuthUserRepository repo,
Queue<Packet> queue,
Map<String,Object> settings)
OfflineMessages postprocessor simply calls
savePacketForOffLineUser
method to store packet to offline repository. |
void |
process(Packet packet,
XMPPResourceConnection conn,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
OfflineMessages processor is triggered by <presence>
stanza. |
Queue<Packet> |
restorePacketForOffLineUser(XMPPResourceConnection conn,
MsgRepositoryIfc repo)
Method restores all messages from repository for the JID of the current
session.
|
boolean |
savePacketForOffLineUser(Packet pac,
MsgRepositoryIfc repo)
Method stores messages to offline repository with the following rules
applied, i.e.
|
tigase.xml.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, concurrentThreadsPerQueue, getComponentInfo, getInstance, getStatistics, isSupporting, supElements, supStreamFeatures, supTypes, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, concurrentThreadsPerQueue, getComponentInfo, getStatistics, isSupporting, supElements, supStreamFeatures, supTypes
compareTo
protected static final String XMLNS
msgoffline
plugin it is jabber:clientpublic static final String[] MESSAGE_EVENT_PATH
msgoffline
plugin it is
presence stanzapublic static final String[] MESSAGE_HEADER_PATH
msgoffline
plugin it is
presence stanzapublic int concurrentQueuesNo()
XMPPImplIfc
concurrentQueuesNo
in interface XMPPImplIfc
concurrentQueuesNo
in class XMPPProcessor
public 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 init(Map<String,Object> settings) throws TigaseDBException
XMPPImplIfc
init
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 XMPPImplIfc
init
in class XMPPProcessor
settings
- is a Map with initial processor settings from the configuration
file.TigaseDBException
public void postProcess(Packet packet, XMPPResourceConnection conn, NonAuthUserRepository repo, Queue<Packet> queue, Map<String,Object> settings)
savePacketForOffLineUser
method to store packet to offline repository.
Performs processing of
packet
for which there was no processor.
postProcess
in interface XMPPPostprocessorIfc
conn
- queue
- 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.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.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 user
process
in interface XMPPProcessorIfc
conn
- 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.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 Queue<Packet> restorePacketForOffLineUser(XMPPResourceConnection conn, MsgRepositoryIfc 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 boolean savePacketForOffLineUser(Packet pac, MsgRepositoryIfc repo) throws UserNotFoundException
<body>
, <event>
or
<header>
child element and only messages of type normal, chat.
Processed messages are stamped with the 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 tigase.xml.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 MsgRepositoryIfc 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 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.Copyright © 2014 "Tigase, Inc.". All rights reserved.