Package org.jivesoftware.openfire.admin
Class GroupBasedAdminProvider
java.lang.Object
org.jivesoftware.openfire.admin.GroupBasedAdminProvider
- All Implemented Interfaces:
AdminProvider
Makes the users of specific group Openfire administrators.
To use, set the System Property `provider.admin.className` to the value `org.jivesoftware.openfire.admin.GroupBasedAdminProvider`
The list of Openfire administrators will be taken from the members of the group defined by the System Property `provider.group.groupBasedAdminProvider.groupName` - which defaults to `openfire-administrators`
NOTE: Although the system properties `provider.admin.className` and `provider.group.groupBasedAdminProvider.groupName` are dynamic, a restart may be required as the list of admin users may be cached.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionList<org.xmpp.packet.JID>
Returns a list of JIDs of accounts with administrative privileges.boolean
Indicates whether the admin list is read-only or not.void
Sets the list of admin accounts, by JID.
-
Constructor Details
-
GroupBasedAdminProvider
public GroupBasedAdminProvider()
-
-
Method Details
-
getAdmins
Description copied from interface:AdminProvider
Returns a list of JIDs of accounts with administrative privileges.- Specified by:
getAdmins
in interfaceAdminProvider
- Returns:
- The list of admin users.
-
setAdmins
Description copied from interface:AdminProvider
Sets the list of admin accounts, by JID.- Specified by:
setAdmins
in interfaceAdminProvider
- Parameters:
admins
- List of JIDs of accounts to grant admin access to.
-
isReadOnly
public boolean isReadOnly()Description copied from interface:AdminProvider
Indicates whether the admin list is read-only or not. In other words, whether an admin can change who is an admin from the Openfire admin interface.- Specified by:
isReadOnly
in interfaceAdminProvider
- Returns:
- True or false if the admin list can be edited.
-