Package org.jivesoftware.openfire.muc.spi

Class IQMuclumbusSearchHandler

java.lang.Object
org.jivesoftware.openfire.muc.spi.IQMuclumbusSearchHandler
@Deprecated(since="5.0.0", forRemoval=true) public class IQMuclumbusSearchHandler extends Object
Deprecated, for removal: This API element is subject to removal in a future version.
The protocol defined herein was formalized (with minor changes) as XEP-0433, which is implemented in IQExtendedChannelSearchHandler
This class adds support for the search functionality for MUC rooms as identified by the 'https://xmlns.zombofant.net/muclumbus/search/1.0' namespace.
Author:
Guus der Kinderen, guus.der.kinderen@gmail.com
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    IQMuclumbusSearchHandler.Key
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAMESPACE
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static SystemProperty<Boolean>
    PROPERTY_ENABLED
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final String
    REQUEST_ELEMENT_NAME
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final String
    RESPONSE_ELEMENT_NAME
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final String
    VAR_KEY
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final String
    VAR_MIN_USERS
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final String
    VAR_Q
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final String
    VAR_SINDADDR
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final String
    VAR_SINDESCRIPTION
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static final String
    VAR_SINNAME
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    IQMuclumbusSearchHandler(MultiUserChatService mucService)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a new instance of the search provider.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.xmpp.packet.IQ
    handleIQ(org.xmpp.packet.IQ iq)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Constructs an answer on a IQ stanza that contains a search request.
    protected List<MUCRoomSearchInfo>
    searchForChatrooms(org.jivesoftware.openfire.muc.spi.IQMuclumbusSearchHandler.SearchParameters params)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static List<MUCRoomSearchInfo>
    sortByAddress(List<MUCRoomSearchInfo> mucs)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Order the provided list by JID of the MUC
    static List<MUCRoomSearchInfo>
    sortByUserAmount(List<MUCRoomSearchInfo> mucs)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Sorts the provided list in such a way that the MUC with the most users will be the first one in the list.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • VAR_SINNAME

      public static final String VAR_SINNAME
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • VAR_Q

      public static final String VAR_Q
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • VAR_SINDESCRIPTION

      public static final String VAR_SINDESCRIPTION
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • VAR_SINDADDR

      public static final String VAR_SINDADDR
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • VAR_MIN_USERS

      public static final String VAR_MIN_USERS
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • VAR_KEY

      public static final String VAR_KEY
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • PROPERTY_ENABLED

      public static SystemProperty<Boolean> PROPERTY_ENABLED
      Deprecated, for removal: This API element is subject to removal in a future version.

    • REQUEST_ELEMENT_NAME

      public static final String REQUEST_ELEMENT_NAME
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • RESPONSE_ELEMENT_NAME

      public static final String RESPONSE_ELEMENT_NAME
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • NAMESPACE

      public static final String NAMESPACE
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

  • Constructor Details

    • IQMuclumbusSearchHandler

      public IQMuclumbusSearchHandler(MultiUserChatService mucService)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a new instance of the search provider.
      Parameters:
      mucService - The server for which to return search results.

  • Method Details

    • handleIQ

      public org.xmpp.packet.IQ handleIQ(org.xmpp.packet.IQ iq)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Constructs an answer on a IQ stanza that contains a search request. The answer will be an IQ stanza of type 'result' or 'error'.
      Parameters:
      iq - The IQ stanza that is the search request.
      Returns:
      An answer to the provided request.

    • searchForChatrooms

      protected List<MUCRoomSearchInfo> searchForChatrooms(org.jivesoftware.openfire.muc.spi.IQMuclumbusSearchHandler.SearchParameters params)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • sortByAddress

      public static List<MUCRoomSearchInfo> sortByAddress(List<MUCRoomSearchInfo> mucs)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Order the provided list by JID of the MUC
      Parameters:
      mucs - The unordered list that will be sorted.
      Returns:
      The order list of MUC rooms.

    • sortByUserAmount

      public static List<MUCRoomSearchInfo> sortByUserAmount(List<MUCRoomSearchInfo> mucs)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Sorts the provided list in such a way that the MUC with the most users will be the first one in the list.
      Parameters:
      mucs - The unordered list that will be sorted.
      Returns:
      The sorted list of MUC rooms.