Package tigase.xmpp.impl
Class FlexibleOfflineMessageRetrieval
java.lang.Object
tigase.xmpp.XMPPProcessor
tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
tigase.xmpp.XMPPProcessorAbstract
tigase.xmpp.impl.FlexibleOfflineMessageRetrieval
- All Implemented Interfaces:
Comparable<XMPPImplIfc>,XMPPImplIfc,XMPPProcessorConcurrencyAwareIfc,XMPPProcessorIfc
@Bean(name="http://jabber.org/protocol/offline",
parent=SessionManager.class,
active=false)
public class FlexibleOfflineMessageRetrieval
extends XMPPProcessorAbstract
implements XMPPProcessorIfc
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringField holds the xmlns of XEP-0013: Flexible offline messages retrievalprotected static final Stringstatic final Stringstatic final String[]static final String[]static final StringFields 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 TypeMethodDescriptioncanHandle(Packet packet, XMPPResourceConnection conn) By default the method usesXMPPImplIfc.supElementNamePaths()andXMPPImplIfc.supTypes()method results to determine whether the plugin would process given packet.id()Methodidreturns a unique ID of the plugin.voidprocessFromUserToServerPacket(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...).voidprocessServerSessionPacket(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.restorePacketForOffLineUser(List<String> db_ids, XMPPResourceConnection conn, MsgRepositoryIfc repo) 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.XMPPProcessorAbstract
isFromUserSession, isNullSession, isServerSession, isToUserSession, process, processFromUserOutPacket, processFromUserPacket, processNullSessionPacket, processToUserPacketMethods inherited from class tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
supStreamFeatures, supTypesMethods inherited from class tigase.xmpp.XMPPProcessor
compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, 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
concurrentQueuesNo, getComponentInfo, getStatistics, init, supStreamFeatures, supTypesMethods inherited from interface tigase.xmpp.XMPPProcessorIfc
process
-
Field Details
-
FLEXIBLE_OFFLINE_XMLNS
Field holds the xmlns of XEP-0013: Flexible offline messages retrieval- See Also:
-
ITEM_ELEMENT_NAME
- See Also:
-
NODE_ATTRIBUTE_NAME
- See Also:
-
MESSAGE_EVENT_PATH
-
MESSAGE_HEADER_PATH
-
ID
- See Also:
-
-
Constructor Details
-
FlexibleOfflineMessageRetrieval
public FlexibleOfflineMessageRetrieval()
-
-
Method Details
-
canHandle
Description copied from interface:XMPPImplIfcBy default the method usesXMPPImplIfc.supElementNamePaths()andXMPPImplIfc.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.- Specified by:
canHandlein interfaceXMPPImplIfc- Overrides:
canHandlein classXMPPProcessor- Parameters:
packet- is aPacketfor processing.conn- is a user session object or null.- Returns:
- returns
Authorizationenum value or null. Null means the plugin is simply not processing the packet.Authorization.AUTHORIZEDmeans the plugin can process the packet, any otherAuthorizationenum value means an error which has to be returned to the sender.
-
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- Overrides:
idin classAnnotatedXMPPProcessor- Returns:
- a
Stringvalue
-
processFromUserToServerPacket
public void processFromUserToServerPacket(JID connectionId, Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws PacketErrorTypeExceptionDescription copied from class:XMPPProcessorAbstractThe 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...). There is no default implementation for the method.- Specified by:
processFromUserToServerPacketin classXMPPProcessorAbstract- Parameters:
connectionId- is aJIDinstance with the session connection ID.packet- is aPacketsent by the user.session- is aXMPPResourceConnectioninstance with all the sending user session data.repo- is aNonAuthUserRepositoryinstance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.results- is a packetsQueuewith all the processing results from the plugin.settings- is aMapwith all the configuration settings passed to the plugin.- Throws:
PacketErrorTypeException- on attempt to send an error response to the error packet.
-
restorePacketForOffLineUser
public Queue<Packet> restorePacketForOffLineUser(List<String> db_ids, XMPPResourceConnection conn, MsgRepositoryIfc repo) throws UserNotFoundException, NotAuthorizedException, TigaseDBException -
processServerSessionPacket
public void processServerSessionPacket(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) throws PacketErrorTypeExceptionDescription copied from class:XMPPProcessorAbstractThe method is called when a packet addressed to the server domain is received. Please note, if a local user sends a packet to the server, the packet is handled by theprocessFromUserPacket(...)method. This method is not called for such packets.- Specified by:
processServerSessionPacketin classXMPPProcessorAbstract- Parameters:
packet- is aPacketreceived by the server and addressed to the server - the server virtual domain name.session- is aXMPPResourceConnectioninstance with all the server session data.repo- is aNonAuthUserRepositoryinstance giving access to a part of the user repository which is accessible regardless the session is authenticated or not.results- is a packetsQueuewith all the processing results from the plugin.settings- is aMapwith all the configuration settings passed to the plugin.- Throws:
PacketErrorTypeException- on attempt to send an error response to the error packet.
-
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 classAnnotatedXMPPProcessor- 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 classAnnotatedXMPPProcessor- 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 classAnnotatedXMPPProcessor- Returns:
- a
String[]value
-