Interface UserAdminMBean


  • public interface UserAdminMBean
    This MBean provides the management interface to the OSGi User Manager Service
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void addCredential​(java.lang.String key, byte[] value, java.lang.String username)
      Add credentials to a user, associated with the supplied key
      void addCredentialString​(java.lang.String key, java.lang.String value, java.lang.String username)
      Add credentials to a user, associated with the supplied key
      boolean addMember​(java.lang.String groupname, java.lang.String rolename)
      Add a member to the group.
      void addProperty​(java.lang.String key, byte[] value, java.lang.String rolename)
      Add or update a property on a role.
      void addPropertyString​(java.lang.String key, java.lang.String value, java.lang.String rolename)
      Add or update a property on a role
      boolean addRequiredMember​(java.lang.String groupname, java.lang.String rolename)
      Add a required member to the group
      void createGroup​(java.lang.String name)
      Create a Group
      void createRole​(java.lang.String name)
      Deprecated.
      This method was specified in error.
      void createUser​(java.lang.String name)
      Create a User
      javax.management.openmbean.CompositeData getAuthorization​(java.lang.String user)
      Answer the authorization for the user name.
      javax.management.openmbean.TabularData getCredentials​(java.lang.String username)
      Answer the credentials associated with a user.
      javax.management.openmbean.CompositeData getGroup​(java.lang.String groupname)
      Answer the Group associated with the group name.
      java.lang.String[] getGroups​(java.lang.String filter)
      Answer the list of group names
      java.lang.String[] getImpliedRoles​(java.lang.String username)
      Answer the list of implied roles for a user
      java.lang.String[] getMembers​(java.lang.String groupname)
      Answer the the user names which are members of the group
      javax.management.openmbean.TabularData getProperties​(java.lang.String rolename)
      Answer the properties associated with a role.
      java.lang.String[] getRequiredMembers​(java.lang.String groupname)
      Answer the list of user names which are required members of this group
      javax.management.openmbean.CompositeData getRole​(java.lang.String name)
      Answer the role associated with a name.
      java.lang.String[] getRoles​(java.lang.String filter)
      Answer the list of role names which match the supplied filter
      javax.management.openmbean.CompositeData getUser​(java.lang.String username)
      Answer the User associated with the user name.
      java.lang.String[] getUsers​(java.lang.String filter)
      Answer the list of user names in the User Admin database
      java.lang.String getUserWithProperty​(java.lang.String key, java.lang.String value)
      Answer the user name with the given property key-value pair from the User Admin service database.
      java.lang.String[] listGroups()
      Answer the list of group names
      java.lang.String[] listRoles()
      Answer the list of role names in the User Admin database
      java.lang.String[] listUsers()
      Answer the list of user names in the User Admin database
      void removeCredential​(java.lang.String key, java.lang.String username)
      Remove the credential associated with the given user
      boolean removeGroup​(java.lang.String name)
      Remove the Group associated with the name
      boolean removeMember​(java.lang.String groupname, java.lang.String rolename)
      Remove a role from the group
      void removeProperty​(java.lang.String key, java.lang.String rolename)
      Remove a property from a role
      boolean removeRole​(java.lang.String name)
      Remove the Role associated with the name
      boolean removeUser​(java.lang.String name)
      Remove the User associated with the name
    • Method Detail

      • addCredential

        void addCredential​(java.lang.String key,
                           byte[] value,
                           java.lang.String username)
                    throws java.io.IOException
        Add credentials to a user, associated with the supplied key
        Parameters:
        key - The key of the credential to add
        value - The value of the credential to add
        username - The name of the user that gets the credential.
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the username is not a User
      • addCredentialString

        void addCredentialString​(java.lang.String key,
                                 java.lang.String value,
                                 java.lang.String username)
                          throws java.io.IOException
        Add credentials to a user, associated with the supplied key
        Parameters:
        key - The key of the credential to add
        value - The value of the credential to add
        username - The name of the user that gets the credential.
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the username is not a User
      • addMember

        boolean addMember​(java.lang.String groupname,
                          java.lang.String rolename)
                   throws java.io.IOException
        Add a member to the group.
        Parameters:
        groupname - The group name that receives the rolename as member.
        rolename - The rolename (User or Group) that must be added.
        Returns:
        true if the role was added to the group
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if an invalid group name or role name is specified
      • addPropertyString

        void addPropertyString​(java.lang.String key,
                               java.lang.String value,
                               java.lang.String rolename)
                        throws java.io.IOException
        Add or update a property on a role
        Parameters:
        key - The key of the property to add
        value - The value of the property to add (String)
        rolename - The role name
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if an invalid role name is specified
      • addProperty

        void addProperty​(java.lang.String key,
                         byte[] value,
                         java.lang.String rolename)
                  throws java.io.IOException
        Add or update a property on a role.
        Parameters:
        key - The added property key
        value - The added byte[] property value
        rolename - The role name that receives the property
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if an invalid role name is specified
      • addRequiredMember

        boolean addRequiredMember​(java.lang.String groupname,
                                  java.lang.String rolename)
                           throws java.io.IOException
        Add a required member to the group
        Parameters:
        groupname - The group name that is addded
        rolename - The role that
        Returns:
        true if the role was added to the group
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if an invalid group name or role name is specified
      • createUser

        void createUser​(java.lang.String name)
                 throws java.io.IOException
        Create a User
        Parameters:
        name - Name of the user to create
        Throws:
        java.io.IOException - if the operation fails
      • createGroup

        void createGroup​(java.lang.String name)
                  throws java.io.IOException
        Create a Group
        Parameters:
        name - Name of the group to create
        Throws:
        java.io.IOException - if the operation fails
      • createRole

        void createRole​(java.lang.String name)
                 throws java.io.IOException
        Deprecated.
        This method was specified in error. It does not function and must not be used. Use either createUser(String) or createGroup(String).
        This method was specified in error and must not be used.
        Parameters:
        name - Ignored.
        Throws:
        java.io.IOException - This method will throw an exception if called.
      • getAuthorization

        javax.management.openmbean.CompositeData getAuthorization​(java.lang.String user)
                                                           throws java.io.IOException
        Answer the authorization for the user name. The Composite Data is typed by AUTORIZATION_TYPE.
        Parameters:
        user - The user name
        Returns:
        the Authorization typed by AUTORIZATION_TYPE.
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the user name is not a User
      • getCredentials

        javax.management.openmbean.TabularData getCredentials​(java.lang.String username)
                                                       throws java.io.IOException
        Answer the credentials associated with a user. The returned Tabular Data is typed by JmxConstants.PROPERTIES_TYPE.
        Parameters:
        username - The user name
        Returns:
        the credentials associated with the user, see JmxConstants.PROPERTIES_TYPE
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the user name is not a User
      • getGroup

        javax.management.openmbean.CompositeData getGroup​(java.lang.String groupname)
                                                   throws java.io.IOException
        Answer the Group associated with the group name. The returned Composite Data is typed by GROUP_TYPE
        Parameters:
        groupname - The group name
        Returns:
        the Group, see GROUP_TYPE
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the group name is not a Group
      • listGroups

        java.lang.String[] listGroups()
                               throws java.io.IOException
        Answer the list of group names
        Returns:
        The list of group names
        Throws:
        java.io.IOException - if the operation fails
      • getGroups

        java.lang.String[] getGroups​(java.lang.String filter)
                              throws java.io.IOException
        Answer the list of group names
        Parameters:
        filter - The filter to apply
        Returns:
        The list of group names
        Throws:
        java.io.IOException - if the operation fails
      • getImpliedRoles

        java.lang.String[] getImpliedRoles​(java.lang.String username)
                                    throws java.io.IOException
        Answer the list of implied roles for a user
        Parameters:
        username - The name of the user that has the implied roles
        Returns:
        The list of role names
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the username is not a User
      • getMembers

        java.lang.String[] getMembers​(java.lang.String groupname)
                               throws java.io.IOException
        Answer the the user names which are members of the group
        Parameters:
        groupname - The name of the group to get the members from
        Returns:
        The list of user names
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the groupname is not a Group
      • getProperties

        javax.management.openmbean.TabularData getProperties​(java.lang.String rolename)
                                                      throws java.io.IOException
        Answer the properties associated with a role. The returned Tabular Data is typed by JmxConstants.PROPERTIES_TYPE.
        Parameters:
        rolename - The name of the role to get properties from
        Returns:
        the properties associated with the role, see JmxConstants.PROPERTIES_TYPE
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the rolename is not a role
      • getRequiredMembers

        java.lang.String[] getRequiredMembers​(java.lang.String groupname)
                                       throws java.io.IOException
        Answer the list of user names which are required members of this group
        Parameters:
        groupname - The name of the group to get the required members from
        Returns:
        The list of user names
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the group name is not a Group
      • getRole

        javax.management.openmbean.CompositeData getRole​(java.lang.String name)
                                                  throws java.io.IOException
        Answer the role associated with a name. The returned Composite Data is typed by ROLE_TYPE.
        Parameters:
        name - The name of the role to get the data from
        Returns:
        the Role, see ROLE_TYPE
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the name is not a role
      • listRoles

        java.lang.String[] listRoles()
                              throws java.io.IOException
        Answer the list of role names in the User Admin database
        Returns:
        The list of role names
        Throws:
        java.io.IOException - if the operation fails
      • getRoles

        java.lang.String[] getRoles​(java.lang.String filter)
                             throws java.io.IOException
        Answer the list of role names which match the supplied filter
        Parameters:
        filter - The string representation of the org.osgi.framework.Filter that is used to filter the roles by applying to the properties, if null all roles are returned.
        Returns:
        The list the role names
        Throws:
        java.io.IOException - if the operation fails
      • getUser

        javax.management.openmbean.CompositeData getUser​(java.lang.String username)
                                                  throws java.io.IOException
        Answer the User associated with the user name. The returned Composite Data is typed by USER_TYPE.
        Parameters:
        username - The name of the requested user
        Returns:
        The User, see USER_TYPE
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the username is not a User
      • getUserWithProperty

        java.lang.String getUserWithProperty​(java.lang.String key,
                                             java.lang.String value)
                                      throws java.io.IOException
        Answer the user name with the given property key-value pair from the User Admin service database.
        Parameters:
        key - The key to compare
        value - The value to compare
        Returns:
        The User
        Throws:
        java.io.IOException - if the operation fails
      • listUsers

        java.lang.String[] listUsers()
                              throws java.io.IOException
        Answer the list of user names in the User Admin database
        Returns:
        The list of user names
        Throws:
        java.io.IOException - if the operation fails
      • getUsers

        java.lang.String[] getUsers​(java.lang.String filter)
                             throws java.io.IOException
        Answer the list of user names in the User Admin database
        Parameters:
        filter - The filter to apply
        Returns:
        The list of user names
        Throws:
        java.io.IOException - if the operation fails
      • removeCredential

        void removeCredential​(java.lang.String key,
                              java.lang.String username)
                       throws java.io.IOException
        Remove the credential associated with the given user
        Parameters:
        key - The key of the credential to remove
        username - The name of the user for which the credential must be removed
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the username is not a User
      • removeMember

        boolean removeMember​(java.lang.String groupname,
                             java.lang.String rolename)
                      throws java.io.IOException
        Remove a role from the group
        Parameters:
        groupname - The group name
        rolename -
        Returns:
        true if the role was removed from the group
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the groupname is not a Group
      • removeProperty

        void removeProperty​(java.lang.String key,
                            java.lang.String rolename)
                     throws java.io.IOException
        Remove a property from a role
        Parameters:
        key -
        rolename -
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the rolename is not a role
      • removeRole

        boolean removeRole​(java.lang.String name)
                    throws java.io.IOException
        Remove the Role associated with the name
        Parameters:
        name -
        Returns:
        true if the remove succeeded
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the name is not a role
      • removeGroup

        boolean removeGroup​(java.lang.String name)
                     throws java.io.IOException
        Remove the Group associated with the name
        Parameters:
        name -
        Returns:
        true if the remove succeeded
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the name is not a Group
      • removeUser

        boolean removeUser​(java.lang.String name)
                    throws java.io.IOException
        Remove the User associated with the name
        Parameters:
        name -
        Returns:
        true if the remove succeeded
        Throws:
        java.io.IOException - if the operation fails
        java.lang.IllegalArgumentException - if the name is not a User