tigase.xmpp.impl.roster

Class Roster

java.lang.Object

tigase.xmpp.impl.roster.RosterAbstract

tigase.xmpp.impl.roster.Roster

public class Roster
extends RosterAbstract

Describe class Roster here. Created: Tue Feb 21 18:05:53 2006

Version:

$Rev$

Author:

Artur Hefczyc

Nested Class Summary

Nested classes/interfaces inherited from class tigase.xmpp.impl.roster.RosterAbstract

RosterAbstract.PresenceType, RosterAbstract.StateTransition, RosterAbstract.SubscriptionType

Field Summary

Fields inherited from class tigase.xmpp.impl.roster.RosterAbstract

CLIENT_XMLNS, DISCO_FEATURES, FEATURES, FROM_SUBSCRIBED, GROUP, GROUPS, INITIAL_PRESENCES, NAME, PENDING_IN, PENDING_OUT, ROSTER, ROSTER_XMLNS, ROSTERHASH, SUB_BOTH, SUB_FROM, SUB_NONE, SUB_TO, SUBSCRIPTION, TO_SUBSCRIBED, VER_ATT, XMLNS, XMLNS_DYNAMIC

Constructor Summary

Constructors

Constructor and Description
Roster()

Method Summary

Methods

Modifier and Type	Method and Description
void	addBuddy(XMPPResourceConnection session, tigase.xmpp.JID jid, String name, String[] groups, String otherData) Method description
boolean	addBuddyGroup(XMPPResourceConnection session, tigase.xmpp.JID buddy, String[] groups) Method description
boolean	containsBuddy(XMPPResourceConnection session, tigase.xmpp.JID buddy) Method description
tigase.xmpp.JID[]	getBuddies(XMPPResourceConnection session) Method description
String[]	getBuddyGroups(XMPPResourceConnection session, tigase.xmpp.JID buddy) Method description
String	getBuddyName(XMPPResourceConnection session, tigase.xmpp.JID buddy) Method description
RosterAbstract.SubscriptionType	getBuddySubscription(XMPPResourceConnection session, tigase.xmpp.JID buddy) Method description
String	getCustomStatus(XMPPResourceConnection session, tigase.xmpp.JID buddy)
RosterElementIfc	getRosterElement(XMPPResourceConnection session, tigase.xmpp.JID jid) Method description
boolean	isOnline(XMPPResourceConnection session, tigase.xmpp.JID jid) Method description
void	logout(XMPPResourceConnection session) Method description
boolean	presenceSent(XMPPResourceConnection session, tigase.xmpp.JID jid) Method description
boolean	removeBuddy(XMPPResourceConnection session, tigase.xmpp.JID jid) Method description
void	setBuddyName(XMPPResourceConnection session, tigase.xmpp.JID buddy, String name) Method description
void	setBuddySubscription(XMPPResourceConnection session, RosterAbstract.SubscriptionType subscription, tigase.xmpp.JID buddy) Method description
void	setOnline(XMPPResourceConnection session, tigase.xmpp.JID jid, boolean online) Method description
void	setPresenceSent(XMPPResourceConnection session, tigase.xmpp.JID jid, boolean sent) Method description

Methods inherited from class tigase.xmpp.impl.roster.RosterAbstract

getBuddies, getBuddiesHash, getBuddyItem, getPresenceType, getRosterItems, getStateTransition, groupNode, init, isPendingIn, isSubscribedFrom, isSubscribedFrom, isSubscribedTo, updateBuddyChange, updateBuddySubscription, updateRosterHash

Methods inherited from class java.lang.Object

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

Constructor Detail

Roster

public Roster()

Method Detail

addBuddy

public void addBuddy(XMPPResourceConnection session,
            tigase.xmpp.JID jid,
            String name,
            String[] groups,
            String otherData)
              throws NotAuthorizedException,
                     TigaseDBException

Method description

Specified by:

addBuddy in class RosterAbstract

Parameters:

session -

jid -

name -

groups -

otherData -

Throws:

NotAuthorizedException

TigaseDBException

addBuddyGroup

public boolean addBuddyGroup(XMPPResourceConnection session,
                    tigase.xmpp.JID buddy,
                    String[] groups)
                      throws NotAuthorizedException,
                             TigaseDBException

Method description

Specified by:

addBuddyGroup in class RosterAbstract

Parameters:

session -

buddy -

groups -

Returns:

a value of boolean

Throws:

NotAuthorizedException

TigaseDBException

containsBuddy

public boolean containsBuddy(XMPPResourceConnection session,
                    tigase.xmpp.JID buddy)
                      throws NotAuthorizedException,
                             TigaseDBException

Method description

Specified by:

containsBuddy in class RosterAbstract

Parameters:

session -

buddy -

Returns:

a value of boolean

Throws:

NotAuthorizedException

TigaseDBException

getBuddies

public tigase.xmpp.JID[] getBuddies(XMPPResourceConnection session)
                             throws NotAuthorizedException,
                                    TigaseDBException

Method description

Specified by:

getBuddies in class RosterAbstract

Parameters:

session -

Returns:

a value of JID[]

Throws:

NotAuthorizedException

TigaseDBException

getBuddyGroups

public String[] getBuddyGroups(XMPPResourceConnection session,
                      tigase.xmpp.JID buddy)
                        throws NotAuthorizedException,
                               TigaseDBException

Method description

Specified by:

getBuddyGroups in class RosterAbstract

Parameters:

session -

buddy -

Returns:

a value of String[]

Throws:

NotAuthorizedException

TigaseDBException

getBuddyName

public String getBuddyName(XMPPResourceConnection session,
                  tigase.xmpp.JID buddy)
                    throws NotAuthorizedException,
                           TigaseDBException

Method description

Specified by:

getBuddyName in class RosterAbstract

Parameters:

session -

buddy -

Returns:

a value of String

Throws:

NotAuthorizedException

TigaseDBException

getBuddySubscription

public RosterAbstract.SubscriptionType getBuddySubscription(XMPPResourceConnection session,
                                                   tigase.xmpp.JID buddy)
                                                     throws NotAuthorizedException,
                                                            TigaseDBException

Method description

Specified by:

getBuddySubscription in class RosterAbstract

Parameters:

session -

buddy -

Returns:

a value of SubscriptionType

Throws:

NotAuthorizedException

TigaseDBException

isOnline

public boolean isOnline(XMPPResourceConnection session,
               tigase.xmpp.JID jid)
                 throws NotAuthorizedException,
                        TigaseDBException

Method description

Specified by:

isOnline in class RosterAbstract

Parameters:

session -

jid -

Returns:

a value of boolean

Throws:

NotAuthorizedException

TigaseDBException

presenceSent

public boolean presenceSent(XMPPResourceConnection session,
                   tigase.xmpp.JID jid)
                     throws NotAuthorizedException,
                            TigaseDBException

Method description

Specified by:

presenceSent in class RosterAbstract

Parameters:

session -

jid -

Returns:

a value of boolean

Throws:

NotAuthorizedException

TigaseDBException

removeBuddy

public boolean removeBuddy(XMPPResourceConnection session,
                  tigase.xmpp.JID jid)
                    throws NotAuthorizedException,
                           TigaseDBException

Method description

Specified by:

removeBuddy in class RosterAbstract

Parameters:

session -

jid -

Returns:

a value of boolean

Throws:

NotAuthorizedException

TigaseDBException

setBuddyName

public void setBuddyName(XMPPResourceConnection session,
                tigase.xmpp.JID buddy,
                String name)
                  throws NotAuthorizedException,
                         TigaseDBException

Method description

Specified by:

setBuddyName in class RosterAbstract

Parameters:

session -

buddy -

name -

Throws:

NotAuthorizedException

TigaseDBException

setBuddySubscription

public void setBuddySubscription(XMPPResourceConnection session,
                        RosterAbstract.SubscriptionType subscription,
                        tigase.xmpp.JID buddy)
                          throws NotAuthorizedException,
                                 TigaseDBException

Method description

Specified by:

setBuddySubscription in class RosterAbstract

Parameters:

session -

subscription -

buddy -

Throws:

NotAuthorizedException

TigaseDBException

setOnline

public void setOnline(XMPPResourceConnection session,
             tigase.xmpp.JID jid,
             boolean online)
               throws NotAuthorizedException,
                      TigaseDBException

Method description

Specified by:

setOnline in class RosterAbstract

Parameters:

session -

jid -

online -

Throws:

NotAuthorizedException

TigaseDBException

setPresenceSent

public void setPresenceSent(XMPPResourceConnection session,
                   tigase.xmpp.JID jid,
                   boolean sent)
                     throws NotAuthorizedException,
                            TigaseDBException

Method description

Specified by:

setPresenceSent in class RosterAbstract

Parameters:

session -

jid -

sent -

Throws:

NotAuthorizedException

TigaseDBException

getRosterElement

public RosterElementIfc getRosterElement(XMPPResourceConnection session,
                                tigase.xmpp.JID jid)
                                  throws NotAuthorizedException,
                                         TigaseDBException

Description copied from class: RosterAbstract

Method description

Specified by:

getRosterElement in class RosterAbstract

Parameters:

session - is a XMPPResourceConnection

jid - is a JID

Returns:

a value of RosterElementIfc

Throws:

NotAuthorizedException

TigaseDBException

logout

public void logout(XMPPResourceConnection session)

Description copied from class: RosterAbstract

Method description

Specified by:

logout in class RosterAbstract

Parameters:

session - is a XMPPResourceConnection

getCustomStatus

public String getCustomStatus(XMPPResourceConnection session,
                     tigase.xmpp.JID buddy)

Specified by:

getCustomStatus in class RosterAbstract

Returns:

a value of String