Interface IAuthorizationAlgorithmDS

  • All Known Implementing Classes:
    XmlAuthorizationAlgorithmDS

    public interface IAuthorizationAlgorithmDS
    This interface represents the data of an authorization algorithm.
    Since:
    9.1
    Author:
    A.Pragt
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getName()
      This method returns the name of the algorithm.
      String getRestrictedUserIds()
      This method returns an expression containing the restricted user identifiers or the null value.
      String[] getRoles()
      This method should return the authorization roles in case of a non-external algorithm.
      boolean isExternal()
      This method returns an indicator whether the algorithm should use an external implementation.
    • Method Detail

      • getName

        String getName()
        This method returns the name of the algorithm.
        Returns:
        The name of the algorithm, never null.
      • isExternal

        boolean isExternal()
        This method returns an indicator whether the algorithm should use an external implementation.
        Returns:
        Boolean whether the algorithm should use an external implementation.
      • getRestrictedUserIds

        String getRestrictedUserIds()
        This method returns an expression containing the restricted user identifiers or the null value.
        Returns:
        The expression to be evaluated or null.
      • getRoles

        String[] getRoles()
        This method should return the authorization roles in case of a non-external algorithm. Otherwise this method should return null.
        Returns:
        The authorization roles or null.