com.couchbase.client.core.diagnostics

Enum AuthenticationStatus

java.lang.Object

java.lang.Enum<AuthenticationStatus>

com.couchbase.client.core.diagnostics.AuthenticationStatus

All Implemented Interfaces:

Serializable, Comparable<AuthenticationStatus>

@Stability.Volatile
public enum AuthenticationStatus
extends Enum<AuthenticationStatus>

The last known authentication status for an endpoint.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED Authentication failed.
SUCCEEDED Authentication was successful.
UNKNOWN Authentication is in progress or has not started.

Method Summary

Modifier and Type	Method and Description
static AuthenticationStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthenticationStatus[]	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

UNKNOWN

public static final AuthenticationStatus UNKNOWN

Authentication is in progress or has not started. There is no evidence of it failing or succeeding yet.

SUCCEEDED

public static final AuthenticationStatus SUCCEEDED

Authentication was successful.

FAILED

public static final AuthenticationStatus FAILED

Authentication failed.

Method Detail

values

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

Returns:

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

valueOf

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