Class AnonymousRoster

java.lang.Object
tigase.xmpp.impl.roster.AnonymousRoster
All Implemented Interfaces:
DynamicRosterIfc

public class AnonymousRoster extends Object implements DynamicRosterIfc
Describe class AnonymousRoster here.
Created: Tue Apr 22 21:41:46 2008
Author:
Artur Hefczyc
  • Constructor Details

    • AnonymousRoster

      public AnonymousRoster()
  • Method Details

    • init

      public void init(Map<String,Object> props)
      Description copied from interface: DynamicRosterIfc
      init method is used to provide configuration parameters and initialize the object. Please have a look at the interface description for more details about configuration parameters. The object is never used before it's init(...) method is called but it might be used straight away after the method has finished.
      Specified by:
      init in interface DynamicRosterIfc
      Parameters:
      props - a Map<String, Object> props is a configuration parameters map in the form: key:value exactly as they were specified in the configuration file.
    • init

      public void init(String par)
      Description copied from interface: DynamicRosterIfc
      init method is called at the initialization time when simple form of startup parameters are used:
      sess-man/plugins-conf/class-name.init=configuration-string
      The configuration-string is passed to this init(...) method in exact form as it was found in the configuration file.
      Specified by:
      init in interface DynamicRosterIfc
      Parameters:
      par - a String value of the configuration string.
    • getBuddies

      public JID[] getBuddies(XMPPResourceConnection session) throws NotAuthorizedException
      Description copied from interface: DynamicRosterIfc
      getBuddies method returns String array with all roster buddies JIDs. Normally they are bare JIDs (without resource part). This method is normally used by presence plugin to send probe and initial presence to all contacts in the dynamic roster.
      Specified by:
      getBuddies in interface DynamicRosterIfc
      Parameters:
      session - a XMPPResourceConnection value of the connection session object.
      Returns:
      a String[] array of bare JIDs for the dynamic part of the user roster.
      Throws:
      NotAuthorizedException - may be thrown if the connection session is not yet authenticated but authorization is required to access roster data.
    • getBuddyItem

      public Element getBuddyItem(XMPPResourceConnection session, JID buddy) throws NotAuthorizedException
      Description copied from interface: DynamicRosterIfc
      getBuddyItem method returns buddy item element for a given JID or null if the buddy doesn't exist on the user roster list.
      Specified by:
      getBuddyItem in interface DynamicRosterIfc
      Parameters:
      session - a XMPPResourceConnection value of the connection session object.
      buddy - a String value of the buddy JID. It may be bare JID or full JID.
      Returns:
      an Element value of the XML element with all the roster item data - JID, subscription, nick name and groups. Sample code for creating the buddy element could look like this:
      Element item = new Element("item", new Element[] {
           new Element("group", "Tigase devs")},
        new String[] {"jid", "subscription", "name"},
        new String[] {peer, "both", JIDUtils.getNodeNick(peer)});
      Throws:
      NotAuthorizedException - may be thrown if the connection session is not yet authenticated but authorization is required to access roster data.
    • getRosterItems

      public List<Element> getRosterItems(XMPPResourceConnection session) throws NotAuthorizedException
      Description copied from interface: DynamicRosterIfc
      getRosterItems method returns a full list with all buddies generated by this dynamic roster implementation. The list contains all contacts for the roster with all contacts details - buddy JID, nick name, subscription (typically always both) and groups. Please have a look at getBuddyItem(...) description for details how to create an Element entry for the roster item.
      In theory you could here call the getBuddies(...) method and then for each entry from the array call the getBuddyItem(...). I strongly advice to not do it. This is a server with thousands of connected users and possibly thousands of packets going through the server. Think of a performance and execute database query once if possible rather then many times.
      Specified by:
      getRosterItems in interface DynamicRosterIfc
      Parameters:
      session - a XMPPResourceConnection value of the connection session object.
      Returns:
      a List<Element> value
      Throws:
      NotAuthorizedException - may be thrown if the connection session is not yet authenticated but authorization is required to access roster data.
    • setItemExtraData

      public void setItemExtraData(Element item)
      Specified by:
      setItemExtraData in interface DynamicRosterIfc
    • getItemExtraData

      public Element getItemExtraData(Element item)
      Description copied from interface: DynamicRosterIfc
      Returns a new roster Item element with additional, non-standard information for a given item. This is a way to associate custom roster information with a contact.
      Specified by:
      getItemExtraData in interface DynamicRosterIfc
      Parameters:
      item - is a Element
      Returns:
      a value of Element