Package org.forgerock.openig.tools

Enum ServerTlsOptions.ClientAuthentication

java.lang.Object

java.lang.Enum<ServerTlsOptions.ClientAuthentication>

org.forgerock.openig.tools.ServerTlsOptions.ClientAuthentication

All Implemented Interfaces:

Serializable, Comparable<ServerTlsOptions.ClientAuthentication>

Enclosing class:

ServerTlsOptions

public static enum ServerTlsOptions.ClientAuthentication
extends Enum<ServerTlsOptions.ClientAuthentication>

Enum representing the client authentication configuration options driving authentication negotiations between IG and the client.

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	Client authentication not required.
REQUEST	Accept client authentication if provided.
REQUIRED	Require client authentication.

Method Summary

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

NONE

public static final ServerTlsOptions.ClientAuthentication NONE

Client authentication not required.

REQUEST

public static final ServerTlsOptions.ClientAuthentication REQUEST

Accept client authentication if provided. If not provided, continue negotiation.

REQUIRED

public static final ServerTlsOptions.ClientAuthentication REQUIRED

Require client authentication. Negotiation stopped if not provided.

Method Detail

values

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

Returns:

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

valueOf

public static ServerTlsOptions.ClientAuthentication 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