Enum Class AuthenticationMethod
- All Implemented Interfaces:
Serializable,Comparable<AuthenticationMethod>,Constable
Defines the constants for determining the type of authentication to Elasticsearch we will be using.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionBasic mode uses basic HTTP authentication using a username and password to authenticate to the Elasticsearch clusterKerberos mode uses SPNEGO via HTTP to authenticate to the Elasticsearch clusterPKI mode uses certificates that are provided to Elasticsearch during the SSL negotiation phase to determine identity.Simple mode uses no security features to authenticate to the Elasticsearch cluster -
Method Summary
Modifier and TypeMethodDescriptionstatic AuthenticationMethodLook up an AuthenticationMethod based on the given value of a setting.getValue()The configuration value that corresponds to this methodstatic AuthenticationMethodReturns the enum constant of this class with the specified name.static AuthenticationMethod[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
SIMPLE
Simple mode uses no security features to authenticate to the Elasticsearch cluster -
BASIC
Basic mode uses basic HTTP authentication using a username and password to authenticate to the Elasticsearch cluster -
PKI
PKI mode uses certificates that are provided to Elasticsearch during the SSL negotiation phase to determine identity. -
KERBEROS
Kerberos mode uses SPNEGO via HTTP to authenticate to the Elasticsearch cluster
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-
get
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
- Returns:
- a List of available setting values
-
getValue
The configuration value that corresponds to this method- Returns:
- the settings string representation of this method
-