Package de.digitalcollections.iiif.model.auth

Enum AuthPattern

  • All Implemented Interfaces:
    Serializable, Comparable<AuthPattern>
    public enum AuthPattern
extends Enum<AuthPattern>
    There are four interaction patterns by which the client can obtain an access cookie, each identified by a profile URI.

    See http://iiif.io/api/auth/1.0/#service-description

    • Enum Constant Detail

      • LOGIN

        public static final AuthPattern LOGIN
        The user will be required to log in using a separate window with a UI provided by an external authentication system.

        See http://iiif.io/api/auth/1.0/#login-interaction-pattern

      • CLICKTHROUGH

        public static final AuthPattern CLICKTHROUGH
        The user will be required to click a button within the client using content provided in the service description.

        See http://iiif.io/api/auth/1.0/#clickthrough-interaction-pattern

      • KIOSK

        public static final AuthPattern KIOSK
        The user will not be required to interact with an authentication system, the client is expected to use the access cookie service automatically.

        See http://iiif.io/api/auth/1.0/#kiosk-interaction-pattern

      • EXTERNAL

        public static final AuthPattern EXTERNAL
        The user is expected to have already acquired the appropriate cookie, and the access cookie service will not be used at all.

        See http://iiif.io/api/auth/1.0/#external-interaction-pattern

    • Method Detail

      • values

        public static AuthPattern[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (AuthPattern c : AuthPattern.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AuthPattern valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getUri

        public URI getUri()