Package org.forgerock.opendj.security

Enum SslOptions.ClientAuthPolicy

java.lang.Object

java.lang.Enum<SslOptions.ClientAuthPolicy>

org.forgerock.opendj.security.SslOptions.ClientAuthPolicy

All Implemented Interfaces:

Serializable, Comparable<SslOptions.ClientAuthPolicy>

Enclosing class:

SslOptions

public static enum SslOptions.ClientAuthPolicy
extends Enum<SslOptions.ClientAuthPolicy>

Represents the client authentication policy option.

This option is only useful in server mode.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	If this policy is selected it means that no client authentication is desired.
OPTIONAL	If this policy is selected and the client chooses not to provide authentication information about itself, the negotiations will continue.
REQUIRED	If this policy is selected and the client chooses not to provide authentication information about itself, the negotiations will stop and the engine will begin its closure procedure.

Method Summary

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

DISABLED

public static final SslOptions.ClientAuthPolicy DISABLED

If this policy is selected it means that no client authentication is desired.

OPTIONAL

public static final SslOptions.ClientAuthPolicy OPTIONAL

If this policy is selected and the client chooses not to provide authentication information about itself, the negotiations will continue.

REQUIRED

public static final SslOptions.ClientAuthPolicy REQUIRED

If this policy is selected and the client chooses not to provide authentication information about itself, the negotiations will stop and the engine will begin its closure procedure.

Method Detail

values

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

Returns:

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

valueOf

public static SslOptions.ClientAuthPolicy 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