Package org.elasticsearch.common.ssl

Enum SslClientAuthenticationMode

java.lang.Object
java.lang.Enum<SslClientAuthenticationMode>
org.elasticsearch.common.ssl.SslClientAuthenticationMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SslClientAuthenticationMode>, java.lang.constant.Constable
public enum SslClientAuthenticationMode
extends java.lang.Enum<SslClientAuthenticationMode>
The client authentication mode that is used for SSL servers.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    NONE
    Never request a client certificate.
    OPTIONAL
    Request a client certificate, but do not enforce that one is provided.
    REQUIRED
    Request and require a client certificate.

  • Method Summary

    Modifier and Type Method Description
    abstract void configure​(javax.net.ssl.SSLParameters sslParameters)
    Configure client authentication of the provided SSLParameters
    abstract boolean enabled()  
    static SslClientAuthenticationMode parse​(java.lang.String value)  
    static SslClientAuthenticationMode valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static SslClientAuthenticationMode[] 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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

  • Method Details

    • values

      public static SslClientAuthenticationMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static SslClientAuthenticationMode valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null

    • enabled

      public abstract boolean enabled()
      Returns:
      true if client authentication is enabled

    • configure

      public abstract void configure​(javax.net.ssl.SSLParameters sslParameters)
      Configure client authentication of the provided SSLParameters

    • parse

      public static SslClientAuthenticationMode parse​(java.lang.String value)