Package io.deephaven.web.client.api.barrage.stream

Enum Class AuthenticationInterceptor.State

java.lang.Object

java.lang.Enum<AuthenticationInterceptor.State>

io.deephaven.web.client.api.barrage.stream.AuthenticationInterceptor.State

All Implemented Interfaces:

Serializable, Comparable<AuthenticationInterceptor.State>, java.lang.constant.Constable

Enclosing class:

AuthenticationInterceptor

public static enum AuthenticationInterceptor.State
extends Enum<AuthenticationInterceptor.State>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHENTICATED	At least one call to the server has succeeded, and an auth token returned.
PENDING	The provided "headerToSet" creds have been consumed, and a call is ongoing.
UNAUTHENTICATED	Haven't tried to authenticate, or failed last call due to auth reasons, so new auth attempt is required to continue.

Method Summary

Modifier and Type	Method	Description
static AuthenticationInterceptor.State	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AuthenticationInterceptor.State[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNAUTHENTICATED

public static final AuthenticationInterceptor.State UNAUTHENTICATED

Haven't tried to authenticate, or failed last call due to auth reasons, so new auth attempt is required to continue. "lastHeaderValue" is null, and "pending" is empty. "headerToSet" may be non-null, and will be consumed on the next call.

PENDING

public static final AuthenticationInterceptor.State PENDING

The provided "headerToSet" creds have been consumed, and a call is ongoing. Other calls made while this call is pending are queued until it is complete. "lastHeaderValue" is null.

AUTHENTICATED

public static final AuthenticationInterceptor.State AUTHENTICATED

At least one call to the server has succeeded, and an auth token returned. "headerToSet" is now null, and "lastHeaderValue" is non-null. "pending" is empty.

Method Details

values

public static AuthenticationInterceptor.State[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static AuthenticationInterceptor.State valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null