com.couchbase.client.java.auth

Enum CredentialContext

java.lang.Object

java.lang.Enum<CredentialContext>

com.couchbase.client.java.auth.CredentialContext

All Implemented Interfaces:

Serializable, Comparable<CredentialContext>

@InterfaceStability.Experimental
 @InterfaceAudience.Public
public enum CredentialContext
extends Enum<CredentialContext>

Enum of the contexts that can be used to retrieve an implicit credential from an Authenticator. Note that not all Authenticator implementations will support all these contexts, and some contexts may also require additional information (a “specific”).

Since:

2.3

Author:

Simon Baslé

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUCKET_FTS
BUCKET_KV
BUCKET_MANAGEMENT
BUCKET_N1QL
BUCKET_VIEW
CLUSTER_FTS
CLUSTER_MANAGEMENT
CLUSTER_N1QL

Method Summary

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

BUCKET_KV

public static final CredentialContext BUCKET_KV

BUCKET_VIEW

public static final CredentialContext BUCKET_VIEW

BUCKET_N1QL

public static final CredentialContext BUCKET_N1QL

BUCKET_FTS

public static final CredentialContext BUCKET_FTS

CLUSTER_N1QL

public static final CredentialContext CLUSTER_N1QL

CLUSTER_FTS

public static final CredentialContext CLUSTER_FTS

BUCKET_MANAGEMENT

public static final CredentialContext BUCKET_MANAGEMENT

CLUSTER_MANAGEMENT

public static final CredentialContext CLUSTER_MANAGEMENT

Method Detail

values

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

Returns:

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

valueOf

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