org.opends.server.extensions
Enum CertificateValidationPolicy

java.lang.Object
  java.lang.Enum<CertificateValidationPolicy>
      org.opends.server.extensions.CertificateValidationPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CertificateValidationPolicy>

public enum CertificateValidationPolicy
extends java.lang.Enum<CertificateValidationPolicy>

This class implements an enumeration that may be used to indicate if/how a client's certificate should be validated against the corresponding user entry in the Directory Server.

Enum Constant Summary

ALWAYS
Indicates that the server should always attempt to validate the client certificate against the version in the corresponding user's entry.

IFPRESENT
Indicates that the server should attempt to validate the client certificate against the version in the corresponding user's entry if there are any certificates in that user's entry.

NEVER
Indicates that the server should not attempt to validate the client certificate against the version in the corresponding user's entry.

Method Summary

static CertificateValidationPolicy	policyForName(java.lang.String policyName) Retrieves the certificate validation policy for the specified name.
java.lang.String	toString() Retrieves the human-readable name for this certificate validation policy.
static CertificateValidationPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CertificateValidationPolicy[]	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

ALWAYS

public static final CertificateValidationPolicy ALWAYS

Indicates that the server should always attempt to validate the client certificate against the version in the corresponding user's entry. If no certificates exist in the user's entry, then the validation will fail.

NEVER

public static final CertificateValidationPolicy NEVER

Indicates that the server should not attempt to validate the client certificate against the version in the corresponding user's entry.

IFPRESENT

public static final CertificateValidationPolicy IFPRESENT

Indicates that the server should attempt to validate the client certificate against the version in the corresponding user's entry if there are any certificates in that user's entry. If the user's entry does not contain any certificates, then no validation will be attempted.

Method Detail

values

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

Returns:

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

valueOf

public static CertificateValidationPolicy 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

policyForName

public static CertificateValidationPolicy policyForName(java.lang.String policyName)

Retrieves the certificate validation policy for the specified name.

Parameters:

policyName - The name of the policy to retrieve.

Returns:

The requested certificate validation policy, or null if the provided value is not the name of a valid policy.

toString

public java.lang.String toString()

Retrieves the human-readable name for this certificate validation policy.

Overrides:

toString in class java.lang.Enum<CertificateValidationPolicy>

Returns:

The human-readable name for this certificate validation policy.