public class PresenceState extends PresenceAbstract implements XMPPStopListenerIfc
Modifier and Type | Class and Description |
---|---|
static interface |
PresenceState.ExtendedPresenceProcessorIfc |
Modifier and Type | Field and Description |
---|---|
static String |
DIRECT_PRESENCE
DIRECT_PRESENCE is a key in temporary session data for the
collection of JIDs where direct presence was sent. |
static String |
DISABLE_ROSTER_LAZY_LOADING_KEY |
static String |
EXTENDED_PRESENCE_PROCESSORS_KEY |
protected static int |
HIGH_PRIORITY_PRESENCES_NO |
protected static String |
ID |
static String |
OFFLINE_BUD_SENT
Field description
|
static String |
OFFLINE_RES_SENT
Field description
|
static String |
OFFLINE_ROSTER_LAST_SEEN_PROP_KEY
Field description
|
static String |
PRESENCE_GLOBAL_FORWARD
key allowing setting global forwarding JID address.
|
PRESENCE_ELEMENT_NAME, PRESENCE_PROBE_FULL_JID_KEY, probeFullJID, roster_util, SKIP_OFFLINE_PROP_KEY, SKIP_OFFLINE_SYS_PROP_KEY, skipOffline, USERS_STATUS_CHANGES, XMLNS
ALL_NAMES, ALL_PATHS, cmpInfo
CLIENT_XMLNS
Constructor and Description |
---|
PresenceState() |
Modifier and Type | Method and Description |
---|---|
static void |
addDirectPresenceJID(JID jid,
XMPPResourceConnection session)
Add JID to collection of JIDs to which direct presence was sent.
|
protected static void |
broadcastDirectPresences(StanzaType t,
XMPPResourceConnection session,
Queue<Packet> results,
Element pres)
broadcastDirectPresences broadcast a direct Presence from provided
pres Element object to the collection of JIDs stored in
temporary session data under key DIRECT_PRESENCE . |
static void |
broadcastOffline(XMPPResourceConnection session,
Queue<Packet> results,
Map<String,Object> settings,
RosterAbstract roster_util)
sendPresenceBroadcast method broadcasts given presence to all
buddies from roster and to all users to which direct presence was sent. |
protected void |
buddyOnline(XMPPResourceConnection session,
JID buddy,
Queue<Packet> results,
boolean online)
Method sends back presence to contact while it becomes online (i.e.
|
void |
getStatistics(StatisticsList list)
The method allows to retrieve plugin own statistics if it generates any.
|
void |
init(Map<String,Object> settings)
Method
init is called just after the plugin has been loaded
into memory. |
void |
process(Packet packet,
XMPPResourceConnection session,
NonAuthUserRepository repo,
Queue<Packet> results,
Map<String,Object> settings)
Performs processing of presence packets and calls different methods for particular RosterAbstract.PresenceType |
protected void |
processError(Packet packet,
XMPPResourceConnection session,
Queue<Packet> results,
Map<String,Object> settings,
RosterAbstract.PresenceType presenceType)
Process presence stanza of type Error.
|
protected void |
processInInitial(Packet packet,
XMPPResourceConnection session,
Queue<Packet> results,
Map<String,Object> settings,
RosterAbstract.PresenceType presenceType)
Method is responsible for processing incoming initial presence (i.e.
|
protected void |
processInProbe(Packet packet,
XMPPResourceConnection session,
Queue<Packet> results,
Map<String,Object> settings,
RosterAbstract.PresenceType presenceType)
Method is responsible for processing incoming presence probe (i.e.
|
protected void |
processOutInitial(Packet packet,
XMPPResourceConnection session,
Queue<Packet> results,
Map<String,Object> settings,
RosterAbstract.PresenceType type)
Method is responsible for processing outgoing initial presence (i.e.
|
static void |
rebroadcastPresence(XMPPResourceConnection session,
Queue<Packet> results) |
static void |
removeDirectPresenceJID(JID jid,
XMPPResourceConnection session)
Remove JID from collection of JIDs to which direct presence was sent.
|
void |
resendPendingInRequests(XMPPResourceConnection session,
Queue<Packet> results)
Sends out all pending subscription request during user log-in.
|
static void |
sendPresenceBroadcast(StanzaType t,
XMPPResourceConnection session,
EnumSet<RosterAbstract.SubscriptionType> subscrs,
Queue<Packet> results,
Element pres,
Map<String,Object> settings,
RosterAbstract roster_util)
sendPresenceBroadcast method broadcasts given presence to all
buddies from roster and to all users to which direct presence was sent. |
protected void |
sendRosterOfflinePresence(XMPPResourceConnection session,
Queue<Packet> results)
Method sends server generated presence unavailable for all buddies from the
roster with a custom status message.
|
void |
stopped(XMPPResourceConnection session,
Queue<Packet> results,
Map<String,Object> settings)
Performs additional processing upon closing user session (user either
disconnects or logs-out).
|
Set<StanzaType> |
supTypes()
Method returns an array of all stanza types which the plugin is able
to handle.
|
protected static void |
updateOfflineChange(XMPPResourceConnection session,
Queue<Packet> results)
updateOfflineChange method broadcast off-line presence to all
other user active resources. |
broadcastProbe, concurrentQueuesNo, forwardPresence, getRosterUtil, initSettings, prepareProbe, requiresPresenceSending, sendPresence, sendPresence, updatePresenceChange, updateUserResources
id, supDiscoFeatures, supElementNamePaths, supNamespaces, supStreamFeatures
canHandle, compareTo, concurrentThreadsPerQueue, getComponentInfo, getInstance, isSupporting, supElements, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
canHandle, concurrentQueuesNo, concurrentThreadsPerQueue, getComponentInfo, id, isSupporting, supDiscoFeatures, supElementNamePaths, supElements, supNamespaces, supStreamFeatures
compareTo
public static final String DIRECT_PRESENCE
DIRECT_PRESENCE
is a key in temporary session data for the
collection of JIDs where direct presence was sent. To all these addresses
unavailable presence must be sent when user disconnects.public static final String DISABLE_ROSTER_LAZY_LOADING_KEY
public static final String EXTENDED_PRESENCE_PROCESSORS_KEY
public static final String OFFLINE_BUD_SENT
public static final String OFFLINE_RES_SENT
public static final String OFFLINE_ROSTER_LAST_SEEN_PROP_KEY
public static final String PRESENCE_GLOBAL_FORWARD
protected static final String ID
protected static int HIGH_PRIORITY_PRESENCES_NO
public 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 Set<StanzaType> supTypes()
XMPPImplIfc
supTypes
in interface XMPPImplIfc
supTypes
in class AnnotatedXMPPProcessor
StanzaType[]
array of supported stanza types.public void process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) throws XMPPException
RosterAbstract.PresenceType
process
in interface XMPPProcessorIfc
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.XMPPException
public void stopped(XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings)
XMPPStopListenerIfc
stopped
in interface XMPPStopListenerIfc
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.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.public void getStatistics(StatisticsList list)
XMPPImplIfc
getStatistics
in interface XMPPImplIfc
getStatistics
in class XMPPProcessor
list
- is a statistics collection to which plugins own metrics can be added.public static void broadcastOffline(XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract roster_util) throws NotAuthorizedException, TigaseDBException
sendPresenceBroadcast
method broadcasts given presence to all
buddies from roster and to all users to which direct presence was sent.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.roster_util
- instance of class implementing RosterAbstract
.NotAuthorizedException
- if an error occursTigaseDBException
public static void addDirectPresenceJID(JID jid, XMPPResourceConnection session)
jid
- to which direct presence was sent.session
- user session which keeps all the user session data and also
gives an access to the user's repository data.public static void removeDirectPresenceJID(JID jid, XMPPResourceConnection session)
jid
- to which direct presence was sent.session
- user session which keeps all the user session data and also
gives an access to the user's repository data.protected static void broadcastDirectPresences(StanzaType t, XMPPResourceConnection session, Queue<Packet> results, Element pres) throws NotAuthorizedException, TigaseDBException
broadcastDirectPresences
broadcast a direct Presence from provided
pres
Element
object to the collection of JIDs stored in
temporary session data under key DIRECT_PRESENCE
.t
- specifies type of the presence to be send.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.pres
- an Object of type Element
holding Presence stanza to
be sent.NotAuthorizedException
TigaseDBException
public static void rebroadcastPresence(XMPPResourceConnection session, Queue<Packet> results) throws NotAuthorizedException, TigaseDBException
protected void processError(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType presenceType) throws NotAuthorizedException, TigaseDBException, NoConnectionIdException
packet
- packet is which being processed.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.presenceType
- specifies type of the presenceNoConnectionIdException
NotAuthorizedException
TigaseDBException
protected void processInInitial(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType presenceType) throws NoConnectionIdException, NotAuthorizedException, TigaseDBException
It validates the packet (whether from is present or if it's a direct presence to existing resource) and subsequently set received presence for the contact that sent it.
packet
- packet is which being processed.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.presenceType
- specifies type of the presence.NoConnectionIdException
NotAuthorizedException
TigaseDBException
protected void processInProbe(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType presenceType) throws NotAuthorizedException, TigaseDBException, PacketErrorTypeException
It validates whether the packet comes from a contact that has correct subscription and responds with presence of all user's resources presences.
packet
- packet is which being processed.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.presenceType
- specifies type of the presence.NotAuthorizedException
PacketErrorTypeException
TigaseDBException
protected void processOutInitial(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType type) throws NotAuthorizedException, TigaseDBException
Process packet accordingly whether it's a direct presence (forward it, add to proper collection of JIDs to which a direct presence has been sent) or regular presence. THe latter causes properly address the packet, store presence within session data for subsequent use, and for the first availability presence (in case there is no prior presence stored in user session data) server sends probes to all contacts and pushes out all pending subscription request or (if there i already presence stored in session data) broadcast presence update to contacts.
If there is a JID forwarding set up, presence is also forwarded to configured JID.
packet
- packet is which being processed.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.type
- specifies type of the presence.NotAuthorizedException
TigaseDBException
protected void buddyOnline(XMPPResourceConnection session, JID buddy, Queue<Packet> results, boolean online) throws NotAuthorizedException, TigaseDBException
session
- user session which keeps all the user session data and also
gives an access to the user's repository data.buddy
- JID
of a roster element for which an online state
will be setresults
- this a collection with packets which have been generated as
input packet processing results.online
- set whether given contact is online or offlineNotAuthorizedException
TigaseDBException
public static void sendPresenceBroadcast(StanzaType t, XMPPResourceConnection session, EnumSet<RosterAbstract.SubscriptionType> subscrs, Queue<Packet> results, Element pres, Map<String,Object> settings, RosterAbstract roster_util) throws NotAuthorizedException, TigaseDBException
sendPresenceBroadcast
method broadcasts given presence to all
buddies from roster and to all users to which direct presence was sent.
Before sending presence method calls requiresPresenceSending()
performing, if configured, both system and roster check to verify whether
presence needs to be sent.t
- specifies type of the presence to be send.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.subscrs
- an EnumSet<SubscriptionType>
holding all
RosterAbstract.SubscriptionType
to which a Presence should be
broadcast.pres
- an Object of type Element
holding Presence
stanza to be sent.settings
- this map keeps plugin specific settings loaded from the
Tigase server configuration.roster_util
- instance of class implementing RosterAbstract
.NotAuthorizedException
- if an error occursTigaseDBException
protected void sendRosterOfflinePresence(XMPPResourceConnection session, Queue<Packet> results) throws NotAuthorizedException, TigaseDBException, NoConnectionIdException
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.TigaseDBException
NotAuthorizedException
NoConnectionIdException
protected static void updateOfflineChange(XMPPResourceConnection session, Queue<Packet> results) throws NotAuthorizedException
updateOfflineChange
method broadcast off-line presence to all
other user active resources.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.NotAuthorizedException
- if an error occurspublic void resendPendingInRequests(XMPPResourceConnection session, Queue<Packet> results) throws NotAuthorizedException, TigaseDBException
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.NotAuthorizedException
TigaseDBException
Copyright © 2019 "Tigase, Inc.". All rights reserved.