|
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.AbstractReadOnlyGroupProvider
public abstract class AbstractReadOnlyGroupProvider
Common base class for immutable (read-only) GroupProvider implementations.
Constructor Summary | |
---|---|
AbstractReadOnlyGroupProvider()
|
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 name)
Deletes the group (optional operation). |
void |
deleteMember(String groupName,
org.xmpp.packet.JID user)
Deletes an entity from a group (optional operation). |
Collection<String> |
getPublicSharedGroupNames()
Returns a collection of shared public group names. |
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. |
Collection<String> |
getVisibleGroupNames(String userGroup)
Returns a collection of groups shared with the given group. |
boolean |
isReadOnly()
Always true for a read-only provider |
boolean |
isSearchSupported()
Returns true if the provider supports group search capability. |
boolean |
isSharingSupported()
Returns true if the provider supports group sharing. |
Map<String,String> |
loadProperties(Group group)
Returns a map of properties for the given group. |
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 a collection of group search results. |
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 |
Methods inherited from interface org.jivesoftware.openfire.group.GroupProvider |
---|
getGroup, getGroupCount, getGroupNames, getGroupNames, getGroupNames |
Constructor Detail |
---|
public AbstractReadOnlyGroupProvider()
Method Detail |
---|
public final void addMember(String groupName, org.xmpp.packet.JID user, boolean administrator) throws UnsupportedOperationException
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 group
UnsupportedOperationException
public final void updateMember(String groupName, org.xmpp.packet.JID user, boolean administrator) throws UnsupportedOperationException
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 group
UnsupportedOperationException
public final void deleteMember(String groupName, org.xmpp.packet.JID user) throws UnsupportedOperationException
GroupProvider
deleteMember
in interface GroupProvider
groupName
- the group name.user
- the JID of the entity to delete.
UnsupportedOperationException
public final boolean isReadOnly()
isReadOnly
in interface GroupProvider
public final Group createGroup(String name) throws UnsupportedOperationException
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.
UnsupportedOperationException
public final void deleteGroup(String name) throws UnsupportedOperationException
GroupProvider
deleteGroup
in interface GroupProvider
name
- the name of the group to delete.
UnsupportedOperationException
public final void setName(String oldName, String newName) throws UnsupportedOperationException
GroupProvider
setName
in interface GroupProvider
oldName
- the current name of the group.newName
- the desired new name of the group.
UnsupportedOperationException
public final void setDescription(String name, String description) throws UnsupportedOperationException
GroupProvider
setDescription
in interface GroupProvider
name
- the group name.description
- the group description.
UnsupportedOperationException
public boolean isSearchSupported()
isSearchSupported
in interface GroupProvider
public Collection<String> search(String query)
search
in interface GroupProvider
query
- the search string for group names.
public Collection<String> search(String query, int startIndex, int numResults)
search
in interface GroupProvider
query
- the search string for group names.startIndex
- start index in results.numResults
- number of results to return.
public Collection<String> search(String key, String value)
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 boolean isSharingSupported()
isSharingSupported
in interface GroupProvider
public Collection<String> getSharedGroupNames()
getSharedGroupNames
in interface GroupProvider
public Collection<String> getSharedGroupNames(org.xmpp.packet.JID user)
getSharedGroupNames
in interface GroupProvider
public Collection<String> getPublicSharedGroupNames()
getPublicSharedGroupNames
in interface GroupProvider
public Collection<String> getVisibleGroupNames(String userGroup)
getVisibleGroupNames
in interface GroupProvider
userGroup
- The given group
public Map<String,String> loadProperties(Group group)
loadProperties
in interface GroupProvider
group
- The target group
|
Openfire 3.8.0 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |