Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.jabber.jabberbeans
Class RosterBean  view RosterBean download RosterBean.java

java.lang.Object
  extended byorg.jabber.jabberbeans.RosterBean
All Implemented Interfaces:
java.io.Serializable

public class RosterBean
extends java.lang.Object
implements java.io.Serializable

RosterBean is a bean to gain and utilize the roster information in jabber. A 'Roster' is a list of users, a type of subscription list or address book, if you will. By using a roster, you can get the status of other users (online/offline, etc), subscribe and unsubscribe users, as well as change your own status. This bean hooks into an IQBean, it will not work until it is given a ConnectionBean to handle. RosterBean to ConnectionBean is a many to one relation - one ConnectionBean can have many RosterBeans, but if software wants to use more than a singular server connection, there is need for multiple RosterBeans, one per ConnectionBean.

Version:
$Revision: 1.2 $

Nested Class Summary
(package private)  class RosterBean.RosterIQPacketListener
           
 
Field Summary
private  IQBean connection
           
private  IQRosterExtension currentRoster
           
private  InfoQueryBuilder IQBuilder
          a infoquery builder for sending roster change requests.
private  IQRosterExtensionBuilder rosterBuilder
          a roster extension builder for sending roster change requests.
private  RosterItemBuilder rosterItemBuilder
          a roster item builder for sending custom roster changes.
private  java.util.Vector rosterListeners
           
 
Constructor Summary
RosterBean()
           
 
Method Summary
 void addRosterItem(RosterItem ri)
           
 void addRosterListener(RosterListener l)
           
 void delRosterItem(RosterItem ri)
           
private  void fireUserRosterChanged(IQRosterExtension r)
           
private  void fireUserRosterReplaced(IQRosterExtension r)
           
 IQBean getIQBean()
           
 void refreshRoster()
           
 void removeRosterListener(RosterListener l)
           
 void setIQBean(IQBean connection)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

connection

private IQBean connection

rosterListeners

private java.util.Vector rosterListeners

currentRoster

private IQRosterExtension currentRoster

IQBuilder

private InfoQueryBuilder IQBuilder
a infoquery builder for sending roster change requests. Not created until first use.


rosterBuilder

private IQRosterExtensionBuilder rosterBuilder
a roster extension builder for sending roster change requests. Not created until first use.


rosterItemBuilder

private RosterItemBuilder rosterItemBuilder
a roster item builder for sending custom roster changes. Not created until first use.

Constructor Detail

RosterBean

public RosterBean()
Method Detail

setIQBean

public void setIQBean(IQBean connection)

getIQBean

public IQBean getIQBean()

refreshRoster

public void refreshRoster()
                   throws java.lang.InstantiationException,
                          java.io.IOException

addRosterItem

public void addRosterItem(RosterItem ri)
                   throws java.lang.InstantiationException,
                          java.io.IOException

delRosterItem

public void delRosterItem(RosterItem ri)
                   throws java.lang.InstantiationException,
                          java.io.IOException

addRosterListener

public void addRosterListener(RosterListener l)

removeRosterListener

public void removeRosterListener(RosterListener l)

fireUserRosterChanged

private void fireUserRosterChanged(IQRosterExtension r)

fireUserRosterReplaced

private void fireUserRosterReplaced(IQRosterExtension r)