Overview  Package   Class  Use  Deprecated  Index
Home >> All >> edu >> ou >> kmi >> buddyspace >> [ core overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

edu.ou.kmi.buddyspace.core
Class BSRosterBean  

java.lang.Object
  edu.ou.kmi.buddyspace.core.BSRosterBean

All Implemented Interfaces:

org.jabber.jabberbeans.ConnectionListener, org.jabber.jabberbeans.RosterListener

---

public class BSRosterBean

extends java.lang.Object

implements org.jabber.jabberbeans.RosterListener, org.jabber.jabberbeans.ConnectionListener

BSRosterBean provides roster handling. It relies on BSInfoQueryBean, which must be set after each reconnection. It uses RosterBean.

---

Field Summary
private  java.util.Hashtable	curRoster
private  java.lang.String	name
private  org.jabber.jabberbeans.RosterBean	rosterBean
private  java.util.Vector	rosterListeners

 

Constructor Summary
(package private)	BSRosterBean()           Constructor
(package private)	BSRosterBean(org.jabber.jabberbeans.IQBean iqBean)           Constructor, which sets existing and connected IQBean.

 

Method Summary
boolean	addContact(JID jid, java.lang.String nick, java.lang.String group)           Adds contact into the roster.
void	addRosterListener(org.jabber.jabberbeans.RosterListener listener)           Adds RosterListener from listeners notified when roster changes.
boolean	changeContact(JID jid, java.lang.String nick, java.lang.String group, java.lang.String oldGroup)           Changes contact in roster.
void	changedRoster(Roster roster)           The changedRoster event is fired when there has been a change to the roster state.
void	clear()           Clears the current roster.
void	connectionChanged(ConnectionEvent ce)           Invoked when connection changes.
boolean	deleteJIDFromGroup(JID jid, java.lang.String group)           Deletes contact with JID from given group in the roster.
java.util.Enumeration	entries()           Returns Enumeration of roster entries.
private  void	fireChangedRoster(Roster roster)           Notifies roster listeners about roster change.
private  void	fireReplacedRoster(Roster roster)           Notifies roster listeners about roster replace.
java.lang.String	getFriendlyName(JID jid)           Returns friendly name of the JID according to appropriate RosterItem.
java.util.Iterator	getGroups()           Returns Iterator over all groups in roster.
protected  org.jabber.jabberbeans.IQBean	getIQBean()           Returns currently used IQBean.
java.util.Enumeration	getJIDsInGroup(java.lang.String groupName)           Returns Enumeration over all JIDs in given group.
protected  org.jabber.jabberbeans.RosterBean	getRosterBean()           Returns currently used RosterBean.
java.lang.String	getRosterItemHashString(JID jid, java.lang.String group, boolean useGroup)           Returns string used as a key in roster hashtable.
boolean	isJIDInRoster(JID jid)           Returns true if there is a contact in roster with given JID.
boolean	isSubscriptionToJID(JID jid)           Returns true if there is subscription to presence of given JID.
protected  void	prepareToDestroy()           Frees all object bindings to allow object destroy
void	refreshRoster()           Sends request to server for roster refresh.
void	removeAllRosterListeners()           Removes all listeners notified when roster changes.
void	removeRosterListener(org.jabber.jabberbeans.RosterListener listener)           Removes RosterListener from listeners notified when roster changes.
void	replacedRoster(Roster roster)           The replacedRoster event is fired when a completely new roster has replaced the existing one.
protected  void	setIQBean(org.jabber.jabberbeans.IQBean iqBean)           Sets existing and connected IQBean.

 

Methods inherited from class java.lang.Object

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

 

Methods inherited from interface org.jabber.jabberbeans.RosterListener

changedRoster, replacedRoster

 

Methods inherited from interface org.jabber.jabberbeans.ConnectionListener

connected, connectFailed, connecting, disconnected

 

Field Detail

curRoster

private java.util.Hashtable curRoster

---

rosterBean

private org.jabber.jabberbeans.RosterBean rosterBean

---

name

private final java.lang.String name

See Also:

Constant Field Values

---

rosterListeners

private java.util.Vector rosterListeners

Constructor Detail

BSRosterBean

BSRosterBean()

Constructor

---

BSRosterBean

BSRosterBean(org.jabber.jabberbeans.IQBean iqBean)

Constructor, which sets existing and connected IQBean. Then RosterBean is created and this is registered as listener for connection and roster event.

Method Detail

setIQBean

protected void setIQBean(org.jabber.jabberbeans.IQBean iqBean)

Sets existing and connected IQBean. Then RosterBean is created and this is registered as listener for connection and roster event.

---

getIQBean

protected org.jabber.jabberbeans.IQBean getIQBean()

Returns currently used IQBean.

---

getRosterBean

protected org.jabber.jabberbeans.RosterBean getRosterBean()

Returns currently used RosterBean.

---

entries

public java.util.Enumeration entries()

Returns Enumeration of roster entries. The entries are of RosterItem type.

---

prepareToDestroy

protected void prepareToDestroy()

Frees all object bindings to allow object destroy

---

refreshRoster

public void refreshRoster()

Sends request to server for roster refresh. After the refreshed roster comes replacedRoster is invoked.

---

clear

public void clear()

Clears the current roster. This function is typically called after disconnecting.

---

addContact

public boolean addContact(JID jid,
                          java.lang.String nick,
                          java.lang.String group)

Adds contact into the roster. Returns if the request was successfuly sent to server. But still the server can return error as a response.

---

changeContact

public boolean changeContact(JID jid,
                             java.lang.String nick,
                             java.lang.String group,
                             java.lang.String oldGroup)

Changes contact in roster. Returns if the request was successfuly sent to server. But still the server can return error as a response. When the group or oldGroup is null, it means that no group is used (the contact is not in any group).

---

deleteJIDFromGroup

public boolean deleteJIDFromGroup(JID jid,
                                  java.lang.String group)

Deletes contact with JID from given group in the roster. Returns if the request was successfuly sent to server. But still the server can return error as a response.

---

isJIDInRoster

public boolean isJIDInRoster(JID jid)

Returns true if there is a contact in roster with given JID.

---

isSubscriptionToJID

public boolean isSubscriptionToJID(JID jid)

Returns true if there is subscription to presence of given JID.

---

getGroups

public java.util.Iterator getGroups()

Returns Iterator over all groups in roster.

---

getJIDsInGroup

public java.util.Enumeration getJIDsInGroup(java.lang.String groupName)

Returns Enumeration over all JIDs in given group.

---

getRosterItemHashString

public java.lang.String getRosterItemHashString(JID jid,
                                                java.lang.String group,
                                                boolean useGroup)

Returns string used as a key in roster hashtable.

---

changedRoster

public void changedRoster(Roster roster)

The changedRoster event is fired when there has been a change to the roster state.

---

replacedRoster

public void replacedRoster(Roster roster)

The replacedRoster event is fired when a completely new roster has replaced the existing one.

---

getFriendlyName

public java.lang.String getFriendlyName(JID jid)

Returns friendly name of the JID according to appropriate RosterItem.

---

addRosterListener

public void addRosterListener(org.jabber.jabberbeans.RosterListener listener)

Adds RosterListener from listeners notified when roster changes.

---

removeRosterListener

public void removeRosterListener(org.jabber.jabberbeans.RosterListener listener)

Removes RosterListener from listeners notified when roster changes.

---

removeAllRosterListeners

public void removeAllRosterListeners()

Removes all listeners notified when roster changes. This can be used before to free dependencies and allow dispose of all objects.

---

fireChangedRoster

private void fireChangedRoster(Roster roster)

Notifies roster listeners about roster change.

---

fireReplacedRoster

private void fireReplacedRoster(Roster roster)

Notifies roster listeners about roster replace.

---

connectionChanged

public void connectionChanged(ConnectionEvent ce)

Invoked when connection changes. If disconnected, clears the roster and fires its change.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> edu >> ou >> kmi >> buddyspace >> [ core overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---