Source code: org/jabber/jabberbeans/RosterBean.java

   package org.jabber.jabberbeans;
   
   import java.io.Serializable;
   import java.io.IOException;
   import java.util.Vector;
   import java.util.Enumeration;
   import org.jabber.jabberbeans.Extension.Extension;
   import org.jabber.jabberbeans.Extension.QueryExtension;
   import org.jabber.jabberbeans.Extension.IQRosterExtension;
  import org.jabber.jabberbeans.Extension.IQRosterExtensionBuilder;
  
  /**
   * 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.
   *
   * @author  David Waite <a href="mailto:mass@ufl.edu"><i>&lt;mass@ufl.edu&gt;
   *      </i></a>
   * @author  $Author: mass $
   * @version $Revision: 1.2 $
   */
  public class RosterBean
      implements Serializable
  {
      private IQBean connection;
      private Vector rosterListeners=new Vector();
      private IQRosterExtension currentRoster;
  
      /**
       * a infoquery builder for sending roster change requests. Not created
       * until first use.
       */
      private InfoQueryBuilder IQBuilder=null;
  
      /**
       * a roster extension builder for sending roster change requests. Not
       * created until first use.
       */
      private IQRosterExtensionBuilder rosterBuilder=null;
  
      /**
       * a roster item builder for sending custom roster changes. Not created
       * until first use.
       */
      private RosterItemBuilder rosterItemBuilder=null;
  
      class RosterIQPacketListener
    implements PacketListener
      {
    public void receivedPacket(Packet l)
    {
        if (!(l instanceof InfoQuery))
      return;
        Extension e=((InfoQuery)l).getQueryExtension();
  
        if (!(e instanceof IQRosterExtension))
      return;
        //TODO: add code to modify current roster image based on 
        //new data. Replacement is basically shown by if the type is not
        //'result' of the IQ
        if (((InfoQuery)l).getType().equals("result"))
        {
      //the results of a get will be the results of a full fetch
      currentRoster=(IQRosterExtension)e;
      fireUserRosterReplaced(currentRoster);
        }
        else
        {
      //TODO: add modification code
      fireUserRosterChanged((IQRosterExtension)e);
        }
    }
    
    public void sentPacket(Packet l)
    {
    }
      }
      public RosterBean()
      {
      }
      public void setIQBean(IQBean connection)
      {
    this.connection=connection;
      }
      public IQBean getIQBean()
      {
    return connection;
      }
      
      public void refreshRoster()
    throws InstantiationException,IOException
     {
   //create builder if not used before.
   if (IQBuilder==null)
       IQBuilder=new InfoQueryBuilder();
   else
       //we have used  this builder before - make sure it is clean.
       IQBuilder.reset();
   IQBuilder.setType("get");
   
   //this should never throw an exception
   IQBuilder.setQueryExtension(new IQRosterExtension());
   
   //this also should just work.
   connection.send((InfoQuery)IQBuilder.build());
     }
   
 
     public synchronized void addRosterItem(RosterItem ri)
   throws InstantiationException,IOException
     {
   //create builder if not used before.
   if (IQBuilder==null)
       IQBuilder=new InfoQueryBuilder();
   else
       //we have used  this builder before - make sure it is clean.
       IQBuilder.reset();
   IQBuilder.setType("set");
   
   if(rosterBuilder==null)
       rosterBuilder=new IQRosterExtensionBuilder();
       else
     rosterBuilder.reset();
   
   rosterBuilder.addRosterItem(ri);
   
   //this should never throw an exception, because we added the
   //roster item above first
   IQBuilder.setQueryExtension((QueryExtension)rosterBuilder.build());
   
   //this also should just work.
   connection.send((InfoQuery)IQBuilder.build());
     }
     public synchronized void delRosterItem(RosterItem ri)
   throws InstantiationException,IOException
     {  
   //create builder if not used before.
   if (IQBuilder==null)
       IQBuilder=new InfoQueryBuilder();
   else
       //we have used  this builder before - make sure it is clean.
     IQBuilder.reset();
         IQBuilder.setType("set");
   
   if(rosterBuilder==null)
       rosterBuilder=new IQRosterExtensionBuilder();
   else
       rosterBuilder.reset();
 
   if (rosterItemBuilder==null)
       rosterItemBuilder=new RosterItemBuilder();
   else
       //we have used this builder before - make sure it is clean.
       rosterItemBuilder.reset();
 
   // copy existing roster item
   rosterItemBuilder.copyItem(ri);
 
   //change subscription type to 'remove' to tell the server to delete the
   //item
   rosterItemBuilder.setSubscriptionType("remove");
 
   //this should never throw an exception, since we are based on
   //the original roster item.
   rosterBuilder.addRosterItem(rosterItemBuilder.build());
   
   //this should never throw an exception, because we added the
   //roster item above first
   IQBuilder.setQueryExtension((QueryExtension)rosterBuilder.build());
 
   //this also should just work.
   connection.send((InfoQuery)IQBuilder.build());
     }
 
     public synchronized void addRosterListener(RosterListener l)
     {
   if(!rosterListeners.contains(l))
           rosterListeners.addElement(l);   
     }
     public synchronized void removeRosterListener(RosterListener l)
     {
   rosterListeners.removeElement(l);
     }
 
     private void fireUserRosterChanged(IQRosterExtension r)
     {
   for (Enumeration e = rosterListeners.elements(); e.hasMoreElements(); )
   {
       ((RosterListener)e.nextElement()).changedRoster(r);
   }
     }
     private void fireUserRosterReplaced(IQRosterExtension r)
     {
   for (Enumeration e = rosterListeners.elements(); e.hasMoreElements(); )
   {
       ((RosterListener)e.nextElement()).replacedRoster(r);
   }
     }
 }