Openfire 3.8.0 Javadoc

org.jivesoftware.openfire.clearspace
Class ClearspaceGroupProvider

java.lang.Object
  extended by org.jivesoftware.openfire.group.AbstractReadOnlyGroupProvider
      extended by org.jivesoftware.openfire.clearspace.ClearspaceGroupProvider
All Implemented Interfaces:
GroupProvider

public class ClearspaceGroupProvider
extends AbstractReadOnlyGroupProvider

Author:
Daniel Henninger

Field Summary
protected static String URL_PREFIX
           
 
Constructor Summary
ClearspaceGroupProvider()
           
 
Method Summary
 Group getGroup(String name)
          Returns a group based on it's name.
 int getGroupCount()
          Returns the number of groups in the system.
 Collection<String> getGroupNames()
          Returns the Collection of all group names in the system.
 Collection<String> getGroupNames(int startIndex, int numResults)
          Returns the Collection of all groups in the system.
 Collection<String> getGroupNames(org.xmpp.packet.JID user)
          Returns the Collection of group names that an entity belongs to.
 Collection<String> getSharedGroupNames()
          Returns a collection of shared group names.
 Collection<String> getSharedGroupNames(org.xmpp.packet.JID user)
          Returns a collection of shared group names for the given user.
 boolean isSearchSupported()
          Returns true if the provider supports group search capability.
 boolean isSharingSupported()
          Returns true if the provider supports group sharing.
 Collection<String> search(String query)
          Returns a collection of group search results.
 Collection<String> search(String query, int startIndex, int numResults)
          Returns a collection of group search results.
 
Methods inherited from class org.jivesoftware.openfire.group.AbstractReadOnlyGroupProvider
addMember, createGroup, deleteGroup, deleteMember, getPublicSharedGroupNames, getVisibleGroupNames, isReadOnly, loadProperties, search, setDescription, setName, updateMember
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

URL_PREFIX

protected static final String URL_PREFIX
See Also:
Constant Field Values
Constructor Detail

ClearspaceGroupProvider

public ClearspaceGroupProvider()
Method Detail

getGroup

public Group getGroup(String name)
               throws GroupNotFoundException
Description copied from interface: GroupProvider
Returns a group based on it's name.

Parameters:
name - the name of the group.
Returns:
the group with the given name.
Throws:
GroupNotFoundException - If no group with that ID could be found

getGroupCount

public int getGroupCount()
Description copied from interface: GroupProvider
Returns the number of groups in the system.

Returns:
the number of groups in the system.

isSharingSupported

public boolean isSharingSupported()
Description copied from class: AbstractReadOnlyGroupProvider
Returns true if the provider supports group sharing. This implementation always returns false.

Specified by:
isSharingSupported in interface GroupProvider
Overrides:
isSharingSupported in class AbstractReadOnlyGroupProvider
Returns:
true if the group provider supports group sharing.

getSharedGroupNames

public Collection<String> getSharedGroupNames()
Description copied from class: AbstractReadOnlyGroupProvider
Returns a collection of shared group names. This implementation returns an empty collection.

Specified by:
getSharedGroupNames in interface GroupProvider
Overrides:
getSharedGroupNames in class AbstractReadOnlyGroupProvider
Returns:
unmodifiable Collection of all shared groups in the system.

getSharedGroupNames

public Collection<String> getSharedGroupNames(org.xmpp.packet.JID user)
Description copied from class: AbstractReadOnlyGroupProvider
Returns a collection of shared group names for the given user. This implementation returns an empty collection.

Specified by:
getSharedGroupNames in interface GroupProvider
Overrides:
getSharedGroupNames in class AbstractReadOnlyGroupProvider
Returns:
unmodifiable Collection of all shared groups in the system for a given user.

getGroupNames

public Collection<String> getGroupNames()
Description copied from interface: GroupProvider
Returns the Collection of all group names in the system.

Returns:
the Collection of all groups.

getGroupNames

public Collection<String> getGroupNames(int startIndex,
                                        int numResults)
Description copied from interface: GroupProvider
Returns the Collection of all groups in the system.

Parameters:
startIndex - start index in results.
numResults - number of results to return.
Returns:
the Collection of all group names given the startIndex and numResults.

getGroupNames

public Collection<String> getGroupNames(org.xmpp.packet.JID user)
Description copied from interface: GroupProvider
Returns the Collection of group names that an entity belongs to.

Parameters:
user - the JID of the entity.
Returns:
the Collection of group names that the user belongs to.

search

public Collection<String> search(String query)
Description copied from class: AbstractReadOnlyGroupProvider
Returns a collection of group search results. This implementation returns an empty collection.

Specified by:
search in interface GroupProvider
Overrides:
search in class AbstractReadOnlyGroupProvider
Parameters:
query - the search string for group names.
Returns:
all groups that match the search.

search

public Collection<String> search(String query,
                                 int startIndex,
                                 int numResults)
Description copied from class: AbstractReadOnlyGroupProvider
Returns a collection of group search results. This implementation returns an empty collection.

Specified by:
search in interface GroupProvider
Overrides:
search in class AbstractReadOnlyGroupProvider
Parameters:
query - the search string for group names.
startIndex - start index in results.
numResults - number of results to return.
Returns:
all groups that match the search.

isSearchSupported

public boolean isSearchSupported()
Description copied from class: AbstractReadOnlyGroupProvider
Returns true if the provider supports group search capability. This implementation always returns false.

Specified by:
isSearchSupported in interface GroupProvider
Overrides:
isSearchSupported in class AbstractReadOnlyGroupProvider
Returns:
true if searching is supported.

Openfire 3.8.0 Javadoc

Copyright © 2003-2008 Jive Software.