|
Openfire 3.8.0 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jivesoftware.openfire.group.DefaultGroupProvider
public class DefaultGroupProvider
Database implementation of the GroupManager interface.
Constructor Summary | |
---|---|
DefaultGroupProvider()
|
Method Summary | |
---|---|
void |
addMember(String groupName,
org.xmpp.packet.JID user,
boolean administrator)
Adds an entity to a group (optional operation). |
Group |
createGroup(String name)
Creates a group with the given name (optional operation). |
void |
deleteGroup(String groupName)
Deletes the group (optional operation). |
void |
deleteMember(String groupName,
org.xmpp.packet.JID user)
Deletes an entity from a group (optional operation). |
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> |
getPublicSharedGroupNames()
Returns an unmodifiable Collection of all public shared groups in the system. |
Collection<String> |
getSharedGroupNames()
Returns the name of the groups that are shared groups. |
Collection<String> |
getSharedGroupNames(org.xmpp.packet.JID user)
Returns an unmodifiable Collection of all shared groups in the system for a given user. |
Collection<String> |
getVisibleGroupNames(String userGroup)
Returns an unmodifiable Collection of groups that are visible to the members of the given group. |
boolean |
isReadOnly()
Returns true if this GroupProvider is read-only. |
boolean |
isSearchSupported()
Returns true if group searching is supported by the provider. |
boolean |
isSharingSupported()
Returns true if this GroupProvider allows group sharing. |
Map<String,String> |
loadProperties(Group group)
Returns a custom Map that updates the database whenever
a property value is added, changed, or deleted. |
Collection<String> |
search(String query)
Returns the group names that match a search. |
Collection<String> |
search(String query,
int startIndex,
int numResults)
Returns the group names that match a search given a start index and desired number of results. |
Collection<String> |
search(String key,
String value)
Returns the names of groups that have a property matching the given key/value pair. |
void |
setDescription(String name,
String description)
Updates the group's description. |
void |
setName(String oldName,
String newName)
Sets the name of a group to a new name. |
void |
updateMember(String groupName,
org.xmpp.packet.JID user,
boolean administrator)
Updates the privileges of an entity in a group. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DefaultGroupProvider()
Method Detail |
---|
public Group createGroup(String name) throws GroupAlreadyExistsException
GroupProvider
The provider is responsible for setting the creation date and modification date to the current date/time.
createGroup
in interface GroupProvider
name
- name of the group.
GroupAlreadyExistsException
- if a group with the same name already
exists.public Group getGroup(String name) throws GroupNotFoundException
GroupProvider
getGroup
in interface GroupProvider
name
- the name of the group.
GroupNotFoundException
- If no group with that ID could be foundpublic void setDescription(String name, String description) throws GroupNotFoundException
GroupProvider
setDescription
in interface GroupProvider
name
- the group name.description
- the group description.
GroupNotFoundException
- if no existing group could be found to update.public void setName(String oldName, String newName) throws UnsupportedOperationException, GroupAlreadyExistsException
GroupProvider
setName
in interface GroupProvider
oldName
- the current name of the group.newName
- the desired new name of the group.
UnsupportedOperationException
- if the provider does not
support the operation.
GroupAlreadyExistsException
- if a group with the same name already
exists.public void deleteGroup(String groupName)
GroupProvider
deleteGroup
in interface GroupProvider
groupName
- the name of the group to delete.public int getGroupCount()
GroupProvider
getGroupCount
in interface GroupProvider
public Collection<String> getSharedGroupNames()
getSharedGroupNames
in interface GroupProvider
public Collection<String> getSharedGroupNames(org.xmpp.packet.JID user)
GroupProvider
getSharedGroupNames
in interface GroupProvider
public Collection<String> getVisibleGroupNames(String userGroup)
GroupProvider
getVisibleGroupNames
in interface GroupProvider
userGroup
- The given group
public Collection<String> search(String key, String value)
GroupProvider
GroupProvider.isSearchSupported()
method
to ensure that searching is supported.
search
in interface GroupProvider
key
- The name of a group property (e.g. "sharedRoster.showInRoster")value
- The value to match for the given property
public Collection<String> getPublicSharedGroupNames()
GroupProvider
getPublicSharedGroupNames
in interface GroupProvider
public Collection<String> getGroupNames()
GroupProvider
getGroupNames
in interface GroupProvider
public Collection<String> getGroupNames(int startIndex, int numResults)
GroupProvider
getGroupNames
in interface GroupProvider
startIndex
- start index in results.numResults
- number of results to return.
public Collection<String> getGroupNames(org.xmpp.packet.JID user)
GroupProvider
getGroupNames
in interface GroupProvider
user
- the JID of the entity.
public void addMember(String groupName, org.xmpp.packet.JID user, boolean administrator)
GroupProvider
addMember
in interface GroupProvider
groupName
- the group to add the member touser
- the JID of the entity to addadministrator
- True if the member is an administrator of the grouppublic void updateMember(String groupName, org.xmpp.packet.JID user, boolean administrator)
GroupProvider
updateMember
in interface GroupProvider
groupName
- the group where the change happeneduser
- the JID of the entity with new privilegesadministrator
- True if the member is an administrator of the grouppublic void deleteMember(String groupName, org.xmpp.packet.JID user)
GroupProvider
deleteMember
in interface GroupProvider
groupName
- the group name.user
- the JID of the entity to delete.public boolean isReadOnly()
GroupProvider
isReadOnly
in interface GroupProvider
public Collection<String> search(String query)
GroupProvider
Before searching or showing a search UI, use the GroupProvider.isSearchSupported()
method
to ensure that searching is supported.
search
in interface GroupProvider
query
- the search string for group names.
public Collection<String> search(String query, int startIndex, int numResults)
GroupProvider
Before searching or showing a search UI, use the GroupProvider.isSearchSupported()
method
to ensure that searching is supported.
search
in interface GroupProvider
query
- the search string for group names.startIndex
- start index in results.numResults
- number of results to return.
public boolean isSearchSupported()
GroupProvider
isSearchSupported
in interface GroupProvider
public boolean isSharingSupported()
GroupProvider
isSharingSupported
in interface GroupProvider
public Map<String,String> loadProperties(Group group)
Map
that updates the database whenever
a property value is added, changed, or deleted.
loadProperties
in interface GroupProvider
name
- The target group
|
Openfire 3.8.0 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |