org.elasticsearch.hadoop.security

Enum AuthenticationMethod

java.lang.Object

java.lang.Enum<AuthenticationMethod>

org.elasticsearch.hadoop.security.AuthenticationMethod

All Implemented Interfaces:

Serializable, Comparable<AuthenticationMethod>

public enum AuthenticationMethod
extends Enum<AuthenticationMethod>

Defines the constants for determining the type of authentication to Elasticsearch we will be using.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASIC Basic mode uses basic HTTP authentication using a username and password to authenticate to the Elasticsearch cluster
KERBEROS Kerberos mode uses SPNEGO via HTTP to authenticate to the Elasticsearch cluster
PKI PKI mode uses certificates that are provided to Elasticsearch during the SSL negotiation phase to determine identity.
SIMPLE Simple mode uses no security features to authenticate to the Elasticsearch cluster

Method Summary

Modifier and Type	Method and Description
static AuthenticationMethod	get(String value) Look up an AuthenticationMethod based on the given value of a setting.
static List<String>	getAvailableMethods()
String	getValue() The configuration value that corresponds to this method
static AuthenticationMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuthenticationMethod[]	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

SIMPLE

public static final AuthenticationMethod SIMPLE

Simple mode uses no security features to authenticate to the Elasticsearch cluster

BASIC

public static final AuthenticationMethod BASIC

Basic mode uses basic HTTP authentication using a username and password to authenticate to the Elasticsearch cluster

PKI

public static final AuthenticationMethod PKI

PKI mode uses certificates that are provided to Elasticsearch during the SSL negotiation phase to determine identity.

KERBEROS

public static final AuthenticationMethod KERBEROS

Kerberos mode uses SPNEGO via HTTP to authenticate to the Elasticsearch cluster

Method Detail

values

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

Returns:

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

valueOf

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

get

public static AuthenticationMethod get(String value)

Look up an AuthenticationMethod based on the given value of a setting.

Parameters:

value - The setting string

Returns:

An AuthenticationMethod if the string is valid, or null if none could be found.

getAvailableMethods

public static List<String> getAvailableMethods()

Returns:

a List of available setting values

getValue

public String getValue()

The configuration value that corresponds to this method

Returns:

the settings string representation of this method