Package org.apache.shiro.authz

Interface Authorizer

    • Method Detail

      • isPermitted

        boolean isPermitted​(PrincipalCollection principals,
                     permission)
        Returns true if the corresponding subject/user is permitted to perform an action or access a resource summarized by the specified permission string.

        This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.

        Parameters:
        principals - the application-specific subject/user identifier.
        permission - the String representation of a Permission that is being checked.
        Returns:
        true if the corresponding Subject/user is permitted, false otherwise.
        Since:
        0.9
        See Also:
        isPermitted(PrincipalCollection principals,Permission permission)

      • isPermitted

        boolean isPermitted​(PrincipalCollection subjectPrincipal,
                    Permission permission)
        Returns true if the corresponding subject/user is permitted to perform an action or access a resource summarized by the specified permission.

        More specifically, this method determines if any Permissions associated with the subject imply the specified permission.

        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        permission - the permission that is being checked.
        Returns:
        true if the corresponding Subject/user is permitted, false otherwise.

      • isPermitted

        boolean[] isPermitted​(PrincipalCollection subjectPrincipal,
                      ... permissions)
        Checks if the corresponding Subject implies the given permission strings and returns a boolean array indicating which permissions are implied.

        This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.

        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        permissions - the String representations of the Permissions that are being checked.
        Returns:
        an array of booleans whose indices correspond to the index of the permissions in the given list. A true value at an index indicates the user is permitted for for the associated Permission string in the list. A false value at an index indicates otherwise.
        Since:
        0.9

      • isPermitted

        boolean[] isPermitted​(PrincipalCollection subjectPrincipal,
                      <Permission> permissions)
        Checks if the corresponding Subject/user implies the given Permissions and returns a boolean array indicating which permissions are implied.

        More specifically, this method should determine if each Permission in the array is implied by permissions already associated with the subject.

        This is primarily a performance-enhancing method to help reduce the number of isPermitted(org.apache.shiro.subject.PrincipalCollection, java.lang.String) invocations over the wire in client/server systems.

        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        permissions - the permissions that are being checked.
        Returns:
        an array of booleans whose indices correspond to the index of the permissions in the given list. A true value at an index indicates the user is permitted for for the associated Permission object in the list. A false value at an index indicates otherwise.

      • isPermittedAll

        boolean isPermittedAll​(PrincipalCollection subjectPrincipal,
                       ... permissions)
        Returns true if the corresponding Subject/user implies all of the specified permission strings, false otherwise.

        This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.

        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        permissions - the String representations of the Permissions that are being checked.
        Returns:
        true if the user has all of the specified permissions, false otherwise.
        Since:
        0.9
        See Also:
        isPermittedAll(PrincipalCollection,Collection)

      • isPermittedAll

        boolean isPermittedAll​(PrincipalCollection subjectPrincipal,
                       <Permission> permissions)
        Returns true if the corresponding Subject/user implies all of the specified permissions, false otherwise.

        More specifically, this method determines if all of the given Permissions are implied by permissions already associated with the subject.

        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        permissions - the permissions to check.
        Returns:
        true if the user has all of the specified permissions, false otherwise.

      • checkPermission

        void checkPermission​(PrincipalCollection subjectPrincipal,
                      permission)
              throws AuthorizationException
        Ensures the corresponding Subject/user implies the specified permission String.

        If the subject's existing associated permissions do not Permission.implies(Permission) imply} the given permission, an AuthorizationException will be thrown.

        This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.

        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        permission - the String representation of the Permission to check.
        Throws:
        AuthorizationException - if the user does not have the permission.
        Since:
        0.9

      • checkPermissions

        void checkPermissions​(PrincipalCollection subjectPrincipal,
                      ... permissions)
               throws AuthorizationException
        Ensures the corresponding Subject/user implies all of the specified permission strings. If the subject's existing associated permissions do not imply all of the given permissions, an AuthorizationException will be thrown.

        This is an overloaded method for the corresponding type-safe Permission variant. Please see the class-level JavaDoc for more information on these String-based permission methods.

        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        permissions - the string representations of Permissions to check.
        Throws:
        AuthorizationException - if the user does not have all of the given permissions.
        Since:
        0.9

      • checkPermissions

        void checkPermissions​(PrincipalCollection subjectPrincipal,
                      <Permission> permissions)
               throws AuthorizationException
        Ensures the corresponding Subject/user implies all of the specified permission strings. If the subject's existing associated permissions do not imply all of the given permissions, an AuthorizationException will be thrown.
        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        permissions - the Permissions to check.
        Throws:
        AuthorizationException - if the user does not have all of the given permissions.

      • hasRole

        boolean hasRole​(PrincipalCollection subjectPrincipal,
                 roleIdentifier)
        Returns true if the corresponding Subject/user has the specified role, false otherwise.
        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        roleIdentifier - the application-specific role identifier (usually a role id or role name).
        Returns:
        true if the corresponding subject has the specified role, false otherwise.

      • hasRoles

        boolean[] hasRoles​(PrincipalCollection subjectPrincipal,
                   <> roleIdentifiers)
        Checks if the corresponding Subject/user has the specified roles, returning a boolean array indicating which roles are associated with the given subject.

        This is primarily a performance-enhancing method to help reduce the number of hasRole(org.apache.shiro.subject.PrincipalCollection, java.lang.String) invocations over the wire in client/server systems.

        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        roleIdentifiers - the application-specific role identifiers to check (usually role ids or role names).
        Returns:
        an array of booleans whose indices correspond to the index of the roles in the given identifiers. A true value indicates the user has the role at that index. False indicates the user does not have the role at that index.

      • hasAllRoles

        boolean hasAllRoles​(PrincipalCollection subjectPrincipal,
                    <> roleIdentifiers)
        Returns true if the corresponding Subject/user has all of the specified roles, false otherwise.
        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        roleIdentifiers - the application-specific role identifiers to check (usually role ids or role names).
        Returns:
        true if the user has all the roles, false otherwise.

      • checkRole

        void checkRole​(PrincipalCollection subjectPrincipal,
                roleIdentifier)
        throws AuthorizationException
        Asserts the corresponding Subject/user has the specified role by returning quietly if they do or throwing an AuthorizationException if they do not.
        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        roleIdentifier - the application-specific role identifier (usually a role id or role name ).
        Throws:
        AuthorizationException - if the user does not have the role.

      • checkRoles

        void checkRoles​(PrincipalCollection subjectPrincipal,
                <> roleIdentifiers)
         throws AuthorizationException
        Asserts the corresponding Subject/user has all of the specified roles by returning quietly if they do or throwing an AuthorizationException if they do not.
        Parameters:
        subjectPrincipal - the application-specific subject/user identifier.
        roleIdentifiers - the application-specific role identifiers to check (usually role ids or role names).
        Throws:
        AuthorizationException - if the user does not have all of the specified roles.