com.ansys.ingress.client.api

## Enum ConnectionFactory.TokenUserType

- java.lang.Object
- - java.lang.Enum<ConnectionFactory.TokenUserType>
  - - com.ansys.ingress.client.api.ConnectionFactory.TokenUserType

- All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ConnectionFactory.TokenUserType>
  Enclosing class:
    ConnectionFactory

      public static enum ConnectionFactory.TokenUserType
      extends java.lang.Enum<ConnectionFactory.TokenUserType>

  TokenUserType defines the user types that can login to EKM using a special token.

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `CACHE_USER` CACHE_USER indicates the token being provided is from an EKM cache server.
    `DATALINK_USER` DATALINK_USER indicates the token being provided is from a Datalink application.
    `NORMAL_USER` NORMAL_USER indicates the token being provided is from a normal user.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static ConnectionFactory.TokenUserType` | `fromString(java.lang.String tokenType)` Gets a TokenUserType value based on the given string.
    `int` | `toInt()`
    `static ConnectionFactory.TokenUserType` | `valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
    `static ConnectionFactory.TokenUserType[]` | `values()` Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods inherited from class java.lang.Enum

      `clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### NORMAL_USER

          public static final ConnectionFactory.TokenUserType NORMAL_USER

      NORMAL_USER indicates the token being provided is from a normal user.

    - #### CACHE_USER

          public static final ConnectionFactory.TokenUserType CACHE_USER

      CACHE_USER indicates the token being provided is from an EKM cache server.

    - #### DATALINK_USER

          public static final ConnectionFactory.TokenUserType DATALINK_USER

      DATALINK_USER indicates the token being provided is from a Datalink application.

  - ### Method Detail

    - #### values

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

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

    - #### valueOf

          public static ConnectionFactory.TokenUserType 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

    - #### fromString

          public static ConnectionFactory.TokenUserType fromString(java.lang.String tokenType)

      Gets a TokenUserType value based on the given string.
      Parameters:
        `tokenType` - the string
      Returns:
        Returns the type or null if an invalid string is specified.

    - #### toInt

          public int toInt()

      Returns:
        Returns the integer value of the user type.