Package org.apache.directory.fortress.core.model

Interface Administrator

  • All Known Implementing Classes:
    AdminRole, AdminRoleAnt, UserAdminRole
    public interface Administrator
    This interface is used by Fortress admin role processing. It prescribes the APIs that are necessary for an Administrative Role entity to fullfill the ARBAC functionality.
    Author:
    Apache Directory Project

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getBeginRange()
      Return the begin Role range attribute for AdminRole entity.
      String getEndRange()
      Return the end Role range attribute for AdminRole entity.
      Set<String> getOsPSet()
      Get a collection of optional Perm OU attributes that were stored on the AdminRole entity.
      Set<String> getOsUSet()
      Get a collection of optional User OU attributes that were stored on the AdminRole entity.
      String getRoleRangeRaw()
      Get the raw format for role range using current AdminRole entity attributes.
      boolean isBeginInclusive()
      Set the begin inclusive which specifies if role range includes or excludes the 'beginRange' attribute.
      boolean isEndInclusive()
      Set the end inclusive which specifies if role range includes or excludes the 'endRange' attribute.
      void setBeginInclusive​(boolean beginInclusive)
      Get the begin inclusive which specifies if role range includes or excludes the 'beginRange' attribute.
      void setBeginRange​(String beginRange)
      Set the begin Role range attribute for AdminRole entity.
      void setEndInclusive​(boolean endInclusive)
      Get the end inclusive which specifies if role range includes or excludes the 'endRange' attribute.
      void setEndRange​(String endRange)
      Set the end Role range attribute for AdminRole entity.
      void setOsP​(String osP)
      Set a Perm OU attribute to be stored on the AdminRole entity.
      void setOsPSet​(Set<String> osPs)
      Set a collection of optional Perm OU attributes to be stored on the AdminRole entity.
      void setOsU​(String osU)
      Set a User OU attribute to be stored on the AdminRole entity.
      void setOsUSet​(Set<String> osUs)
      Set a collection of optional User OU attributes to be stored on the AdminRole entity.
      void setRoleRangeRaw​(String szRaw)
      Load the role range attributes given a raw format.

    • Method Detail

      • getOsPSet

        Set<String> getOsPSet()
        Get a collection of optional Perm OU attributes that were stored on the AdminRole entity.
        Returns:
        List of type String containing Perm OU. This maps to 'ftOSP' attribute on 'ftPools' aux object class.

      • setOsPSet

        void setOsPSet​(Set<String> osPs)
        Set a collection of optional Perm OU attributes to be stored on the AdminRole entity.
        Parameters:
        osPs - is a List of type String containing Perm OU. This maps to 'ftOSP' attribute on 'ftPools' aux object class.

      • setOsP

        void setOsP​(String osP)
        Set a Perm OU attribute to be stored on the AdminRole entity.
        Parameters:
        osP - is a Perm OU that maps to 'ftOSP' attribute on 'ftPools' aux object class.

      • getOsUSet

        Set<String> getOsUSet()
        Get a collection of optional User OU attributes that were stored on the AdminRole entity.
        Returns:
        List of type String containing User OU. This maps to 'ftOSU' attribute on 'ftPools' aux object class.

      • setOsUSet

        void setOsUSet​(Set<String> osUs)
        Set a collection of optional User OU attributes to be stored on the AdminRole entity.
        Parameters:
        osUs - is a List of type String containing User OU. This maps to 'ftOSU' attribute on 'ftPools' aux object class.

      • setOsU

        void setOsU​(String osU)
        Set a User OU attribute to be stored on the AdminRole entity.
        Parameters:
        osU - is a User OU that maps to 'ftOSU' attribute on 'ftPools' aux object class.

      • setRoleRangeRaw

        void setRoleRangeRaw​(String szRaw)
        Load the role range attributes given a raw format. This method is used internal to Fortress and is not intended to be used by external callers.
        Parameters:
        szRaw - maps to 'ftRange' attribute on 'ftPools' aux object class.

      • getRoleRangeRaw

        String getRoleRangeRaw()
        Get the raw format for role range using current AdminRole entity attributes. This method is used internal to Fortress and is not intended to be used by external callers.
        Returns:
        String maps to 'ftRange' attribute on 'ftPools' aux object class.

      • getBeginRange

        String getBeginRange()
        Return the begin Role range attribute for AdminRole entity.
        Returns:
        String that maps to 'ftRange' attribute on 'ftPools' aux object class.

      • setBeginRange

        void setBeginRange​(String beginRange)
        Set the begin Role range attribute for AdminRole entity.
        Parameters:
        beginRange - maps to 'ftRange' attribute on 'ftPools' aux object class.

      • getEndRange

        String getEndRange()
        Return the end Role range attribute for AdminRole entity.
        Returns:
        String that maps to 'ftRange' attribute on 'ftPools' aux object class.

      • setEndRange

        void setEndRange​(String endRange)
        Set the end Role range attribute for AdminRole entity.
        Parameters:
        endRange - maps to 'ftRange' attribute on 'ftPools' aux object class.

      • isBeginInclusive

        boolean isBeginInclusive()
        Set the begin inclusive which specifies if role range includes or excludes the 'beginRange' attribute.
        Returns:
        String that maps to 'ftRange' attribute on 'ftPools' aux object class.

      • setBeginInclusive

        void setBeginInclusive​(boolean beginInclusive)
        Get the begin inclusive which specifies if role range includes or excludes the 'beginRange' attribute.
        Parameters:
        beginInclusive - maps to 'ftRange' attribute on 'ftPools' aux object class.

      • isEndInclusive

        boolean isEndInclusive()
        Set the end inclusive which specifies if role range includes or excludes the 'endRange' attribute.
        Returns:
        String that maps to 'ftRange' attribute on 'ftPools' aux object class.

      • setEndInclusive

        void setEndInclusive​(boolean endInclusive)
        Get the end inclusive which specifies if role range includes or excludes the 'endRange' attribute.
        Parameters:
        endInclusive - maps to 'ftRange' attribute on 'ftPools' aux object class.