Package com.ibm.security.access.extension.authn

Enum Scope

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Scope>
    public enum Scope
extends java.lang.Enum<Scope>
    This enum represents scope of context attribute. There are two possible scopes: REQUEST and SESSION. Context attribute stored in REQUEST scope exists only in the current user interaction. Context attribute stored in SESSION scope exists across user interactions.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      REQUEST  
      SESSION  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Scope valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Scope[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • REQUEST

        public static final Scope REQUEST

      • SESSION

        public static final Scope SESSION

    • Method Detail

      • values

        public static Scope[] 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 (Scope c : Scope.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Scope valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null