|
Openfire 3.9.3 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.openfire.group.AbstractGroupProvider org.jivesoftware.openfire.ldap.LdapGroupProvider
public class LdapGroupProvider
LDAP implementation of the GroupProvider interface. All data in the directory is treated as read-only so any set operations will result in an exception.
Constructor Summary | |
---|---|
LdapGroupProvider()
Constructs a new LDAP group provider. |
Method Summary | |
---|---|
Group |
getGroup(String groupName)
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. |
boolean |
isSearchSupported()
Returns true if the provider supports group search capability. |
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. |
Collection<String> |
search(String key,
String value)
Returns the names of groups that have a property matching the given key/value pair. |
Methods inherited from class org.jivesoftware.openfire.group.AbstractGroupProvider |
---|
addMember, createGroup, deleteGroup, deleteMember, getPublicSharedGroupNames, getSharedGroupNames, getSharedGroupNames, getVisibleGroupNames, isReadOnly, isSharingSupported, loadProperties, setDescription, setName, updateMember |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LdapGroupProvider()
Method Detail |
---|
public Group getGroup(String groupName) throws GroupNotFoundException
GroupProvider
groupName
- the name of the group.
GroupNotFoundException
- If no group with that ID could be foundpublic int getGroupCount()
GroupProvider
public Collection<String> getGroupNames()
GroupProvider
public Collection<String> getGroupNames(int startIndex, int numResults)
GroupProvider
startIndex
- start index in results.numResults
- number of results to return.
public Collection<String> getGroupNames(org.xmpp.packet.JID user)
GroupProvider
user
- the JID of the entity.
public Collection<String> search(String key, String value)
GroupProvider
GroupProvider.isSearchSupported()
method
to ensure that searching is supported.
search
in interface GroupProvider
search
in class AbstractGroupProvider
key
- The name of a group property (e.g. "sharedRoster.showInRoster")value
- The value to match for the given property
public Collection<String> search(String query)
AbstractGroupProvider
search
in interface GroupProvider
search
in class AbstractGroupProvider
query
- the search string for group names.
public Collection<String> search(String query, int startIndex, int numResults)
AbstractGroupProvider
search
in interface GroupProvider
search
in class AbstractGroupProvider
query
- the search string for group names.startIndex
- start index in results.numResults
- number of results to return.
public boolean isSearchSupported()
AbstractGroupProvider
isSearchSupported
in interface GroupProvider
isSearchSupported
in class AbstractGroupProvider
|
Openfire 3.9.3 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |