Package org.jivesoftware.openfire.admin

Class GroupBasedAdminProvider

java.lang.Object
org.jivesoftware.openfire.admin.GroupBasedAdminProvider
All Implemented Interfaces:
AdminProvider
public class GroupBasedAdminProvider extends Object implements 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 Details

    • GroupBasedAdminProvider

      public GroupBasedAdminProvider()

  • Method Details

    • getAdmins

      public List<org.xmpp.packet.JID> getAdmins()
      Description copied from interface: AdminProvider
      Returns a list of JIDs of accounts with administrative privileges.
      Specified by:
      getAdmins in interface AdminProvider
      Returns:
      The list of admin users.

    • setAdmins

      public void setAdmins(List<org.xmpp.packet.JID> admins)
      Description copied from interface: AdminProvider
      Sets the list of admin accounts, by JID.
      Specified by:
      setAdmins in interface AdminProvider
      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 interface AdminProvider
      Returns:
      True or false if the admin list can be edited.