Package tigase.xmpp.impl
Class PresenceAbstract
java.lang.Object
tigase.xmpp.XMPPProcessor
tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
tigase.xmpp.impl.PresenceAbstract
- All Implemented Interfaces:
Comparable<XMPPImplIfc>,XMPPImplIfc,XMPPProcessorConcurrencyAwareIfc,XMPPProcessorIfc
- Direct Known Subclasses:
PresenceOffline,PresenceState,PresenceSubscription
Class responsible for handling Presence packets
- Author:
- Artur Hefczyc
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringprotected static booleanprotected RosterAbstractstatic final Stringstatic final Stringprotected static booleanstatic final Stringprotected 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 TypeMethodDescriptionvoidbroadcastProbe(XMPPResourceConnection session, Queue<Packet> results, Map<String, Object> settings) sendPresenceBroadcastmethod broadcasts given presence to all buddies from roster and to all users to which direct presence was sent.intMethods returns a preferable number of threads/packets queues for the plugin.protected booleanprotected static voidforwardPresence(Queue<Packet> results, Packet packet, JID from) Simply forwards packet to the destinationbooleanprotected static RosterAbstractReturns shared instance of class implementingRosterAbstract- either default one (RosterFlat) or the one configured with "roster-implementation" property.booleanbooleanprotected static ElementprepareProbe(XMPPResourceConnection session) protected static booleanrequiresPresenceSending(RosterAbstract roster, JID buddy, XMPPResourceConnection session, boolean systemCheck) Method checks whether a given contact requires sending presence.static voidsendPresence(StanzaType t, BareJID from, BareJID to, Queue<Packet> results, Element pres) Sends Presence stanza from provided parameters without returning created resultPacketobject.static PacketsendPresence(StanzaType t, JID from, JID to, Queue<Packet> results, Element pres) Sends Presence stanza from provided parameters as well as returns created resultPacketobject.voidsetProbeFullJID(boolean probeFullJID) voidsetSkipOffline(boolean skipOffline) voidsetSkipOfflineSys(boolean skipOfflineSys) static voidupdatePresenceChange(Packet presence, XMPPResourceConnection session, Queue<Packet> results) updatePresenceChangemethod is used to broadcast to all active resources presence stanza received from other users, like incoming availability presence, subscription presence and so on...static voidupdateUserResources(Element presence, XMPPResourceConnection session, Queue<Packet> results, boolean initial) updateUserResourcesmethod is used to broadcast to all other resources presence stanza from one user resource.Methods inherited from class tigase.xmpp.impl.annotation.AnnotatedXMPPProcessor
id, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures, supTypesMethods inherited from class tigase.xmpp.XMPPProcessor
canHandle, compareTo, 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
canHandle, getComponentInfo, getStatistics, id, init, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures, supTypesMethods inherited from interface tigase.xmpp.XMPPProcessorIfc
process
-
Field Details
-
PRESENCE_ELEMENT_NAME
- See Also:
-
SKIP_OFFLINE_PROP_KEY
- See Also:
-
PRESENCE_PROBE_FULL_JID_KEY
- See Also:
-
SKIP_OFFLINE_SYS_PROP_KEY
- See Also:
-
USERS_STATUS_CHANGES
- See Also:
-
XMLNS
- See Also:
-
probeFullJID
-
skipOffline
-
roster_util
-
-
Constructor Details
-
PresenceAbstract
public PresenceAbstract()
-
-
Method Details
-
forwardPresence
Simply forwards packet to the destination- Parameters:
results- this a collection with packets which have been generated as input packet processing results.packet- to forwardfrom- is aJIDinstance with stanza source address.
-
getRosterUtil
Returns shared instance of class implementingRosterAbstract- either default one (RosterFlat) or the one configured with "roster-implementation" property.- Returns:
- shared instance of class implementing
RosterAbstract
-
prepareProbe
- Throws:
NotAuthorizedException
-
requiresPresenceSending
protected static boolean requiresPresenceSending(RosterAbstract roster, JID buddy, XMPPResourceConnection session, boolean systemCheck) throws NotAuthorizedException, TigaseDBException Method checks whether a given contact requires sending presence. In case of enabling optionskipOfflineand user being offline in the roster the presence is not sent. Alternatively enabling optionskipOfflineSyswould cause local environment check for user status and omit sending presence if the local use is offline.- Parameters:
roster- instance of class implementingRosterAbstract.buddy- JID of a contact for which a check is to be performed.session- user session which keeps all the user session data and also gives an access to the user's repository data.systemCheck- indicates whether the check should be only based on local environment state (true) or rooster state of given user should also be taken into consideration (false).- Returns:
- {code true} if the contact requires sending presence (e.g. is not online and options skipOffline or skipOfflineSys are enabled)
- Throws:
NotAuthorizedExceptionTigaseDBException
-
sendPresence
public static Packet sendPresence(StanzaType t, JID from, JID to, Queue<Packet> results, Element pres) Sends Presence stanza from provided parameters as well as returns created resultPacketobject. In case of missingpresparameter a Presence stanza will be created with providedStanzaTypetypet,JIDtypefromandJIDtypeto. Otherwise Presence stanzapreswill be cloned andtoattribute will be set from parameterto.- Parameters:
t- specifies type of the presence to be send.from- is aJIDinstance with stanza source address.to- is aJIDinstance with stanza destination address.results- this a collection with packets which have been generated as input packet processing results.pres- an Object of typeElementholding Presence stanza to be sent.- Returns:
- an instance ofÂ
Packetholding Presence stanza created from provided parameters.
-
sendPresence
public static void sendPresence(StanzaType t, BareJID from, BareJID to, Queue<Packet> results, Element pres) Sends Presence stanza from provided parameters without returning created resultPacketobject. In case of missingpresparameter a Presence stanza will be created with providedStanzaTypetypet,JIDtypefromandJIDtypeto. Otherwise Presence stanzapreswill be cloned andtoattribute will be set from parameterto.- Parameters:
t- specifies type of the presence to be send.from- is aJIDinstance with stanza source address.to- is aJIDinstance with stanza destination address.results- this a collection with packets which have been generated as input packet processing results.pres- an Object of typeElementholding Presence stanza to be sent.
-
updatePresenceChange
public static void updatePresenceChange(Packet presence, XMPPResourceConnection session, Queue<Packet> results) throws NotAuthorizedException updatePresenceChangemethod is used to broadcast to all active resources presence stanza received from other users, like incoming availability presence, subscription presence and so on... Initial presences are however sent only to those resources which already have sent initial presence.- Parameters:
presence- anElementpresence received from other users, we have to change 'to' attribute to full resource JID.session- user session which keeps all the user session data and also gives an access to the user's repository data.results- this a collection with packets which have been generated as input packet processing results.- Throws:
NotAuthorizedException- if an error occurs
-
updateUserResources
public static void updateUserResources(Element presence, XMPPResourceConnection session, Queue<Packet> results, boolean initial) throws NotAuthorizedException updateUserResourcesmethod is used to broadcast to all other resources presence stanza from one user resource. So if new resource connects this method updates presence information about new resource to old resources and about old resources to new resource.- Parameters:
presence- anElementpresence received from other users, we have to change 'to' attribute to full resource JID.session- user session which keeps all the user session data and also gives an access to the user's repository data.results- this a collection with packets which have been generated as input packet processing results.initial- specifies whether this is an initial presence or not (i.e. if there is a presence data from the presence stored within user session object or not)- Throws:
NotAuthorizedException- if an error occurs
-
isSkipOfflineSys
public boolean isSkipOfflineSys() -
setSkipOfflineSys
public void setSkipOfflineSys(boolean skipOfflineSys) -
isSkipOffline
public boolean isSkipOffline() -
setSkipOffline
public void setSkipOffline(boolean skipOffline) -
getProbeFullJID
public boolean getProbeFullJID() -
setProbeFullJID
public void setProbeFullJID(boolean probeFullJID) -
forceSendingProbe
protected boolean forceSendingProbe() -
broadcastProbe
public void broadcastProbe(XMPPResourceConnection session, Queue<Packet> results, Map<String, Object> settings) throws NotAuthorizedException, TigaseDBExceptionsendPresenceBroadcastmethod broadcasts given presence to all buddies from roster and to all users to which direct presence was sent. Before sending presence method callsrequiresPresenceSending(), configured to only check local environment status (if enabled) to verify whether presence needs to be sent.- Parameters:
session- user session which keeps all the user session data and also gives an access to the user's repository data.results- this a collection with packets which have been generated as input packet processing results.settings- this map keeps plugin specific settings loaded from the Tigase server configuration.- Throws:
NotAuthorizedException- if an error occursTigaseDBException
-
concurrentQueuesNo
public int concurrentQueuesNo()Description copied from interface:XMPPImplIfcMethods returns a preferable number of threads/packets queues for the plugin. This number can be overwritten through configuration settings, however, a default value should be reasonably good for most standard installations. It is recommended to assign at least as much as twice a number of CPUs cores for I/O bound processing and number a number equal to CPUs cores for fast processing not slowed down by any I/O.- Specified by:
concurrentQueuesNoin interfaceXMPPImplIfc- Overrides:
concurrentQueuesNoin classXMPPProcessor- Returns:
- an integer preferred number of processing threads for the plugin.
-