tigase.xmpp.impl.roster

## Class DynamicRosterTest

- java.lang.Object
- - tigase.xmpp.impl.roster.DynamicRosterTest

- All Implemented Interfaces:
    DynamicRosterIfc

      public class DynamicRosterTest
      extends Object
      implements DynamicRosterIfc

  Created: Nov 28, 2008 10:27:55 PM
  Version:
    $Rev$
  Author:
    Artur Hefczyc

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `DynamicRosterTest()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `JID[]` | `getBuddies(XMPPResourceConnection session)` `getBuddies` method returns `String` array with all roster buddies JIDs.
    `Element` | `getBuddyItem(XMPPResourceConnection session, JID buddy)` `getBuddyItem` method returns buddy item element for a given JID or `null` if the buddy doesn't exist on the user roster list.
    `Element` | `getItemExtraData(Element item)` Returns a new roster Item element with additional, non-standard information for a given item.
    `List<Element>` | `getRosterItems(XMPPResourceConnection session)` `getRosterItems` method returns a full list with all buddies generated by this dynamic roster implementation.
    `void` | `init(Map<String,Object> props)` `init` method is used to provide configuration parameters and initialize the object.
    `void` | `init(String par)` `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(...)`
    `void` | `setItemExtraData(Element item)` Method description

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### DynamicRosterTest

          public DynamicRosterTest()

  - ### Method Detail

    - #### 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.

    - #### 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`

    - #### 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.

    - #### 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.

    - #### setItemExtraData

          public void setItemExtraData(Element item)

      Description copied from interface: `DynamicRosterIfc`
      Method description
      Specified by:
        `setItemExtraData` in interface `DynamicRosterIfc`
      Parameters:
        `item` - is a `Element`

Copyright © 2022 "Tigase, Inc.". All rights reserved.