Package tigase.xmpp.impl
Class MobileV2
java.lang.Object
tigase.xmpp.XMPPProcessor
tigase.xmpp.impl.MobileV2
- All Implemented Interfaces:
Comparable<XMPPImplIfc>
,ClientStateIndication.Logic
,XMPPImplIfc
,XMPPPacketFilterIfc
,XMPPProcessorConcurrencyAwareIfc
,XMPPProcessorIfc
@Bean(name="mobile_v2",
parent=SessionManager.class,
active=false)
public class MobileV2
extends XMPPProcessor
implements XMPPProcessorIfc, XMPPPacketFilterIfc, ClientStateIndication.Logic
Class responsible for queuing packets (usable in connections from mobile clients - power usage optimization) version
2
- Author:
- andrzej
-
Field Summary
Fields inherited from class tigase.xmpp.XMPPProcessor
ALL_NAMES, ALL_PATHS, cmpInfo
Fields inherited from interface tigase.xmpp.XMPPImplIfc
CLIENT_XMLNS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
activate
(XMPPResourceConnection session, Queue<Packet> results) void
deactivate
(XMPPResourceConnection session, Queue<Packet> results) void
filter
(Packet _packet, XMPPResourceConnection sessionFromSM, NonAuthUserRepository repo, Queue<Packet> results) protected void
flushQueue
(XMPPResourceConnection session, Queue<Packet> results) id()
Methodid
returns a unique ID of the plugin.protected boolean
isQueueEnabled
(XMPPResourceConnection session) Check if queuing is enabledvoid
process
(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) protected boolean
shouldBeQueued
(XMPPResourceConnection session, Packet currentlyFilteredResultPacket, Map<JID, Packet> queue) String[][]
MethodsupElementNamePaths
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[]
MethodsupNamespaces
returns an array of name-spaces for stanzas which can be processed by this plugin.Element[]
supStreamFeatures
(XMPPResourceConnection session) MethodsupStreamFeatures
returns an array of XMLElement
s with stream features which have to be returned to the client uppon request.Methods inherited from class tigase.xmpp.XMPPProcessor
canHandle, compareTo, concurrentQueuesNo, getComponentInfo, getInstance, getQueueSize, getStatistics, getThreadsNo, init, supDiscoFeatures, supTypes, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface tigase.xmpp.XMPPImplIfc
canHandle, concurrentQueuesNo, getComponentInfo, getStatistics, init, supDiscoFeatures, supTypes
-
Field Details
-
ID
- See Also:
-
-
Constructor Details
-
MobileV2
public MobileV2()
-
-
Method Details
-
id
Description copied from interface:XMPPImplIfc
Methodid
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.- Specified by:
id
in interfaceXMPPImplIfc
- Returns:
- a
String
value
-
process
public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String, Object> settings) - Specified by:
process
in interfaceXMPPProcessorIfc
- Parameters:
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.session
- 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.
-
supElementNamePaths
Description copied from interface:XMPPImplIfc
MethodsupElementNamePaths
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 bysupNamespaces()
method. The element path itself is represented by a String array with each path element as a separate String.- Specified by:
supElementNamePaths
in interfaceXMPPImplIfc
- Overrides:
supElementNamePaths
in classXMPPProcessor
- 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:XMPPImplIfc
MethodsupNamespaces
returns 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:
supNamespaces
in interfaceXMPPImplIfc
- Overrides:
supNamespaces
in classXMPPProcessor
- Returns:
- a
String[]
value
-
supStreamFeatures
Description copied from interface:XMPPImplIfc
MethodsupStreamFeatures
returns an array of XMLElement
s with stream features which have to be returned to the client uppon request. Stream features returned by this method correspond to features supported by this plugin.- Specified by:
supStreamFeatures
in interfaceXMPPImplIfc
- Overrides:
supStreamFeatures
in classXMPPProcessor
- Parameters:
session
- aXMPPResourceConnection
value- Returns:
- an
Element[]
value
-
activate
- Specified by:
activate
in interfaceClientStateIndication.Logic
-
deactivate
- Specified by:
deactivate
in interfaceClientStateIndication.Logic
-
filter
public void filter(Packet _packet, XMPPResourceConnection sessionFromSM, NonAuthUserRepository repo, Queue<Packet> results) - Specified by:
filter
in interfaceXMPPPacketFilterIfc
-
shouldBeQueued
protected boolean shouldBeQueued(XMPPResourceConnection session, Packet currentlyFilteredResultPacket, Map<JID, Packet> queue) -
flushQueue
-
isQueueEnabled
Check if queuing is enabled
-