Enum CoreTokenField

  • All Implemented Interfaces:
    Serializable, Comparable<CoreTokenField>

    public enum CoreTokenField
    extends Enum<CoreTokenField>
    CoreTokenField contains a mapping from the Java enumeration and the defined attributes present in the LDAP Schema for the Core Token Service. Note: These enumerations are backed by LDAP attributes and as such are the only attributes available to populate for any Token that is to be stored. Other enumerations may exist for the convenience of development, however they must link to these enumerated values. org.forgerock.openam.cts.api.fields.SAMLTokenField org.forgerock.openam.cts.api.fields.OAuthTokenField
    • Enum Constant Detail

      • USER_ID

        public static final CoreTokenField USER_ID
        Token User Id field name.
      • TOKEN_TYPE

        public static final CoreTokenField TOKEN_TYPE
        Token type field name.
      • TOKEN_ID

        public static final CoreTokenField TOKEN_ID
        Token Id field name.
      • EXPIRY_DATE

        public static final CoreTokenField EXPIRY_DATE
        Token expiry date field name.
      • TTL_DATE

        public static final CoreTokenField TTL_DATE
        Token expiry date field name.
      • BLOB

        public static final CoreTokenField BLOB
        Token blob field name.
      • CREATE_TIMESTAMP

        public static final CoreTokenField CREATE_TIMESTAMP
        Token creation timestamp field.
      • STRING_ONE

        public static final CoreTokenField STRING_ONE
        Generic token string one field name.
      • STRING_TWO

        public static final CoreTokenField STRING_TWO
        Generic token string two field name.
      • STRING_THREE

        public static final CoreTokenField STRING_THREE
        Generic token string three field name.
      • STRING_FOUR

        public static final CoreTokenField STRING_FOUR
        Generic token string four field name.
      • STRING_FIVE

        public static final CoreTokenField STRING_FIVE
        Generic token string five field name.
      • STRING_SIX

        public static final CoreTokenField STRING_SIX
        Generic token string six field name.
      • STRING_SEVEN

        public static final CoreTokenField STRING_SEVEN
        Generic token string seven field name.
      • STRING_EIGHT

        public static final CoreTokenField STRING_EIGHT
        Generic token string eight field name.
      • STRING_NINE

        public static final CoreTokenField STRING_NINE
        Generic token string nine field name.
      • STRING_TEN

        public static final CoreTokenField STRING_TEN
        Generic token string ten field name.
      • STRING_ELEVEN

        public static final CoreTokenField STRING_ELEVEN
        Generic token string eleven field name.
      • STRING_TWELVE

        public static final CoreTokenField STRING_TWELVE
        Generic token string twelve field name.
      • STRING_THIRTEEN

        public static final CoreTokenField STRING_THIRTEEN
        Generic token string thirteen field name.
      • STRING_FOURTEEN

        public static final CoreTokenField STRING_FOURTEEN
        Generic token string fourteen field name.
      • STRING_FIFTEEN

        public static final CoreTokenField STRING_FIFTEEN
        Generic token string fifteen field name.
      • INTEGER_ONE

        public static final CoreTokenField INTEGER_ONE
        Generic token integer one field name.
      • INTEGER_TWO

        public static final CoreTokenField INTEGER_TWO
        Generic token integer two field name.
      • INTEGER_THREE

        public static final CoreTokenField INTEGER_THREE
        Generic token integer three field name.
      • INTEGER_FOUR

        public static final CoreTokenField INTEGER_FOUR
        Generic token integer four field name.
      • INTEGER_FIVE

        public static final CoreTokenField INTEGER_FIVE
        Generic token integer five field name.
      • INTEGER_SIX

        public static final CoreTokenField INTEGER_SIX
        Generic token integer six field name.
      • INTEGER_SEVEN

        public static final CoreTokenField INTEGER_SEVEN
        Generic token integer seven field name.
      • INTEGER_EIGHT

        public static final CoreTokenField INTEGER_EIGHT
        Generic token integer eight field name.
      • INTEGER_NINE

        public static final CoreTokenField INTEGER_NINE
        Generic token integer nine field name.
      • INTEGER_TEN

        public static final CoreTokenField INTEGER_TEN
        Generic token integer ten field name.
      • DATE_ONE

        public static final CoreTokenField DATE_ONE
        Generic token date one field name.
      • DATE_TWO

        public static final CoreTokenField DATE_TWO
        Generic token date two field name.
      • DATE_THREE

        public static final CoreTokenField DATE_THREE
        Generic token date three field name.
      • DATE_FOUR

        public static final CoreTokenField DATE_FOUR
        Generic token date four field name.
      • DATE_FIVE

        public static final CoreTokenField DATE_FIVE
        Generic token date five field name.
      • MULTI_STRING_ONE

        public static final CoreTokenField MULTI_STRING_ONE
        Generic token multi value String one field name.
      • MULTI_STRING_TWO

        public static final CoreTokenField MULTI_STRING_TWO
        Generic token multi value String two field name.
      • MULTI_STRING_THREE

        public static final CoreTokenField MULTI_STRING_THREE
        Generic token multi value String three field name.
    • Method Detail

      • values

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

        public static CoreTokenField 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
      • getAttributeType

        public Class<?> getAttributeType()
        Gets the core token field attribute type.
        Returns:
        The attribute type.
      • fromLDAPAttribute

        public static CoreTokenField fromLDAPAttribute​(String value)
        Convert the field name into a CoreTokenField enumeration. This is the reverse of calling toString on this enum.
        Parameters:
        value - The String representation of a CoreTokenField.
        Returns:
        Non null CoreTokenField if the String provided matches a CoreTokenField.
        Throws:
        IllegalArgumentException - If the value provided did not match a CoreTokenField.
      • toString

        public String toString()
        Convert the enumeration into its LDAP attribute representation.
        Overrides:
        toString in class Enum<CoreTokenField>
        Returns:
        The name of the LDAP Attribute.