Package org.forgerock.opendj.server.config.meta

Enum LdapConnectionHandlerCfgDefn.SslClientAuthPolicy

java.lang.Object

java.lang.Enum<LdapConnectionHandlerCfgDefn.SslClientAuthPolicy>

org.forgerock.opendj.server.config.meta.LdapConnectionHandlerCfgDefn.SslClientAuthPolicy

All Implemented Interfaces:

Serializable, Comparable<LdapConnectionHandlerCfgDefn.SslClientAuthPolicy>

Enclosing class:

LdapConnectionHandlerCfgDefn

public static enum LdapConnectionHandlerCfgDefn.SslClientAuthPolicy
extends Enum<LdapConnectionHandlerCfgDefn.SslClientAuthPolicy>

Defines the set of permissible values for the "ssl-client-auth-policy" property.

Specifies the policy that the LDAP Connection Handler should use regarding client SSL certificates. Clients can use the SASL EXTERNAL mechanism only if the policy is set to "optional" or "required".

This is only applicable if clients are allowed to use SSL.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	Clients must not provide their own certificates when performing SSL negotiation.
OPTIONAL	Clients are requested to provide their own certificates when performing SSL negotiation.
REQUIRED	Clients are required to provide their own certificates when performing SSL negotiation and are refused access if they do not provide a certificate.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISABLED

public static final LdapConnectionHandlerCfgDefn.SslClientAuthPolicy DISABLED

Clients must not provide their own certificates when performing SSL negotiation.

OPTIONAL

public static final LdapConnectionHandlerCfgDefn.SslClientAuthPolicy OPTIONAL

Clients are requested to provide their own certificates when performing SSL negotiation. The connection is nevertheless accepted if the client does not provide a certificate.

REQUIRED

public static final LdapConnectionHandlerCfgDefn.SslClientAuthPolicy REQUIRED

Clients are required to provide their own certificates when performing SSL negotiation and are refused access if they do not provide a certificate.

Method Detail

values

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

Returns:

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

valueOf

public static LdapConnectionHandlerCfgDefn.SslClientAuthPolicy 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

toString

public String toString()

Overrides:

toString in class Enum<LdapConnectionHandlerCfgDefn.SslClientAuthPolicy>