com.tietoenator.trip.jxp.session

## Enum TdbApiKeyMode

- java.lang.Object
- - java.lang.Enum<TdbApiKeyMode>
  - - com.tietoenator.trip.jxp.session.TdbApiKeyMode

- All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TdbApiKeyMode>

      public enum TdbApiKeyMode
      extends java.lang.Enum<TdbApiKeyMode>

  The API key operational mode that the connected TRIPsystem server is configured to use.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `Always` An API key is required for the creation and refresh of tokens as well as for token based login.
    `No` API keys are not required.
    `Refresh` An API key is only required for the refresh of a token pair.
    `Tokens` An API key is required for the creation and refresh of tokens, but not for token based login.

  - ### Method Summary

    All Methods Static Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static TdbApiKeyMode` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static TdbApiKeyMode[]` | `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

    - #### Always

          public static final TdbApiKeyMode Always

      An API key is required for the creation and refresh of tokens as well as for token based login.

    - #### Tokens

          public static final TdbApiKeyMode Tokens

      An API key is required for the creation and refresh of tokens, but not for token based login.

    - #### Refresh

          public static final TdbApiKeyMode Refresh

      An API key is only required for the refresh of a token pair.

    - #### No

          public static final TdbApiKeyMode No

      API keys are not required.

  - ### Method Detail

    - #### values

          public static TdbApiKeyMode[] 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 (TdbApiKeyMode c : TdbApiKeyMode.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

          public static TdbApiKeyMode 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