com.couchbase.client.java.cluster

Enum AuthDomain

java.lang.Object

java.lang.Enum<AuthDomain>

com.couchbase.client.java.cluster.AuthDomain

All Implemented Interfaces:

Serializable, Comparable<AuthDomain>

public enum AuthDomain
extends Enum<AuthDomain>

The possible authentication domains that can be used when managing users with RBAC.

Since:

2.5.0

Author:

Michael Nitschinger

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXTERNAL
LOCAL

Method Summary

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

LOCAL

public static final AuthDomain LOCAL

EXTERNAL

public static final AuthDomain EXTERNAL

Method Detail

values

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

Returns:

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

valueOf

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

alias

public String alias()

fromAlias

public static AuthDomain fromAlias(String alias)