tigase.xmpp.impl
Class Presence

java.lang.Object
  tigase.xmpp.XMPPProcessor
      tigase.xmpp.impl.Presence

All Implemented Interfaces:

Comparable<XMPPImplIfc>, XMPPImplIfc, XMPPProcessorIfc, XMPPStopListenerIfc

public class Presence
extends XMPPProcessor
implements XMPPProcessorIfc, XMPPStopListenerIfc

Describe class Presence here. Created: Wed Feb 22 07:30:03 2006

Version:

$Rev: 2996 $

Author:

Artur Hefczyc

Field Summary

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	OFFLINE_BUD_SENT Field description
static String	OFFLINE_RES_SENT Field description
static String	OFFLINE_ROSTER_LAST_SEEN_PROP_KEY
static String	PRESENCE_ELEMENT_NAME Field description
static String	PRESENCE_GLOBAL_FORWARD
protected RosterAbstract	roster_util
static String	SKIP_OFFLINE_PROP_KEY Field description
static String	USERS_STATUS_CHANGES
protected static String	XMLNS

Fields inherited from class tigase.xmpp.XMPPProcessor

ALL

Fields inherited from interface tigase.xmpp.XMPPImplIfc

CLIENT_XMLNS

Constructor Summary

Presence()

Method Summary

static void	addDirectPresenceJID(tigase.xmpp.JID jid, XMPPResourceConnection session) Method description
protected static void	broadcastDirectPresences(StanzaType t, XMPPResourceConnection session, Queue<Packet> results, tigase.xml.Element pres)
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.
void	broadcastProbe(XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings) sendPresenceBroadcast method broadcasts given presence to all budies from roster and to all users to which direct presence was sent.
protected void	buddyOnline(XMPPResourceConnection session, tigase.xmpp.JID buddy, Queue<Packet> results)
int	concurrentQueuesNo() Method description
protected static void	forwardPresence(Queue<Packet> results, Packet packet, tigase.xmpp.JID from)
protected RosterAbstract	getRosterUtil()
void	getStatistics(StatisticsList list) The method allows to retrieve plugin own statistics if it generates any.
String	id() Method description
void	init(Map<String,Object> settings) Method description
void	process(Packet packet, XMPPResourceConnection session, NonAuthUserRepository repo, Queue<Packet> results, Map<String,Object> settings) Method description
protected void	processError(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType presenceType)
protected void	processInInitial(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType presenceType)
protected void	processInProbe(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType presenceType)
protected void	processInSubscribe(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType pres_type)
protected void	processInSubscribed(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType pres_type)
protected void	processInUnsubscribe(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType pres_type)
protected void	processInUnsubscribed(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType pres_type)
protected void	processOutInitial(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType type)
protected void	processOutSubscribe(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType pres_type)
protected void	processOutSubscribed(Packet packet, XMPPResourceConnection session, Queue<Packet> results, Map<String,Object> settings, RosterAbstract.PresenceType pres_type)
static void	removeDirectPresenceJID(tigase.xmpp.JID jid, XMPPResourceConnection session) Method description
void	resendPendingInRequests(XMPPResourceConnection session, Queue<Packet> results) Method description
static void	sendPresence(StanzaType t, tigase.xmpp.BareJID from, tigase.xmpp.BareJID to, Queue<Packet> results, tigase.xml.Element pres)
static Packet	sendPresence(StanzaType t, tigase.xmpp.JID from, tigase.xmpp.JID to, Queue<Packet> results, tigase.xml.Element pres) Method description
static void	sendPresenceBroadcast(StanzaType t, XMPPResourceConnection session, EnumSet<RosterAbstract.SubscriptionType> subscrs, Queue<Packet> results, tigase.xml.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) stopped method is called when user disconnects or logs-out.
String[]	supElements() Method description
String[]	supNamespaces() Method description
protected static void	updateOfflineChange(XMPPResourceConnection session, Queue<Packet> results) updateOfflineChange method broadcast off-line presence to all other user active resources.
static void	updatePresenceChange(Packet presence, XMPPResourceConnection session, Queue<Packet> results) updatePresenceChange method is used to broadcast to all active resources presence stanza received from other users, like incoming availability presence, subscription presence and so on...
static void	updateUserResources(tigase.xml.Element presence, XMPPResourceConnection session, Queue<Packet> results, boolean initial) updateUserResources method is used to broadcast to all other resources presence stanza from one user resource.

Methods inherited from class tigase.xmpp.XMPPProcessor

compareTo, concurrentThreadsPerQueue, getInstance, isSupporting, supDiscoFeatures, supStreamFeatures

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface tigase.xmpp.XMPPImplIfc

concurrentThreadsPerQueue, isSupporting, supDiscoFeatures, supStreamFeatures

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

DIRECT_PRESENCE

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.

See Also:

Constant Field Values

PRESENCE_ELEMENT_NAME

public static final String PRESENCE_ELEMENT_NAME

Field description

See Also:

Constant Field Values

SKIP_OFFLINE_PROP_KEY

public static final String SKIP_OFFLINE_PROP_KEY

Field description

See Also:

Constant Field Values

OFFLINE_ROSTER_LAST_SEEN_PROP_KEY

public static final String OFFLINE_ROSTER_LAST_SEEN_PROP_KEY

See Also:

Constant Field Values

PRESENCE_GLOBAL_FORWARD

public static final String PRESENCE_GLOBAL_FORWARD

See Also:

Constant Field Values

XMLNS

protected static final String XMLNS

See Also:

Constant Field Values

USERS_STATUS_CHANGES

public static final String USERS_STATUS_CHANGES

See Also:

Constant Field Values

OFFLINE_RES_SENT

public static final String OFFLINE_RES_SENT

Field description

See Also:

Constant Field Values

OFFLINE_BUD_SENT

public static final String OFFLINE_BUD_SENT

Field description

See Also:

Constant Field Values

roster_util

protected RosterAbstract roster_util

Constructor Detail

Presence

public Presence()

Method Detail

addDirectPresenceJID

public static void addDirectPresenceJID(tigase.xmpp.JID jid,
                                        XMPPResourceConnection session)

Method description

Parameters:

jid -

session -

broadcastOffline

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.

Parameters:

session - a XMPPResourceConnection value

results -

settings -

roster_util -

Throws:

NotAuthorizedException - if an error occurs

TigaseDBException

removeDirectPresenceJID

public static void removeDirectPresenceJID(tigase.xmpp.JID jid,
                                           XMPPResourceConnection session)

Method description

Parameters:

jid -

session -

sendPresence

public static void sendPresence(StanzaType t,
                                tigase.xmpp.BareJID from,
                                tigase.xmpp.BareJID to,
                                Queue<Packet> results,
                                tigase.xml.Element pres)

sendPresence

public static Packet sendPresence(StanzaType t,
                                  tigase.xmpp.JID from,
                                  tigase.xmpp.JID to,
                                  Queue<Packet> results,
                                  tigase.xml.Element pres)

Method description

Parameters:

t -

from -

to -

results -

pres -

sendPresenceBroadcast

public static void sendPresenceBroadcast(StanzaType t,
                                         XMPPResourceConnection session,
                                         EnumSet<RosterAbstract.SubscriptionType> subscrs,
                                         Queue<Packet> results,
                                         tigase.xml.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.

Parameters:

t - a StanzaType value

session - a XMPPResourceConnection value

subscrs -

results -

pres - an Element value

settings -

roster_util -

Throws:

NotAuthorizedException - if an error occurs

TigaseDBException

updatePresenceChange

public static void updatePresenceChange(Packet presence,
                                        XMPPResourceConnection session,
                                        Queue<Packet> results)
                                 throws NotAuthorizedException

updatePresenceChange method 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 - an Element presence received from other users, we have to change 'to' attribute to full resource JID.

session - a XMPPResourceConnection value keeping connection session object.

results -

Throws:

NotAuthorizedException - if an error occurs

getStatistics

public void getStatistics(StatisticsList list)

Description copied from interface: XMPPImplIfc

The method allows to retrieve plugin own statistics if it generates any.

Specified by:

getStatistics in interface XMPPImplIfc

Overrides:

getStatistics in class XMPPProcessor

Parameters:

list - is a statistics collection to which plugins own metrics can be added.

updateUserResources

public static void updateUserResources(tigase.xml.Element presence,
                                       XMPPResourceConnection session,
                                       Queue<Packet> results,
                                       boolean initial)
                                throws NotAuthorizedException

updateUserResources method 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 - an Element presence received from other users, we have to change 'to' attribute to full resource JID.

session - a XMPPResourceConnection value keeping connection session object.

results -

Throws:

NotAuthorizedException - if an error occurs

broadcastDirectPresences

protected static void broadcastDirectPresences(StanzaType t,
                                               XMPPResourceConnection session,
                                               Queue<Packet> results,
                                               tigase.xml.Element pres)
                                        throws NotAuthorizedException,
                                               TigaseDBException

Throws:

NotAuthorizedException

TigaseDBException

forwardPresence

protected static void forwardPresence(Queue<Packet> results,
                                      Packet packet,
                                      tigase.xmpp.JID from)

updateOfflineChange

protected static void updateOfflineChange(XMPPResourceConnection session,
                                          Queue<Packet> results)
                                   throws NotAuthorizedException

updateOfflineChange method broadcast off-line presence to all other user active resources.

Parameters:

session - a XMPPResourceConnection value

results -

Throws:

NotAuthorizedException - if an error occurs

broadcastProbe

public void broadcastProbe(XMPPResourceConnection session,
                           Queue<Packet> results,
                           Map<String,Object> settings)
                    throws NotAuthorizedException,
                           TigaseDBException

sendPresenceBroadcast method broadcasts given presence to all budies from roster and to all users to which direct presence was sent.

Parameters:

session - a XMPPResourceConnection value

results -

settings -

Throws:

NotAuthorizedException - if an error occurs

TigaseDBException

concurrentQueuesNo

public int concurrentQueuesNo()

Method description

Specified by:

concurrentQueuesNo in interface XMPPImplIfc

Overrides:

concurrentQueuesNo in class XMPPProcessor

Returns:

id

public String id()

Method description

Specified by:

id in interface XMPPImplIfc

Returns:

init

public void init(Map<String,Object> settings)
          throws TigaseDBException

Method description

Specified by:

init in interface XMPPImplIfc

Overrides:

init in class XMPPProcessor

Parameters:

settings -

Throws:

TigaseDBException

process

public void process(Packet packet,
                    XMPPResourceConnection session,
                    NonAuthUserRepository repo,
                    Queue<Packet> results,
                    Map<String,Object> settings)
             throws XMPPException

Method description

Specified by:

process in interface XMPPProcessorIfc

Parameters:

packet -

session -

repo -

results -

settings -

Throws:

XMPPException

resendPendingInRequests

public void resendPendingInRequests(XMPPResourceConnection session,
                                    Queue<Packet> results)
                             throws NotAuthorizedException,
                                    TigaseDBException

Method description

Parameters:

session -

results -

Throws:

NotAuthorizedException

TigaseDBException

stopped

public void stopped(XMPPResourceConnection session,
                    Queue<Packet> results,
                    Map<String,Object> settings)

stopped method is called when user disconnects or logs-out.

Specified by:

stopped in interface XMPPStopListenerIfc

Parameters:

session - a XMPPResourceConnection value

results -

settings -

supElements

public String[] supElements()

Method description

Specified by:

supElements in interface XMPPImplIfc

Overrides:

supElements in class XMPPProcessor

Returns:

supNamespaces

public String[] supNamespaces()

Method description

Specified by:

supNamespaces in interface XMPPImplIfc

Overrides:

supNamespaces in class XMPPProcessor

Returns:

getRosterUtil

protected RosterAbstract getRosterUtil()

processError

protected void processError(Packet packet,
                            XMPPResourceConnection session,
                            Queue<Packet> results,
                            Map<String,Object> settings,
                            RosterAbstract.PresenceType presenceType)
                     throws NotAuthorizedException,
                            TigaseDBException,
                            NoConnectionIdException

Throws:

NotAuthorizedException

TigaseDBException

NoConnectionIdException

processInInitial

protected void processInInitial(Packet packet,
                                XMPPResourceConnection session,
                                Queue<Packet> results,
                                Map<String,Object> settings,
                                RosterAbstract.PresenceType presenceType)
                         throws NoConnectionIdException,
                                NotAuthorizedException,
                                TigaseDBException

Throws:

NoConnectionIdException

NotAuthorizedException

TigaseDBException

processInProbe

protected void processInProbe(Packet packet,
                              XMPPResourceConnection session,
                              Queue<Packet> results,
                              Map<String,Object> settings,
                              RosterAbstract.PresenceType presenceType)
                       throws NotAuthorizedException,
                              TigaseDBException,
                              PacketErrorTypeException

Throws:

NotAuthorizedException

TigaseDBException

PacketErrorTypeException

processInSubscribe

protected void processInSubscribe(Packet packet,
                                  XMPPResourceConnection session,
                                  Queue<Packet> results,
                                  Map<String,Object> settings,
                                  RosterAbstract.PresenceType pres_type)
                           throws NotAuthorizedException,
                                  TigaseDBException,
                                  NoConnectionIdException

Throws:

NotAuthorizedException

TigaseDBException

NoConnectionIdException

processInSubscribed

protected void processInSubscribed(Packet packet,
                                   XMPPResourceConnection session,
                                   Queue<Packet> results,
                                   Map<String,Object> settings,
                                   RosterAbstract.PresenceType pres_type)
                            throws NotAuthorizedException,
                                   TigaseDBException,
                                   NoConnectionIdException

Throws:

NotAuthorizedException

TigaseDBException

NoConnectionIdException

processInUnsubscribe

protected void processInUnsubscribe(Packet packet,
                                    XMPPResourceConnection session,
                                    Queue<Packet> results,
                                    Map<String,Object> settings,
                                    RosterAbstract.PresenceType pres_type)
                             throws NotAuthorizedException,
                                    TigaseDBException,
                                    NoConnectionIdException

Throws:

NotAuthorizedException

TigaseDBException

NoConnectionIdException

processInUnsubscribed

protected void processInUnsubscribed(Packet packet,
                                     XMPPResourceConnection session,
                                     Queue<Packet> results,
                                     Map<String,Object> settings,
                                     RosterAbstract.PresenceType pres_type)
                              throws NotAuthorizedException,
                                     TigaseDBException,
                                     NoConnectionIdException

Throws:

NotAuthorizedException

TigaseDBException

NoConnectionIdException

sendRosterOfflinePresence

protected void sendRosterOfflinePresence(XMPPResourceConnection session,
                                         Queue<Packet> results)
                                  throws NotAuthorizedException,
                                         TigaseDBException,
                                         NoConnectionIdException

Method sends server generated presence unavailable for all buddies from the roster with a custom status message.

Parameters:

session -

Throws:

TigaseDBException

NotAuthorizedException

NoConnectionIdException

processOutInitial

protected void processOutInitial(Packet packet,
                                 XMPPResourceConnection session,
                                 Queue<Packet> results,
                                 Map<String,Object> settings,
                                 RosterAbstract.PresenceType type)
                          throws NotAuthorizedException,
                                 TigaseDBException

Throws:

NotAuthorizedException

TigaseDBException

processOutSubscribe

protected void processOutSubscribe(Packet packet,
                                   XMPPResourceConnection session,
                                   Queue<Packet> results,
                                   Map<String,Object> settings,
                                   RosterAbstract.PresenceType pres_type)
                            throws NotAuthorizedException,
                                   TigaseDBException,
                                   NoConnectionIdException

Throws:

NotAuthorizedException

TigaseDBException

NoConnectionIdException

processOutSubscribed

protected void processOutSubscribed(Packet packet,
                                    XMPPResourceConnection session,
                                    Queue<Packet> results,
                                    Map<String,Object> settings,
                                    RosterAbstract.PresenceType pres_type)
                             throws NotAuthorizedException,
                                    TigaseDBException,
                                    NoConnectionIdException

Throws:

NotAuthorizedException

TigaseDBException

NoConnectionIdException

buddyOnline

protected void buddyOnline(XMPPResourceConnection session,
                           tigase.xmpp.JID buddy,
                           Queue<Packet> results)
                    throws NotAuthorizedException,
                           TigaseDBException

Throws:

NotAuthorizedException

TigaseDBException