Package org.xwiki.security.authorization

Interface RightDescription

  • All Known Implementing Classes:
    Right
    public interface RightDescription
    Describe a Right, allow adding new Rights, also implemented by the Right class.
    Since:
    4.0M2
    Version:
    $Id: 2eedcbcae4d319a58306645aca9ad359dd944e23 $

    • Method Detail

      • getName

        String getName()
        Returns:
        The string representation of this right.

      • getTieResolutionPolicy

        RuleState getTieResolutionPolicy()
        Returns:
        Whether this right should be allowed or denied in case of a tie.

      • getInheritanceOverridePolicy

        boolean getInheritanceOverridePolicy()
        Returns:
        Policy on how this right should be overridden by lower levels in the entity reference hierarchy. When true, this right on a document override this right on a wiki.

      • getImpliedRights

        Set<Right> getImpliedRights()
        Returns:
        a set of additional rights implied by this right. Note that this method should return null instead of an empty set.

      • getTargetedEntityType

        Set<EntityType> getTargetedEntityType()
        Returns:
        a set of entity type for which this right should be enabled. Special type Right.FARM (==null) could be used to target the EntityType.WIKI for the main wiki only (i.e. PROGRAM)

      • isReadOnly

        boolean isReadOnly()
        Used to check if this right should be allowed when the wiki is in read-only mode. From the native right, only EDIT, DELETE, COMMENT and REGISTER returns false.
        Returns:
        true if this right allow a read-only access to the wiki.