com.ibm.jarm.api.security

Interface RMPermission



  • public interface RMPermission
    A RMPermission instance represents an access control entry (ACE) associated with a repository object that grants or denies specific access rights to a particular user or group.
    • Method Detail

      • setAccessType

        void setAccessType(RMAccessType accessType)
        Defines the RMAccessType value that determines whether this an an "allow" or "deny" RMPermisson.
        Parameters:
        accessType - an RMAccessType value. This entry cannot be null.
      • setAccessMask

        void setAccessMask(int accessMask)
        Defines the specific rights either allowed or denied by this RMPermission instance. This method allows a more customized access mask definition than do the other two setAccessMask methods.
        Parameters:
        accessMask - an integer whose bit positions represent differing access rights.
      • setAccessMask

        void setAccessMask(RMAccessLevel accessLevel)
        Defines the specific rights either allowed or denied by this RMPermission instance. This is a convenience alternative version of setAccessMask(int) that supports use of RMAccessLevel enumeration members directly.
        Parameters:
        accessLevel - a member of the RMAccessLevel enumeration. This entry cannot be null.
      • setAccessMask

        void setAccessMask(RMAccessRight... accessRights)
        Defines the specific rights either allowed or denied by this RMPermission instance. This is an alternative version of setAccessMask(int) that supports use of a variable number of RMAccessRight enumeration members that are combined to form the actual access bit mask.
        Parameters:
        accessRights - one or more RMAccessRight enumeration member arguments. This entry cannot be null.
      • getAccessMask

        int getAccessMask()
        Returns the integer bit mask defining the rights associated with this RMPermission.
        Returns:
        An integer value.
      • setGranteeName

        void setGranteeName(java.lang.String granteeName)
        Defines the name of the user or group that this RMPermission applies to.
        Parameters:
        granteeName - the String name of the grantee. This entry cannot be null.
      • getGranteeName

        java.lang.String getGranteeName()
        Returns the name of the user or group to which this RMPermission applies.
        Returns:
        A String value.
      • setInheritableDepth

        void setInheritableDepth(java.lang.Integer inheritableDepth)
        Defines the inheritable depth level for this RMPermission. Example values:
        • 0 - No inheritance
        • 1 - Immediate children only
        • -1 - All descendant children (all levels deep)
        Parameters:
        inheritableDepth - an Integer value. This entry can be null.
      • getInheritableDepth

        java.lang.Integer getInheritableDepth()
        Returns the inheritable depth level for this RMPermission.
        Returns:
        An Integer value. This entry can be null.
      • getAuthenticatedUsersDesignation

        java.lang.String getAuthenticatedUsersDesignation()
        If supported by a particular domain type, returns the special logical group name that refers to all authenticated users.
        Returns:
        A String value or null if not supported by domain.
      • getCreatorOwnerNameDesignation

        java.lang.String getCreatorOwnerNameDesignation()
        If supported by a particular domain type, returns the principal name that refers to the user who initially creates a repository object.
        Returns:
        A String value or null if not supported by domain.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.