@Bean(name="http://jabber.org/protocol/offline", parent=SessionManager.class, active=false) public class FlexibleOfflineMessageRetrieval extends XMPPProcessorAbstract implements XMPPProcessorIfc
Modifier and Type | Field and Description |
---|---|
static String |
FLEXIBLE_OFFLINE_XMLNS
Field holds the xmlns of XEP-0013: Flexible offline messages retrieval
|
protected static String |
ID |
static String |
ITEM_ELEMENT_NAME |
static String[] |
MESSAGE_EVENT_PATH |
static String[] |
MESSAGE_HEADER_PATH |
static String |
NODE_ATTRIBUTE_NAME |
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
FlexibleOfflineMessageRetrieval() |
Modifier and Type | Method and Description |
---|---|
Authorization |
canHandle(Packet packet,
XMPPResourceConnection conn)
By default the method uses
XMPPImplIfc.supElementNamePaths() and XMPPImplIfc.supTypes() method results to determine
whether the plugin would process given packet. |
String |
id()
Method
id returns a unique ID of the plugin. |
void |
processFromUserToServerPacket(JID connectionId,
Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
The method is called when a packet is send from the user who is owner of the session to the local server (ping,
roster management, privacy lists, etc...).
|
void |
processServerSessionPacket(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
The method is called when a packet addressed to the server domain is received.
|
Queue<Packet> |
restorePacketForOffLineUser(List<String> db_ids,
XMPPResourceConnection conn,
MsgRepositoryIfc repo) |
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. |
isFromUserSession, isNullSession, isServerSession, isToUserSession, process, processFromUserOutPacket, processFromUserPacket, processNullSessionPacket, processToUserPacket
supStreamFeatures, supTypes
compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
process
concurrentQueuesNo, getComponentInfo, getStatistics, init, supStreamFeatures, supTypes
compareTo
public static final String FLEXIBLE_OFFLINE_XMLNS
public static final String ITEM_ELEMENT_NAME
public static final String NODE_ATTRIBUTE_NAME
public static final String[] MESSAGE_EVENT_PATH
public static final String[] MESSAGE_HEADER_PATH
protected static final String ID
public Authorization canHandle(Packet packet, XMPPResourceConnection conn)
XMPPImplIfc
XMPPImplIfc.supElementNamePaths()
and XMPPImplIfc.supTypes()
method results to determine
whether the plugin would process given packet. However, a plugin can implement own logic to determine packet
processing capabilities or conditions. Please note, this method must be very fast and efficient. No I/O
processing is recommended as it may impact performance of the whole system.canHandle
in interface XMPPImplIfc
canHandle
in class XMPPProcessor
packet
- is a Packet
for processing.conn
- is a user session object or null.Authorization
enum value or null. Null means the plugin is simply not processing the
packet. Authorization.AUTHORIZED
means the plugin can process the packet, any other Authorization
enum value means an error which has to be returned to the sender.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
id
in class AnnotatedXMPPProcessor
String
valuepublic void processFromUserToServerPacket(JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
XMPPProcessorAbstract
processFromUserToServerPacket
in class XMPPProcessorAbstract
connectionId
- is a JID
instance with the session connection ID.packet
- is a Packet
sent by the user.session
- is a XMPPResourceConnection
instance with all the sending user session data.repo
- is a NonAuthUserRepository
instance giving access to a part of the user repository which
is accessible regardless the session is authenticated or not.results
- is a packets Queue
with all the processing results from the plugin.settings
- is a Map
with all the configuration settings passed to the plugin.PacketErrorTypeException
- on attempt to send an error response to the error packet.public Queue<Packet> restorePacketForOffLineUser(List<String> db_ids, XMPPResourceConnection conn, MsgRepositoryIfc repo) throws UserNotFoundException, NotAuthorizedException
public void processServerSessionPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws PacketErrorTypeException
XMPPProcessorAbstract
processFromUserPacket(...)
method. This method
is not called for such packets.processServerSessionPacket
in class XMPPProcessorAbstract
packet
- is a Packet
received by the server and addressed to the server - the server virtual
domain name.session
- is a XMPPResourceConnection
instance with all the server session data.repo
- is a NonAuthUserRepository
instance giving access to a part of the user repository which
is accessible regardless the session is authenticated or not.results
- is a packets Queue
with all the processing results from the plugin.settings
- is a Map
with all the configuration settings passed to the plugin.PacketErrorTypeException
- on attempt to send an error response to the error packet.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 AnnotatedXMPPProcessor
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 AnnotatedXMPPProcessor
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 AnnotatedXMPPProcessor
String[]
valueCopyright © 2004–2021 "Tigase, Inc.". All rights reserved.