Package org.opends.server.types

Enum SSLClientAuthPolicy

java.lang.Object

java.lang.Enum<SSLClientAuthPolicy>

org.opends.server.types.SSLClientAuthPolicy

All Implemented Interfaces:

Serializable, Comparable<SSLClientAuthPolicy>

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public enum SSLClientAuthPolicy
extends Enum<SSLClientAuthPolicy>

This enumeration defines a policy that indicates how the server should deal with SSL/TLS-based client connections. It is used to determine whether the server should request that clients provide their own certificates, and whether to accept client connections in which the client did not provide a certificate.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DISABLED	Indicates that the server will not request a certificate from the client.
OPTIONAL	Indicates that the server will request a certificate from the client but will not require that one be provided.
REQUIRED	Indicates that the server will request a certificate from the client and will reject any connection attempt in which the client did not provide one.

Method Summary

Modifier and Type	Method	Description
static SSLClientAuthPolicy	policyForName(String policyName)	Retrieves the SSL client authentication policy for the specified name.
String	toString()	Retrieves the human-readable name for this SSL client auth policy.
static SSLClientAuthPolicy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static 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 SSLClientAuthPolicy DISABLED

Indicates that the server will not request a certificate from the client.

OPTIONAL

public static final SSLClientAuthPolicy OPTIONAL

Indicates that the server will request a certificate from the client but will not require that one be provided.

REQUIRED

public static final SSLClientAuthPolicy REQUIRED

Indicates that the server will request a certificate from the client and will reject any connection attempt in which the client did not provide one.

Method Detail

values

public static 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 (SSLClientAuthPolicy c : 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 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

policyForName

public static SSLClientAuthPolicy policyForName(String policyName)

Retrieves the SSL client authentication policy for the specified name.

Parameters:

policyName - The name of the SSL client authentication policy to retrieve.

Returns:

The requested SSL client authentication policy, or null if the provided value is not the name of a valid client authentication policy.

toString

public String toString()

Retrieves the human-readable name for this SSL client auth policy.

Overrides:

toString in class Enum<SSLClientAuthPolicy>

Returns:

The human-readable name for this SSL client auth policy.