Package org.apereo.cas.configuration.model.support.x509

Enum Class X509Properties.PrincipalTypes

java.lang.Object

java.lang.Enum<X509Properties.PrincipalTypes>

org.apereo.cas.configuration.model.support.x509.X509Properties.PrincipalTypes

All Implemented Interfaces:

Serializable, Comparable<X509Properties.PrincipalTypes>, Constable

Enclosing class:

X509Properties

public static enum X509Properties.PrincipalTypes
extends Enum<X509Properties.PrincipalTypes>

The principal resolution types.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CN_EDIPI	Create principal by common name and EDIPI.
RFC822_EMAIL	Create principal from the RFC822 type name (aka email address) in the subject alternative name field.
SERIAL_NO	Create principal by serial no.
SERIAL_NO_DN	Create principal by serial no and DN.
SUBJECT	Create principal by subject.
SUBJECT_ALT_NAME	Create principal by subject alternative name.
SUBJECT_DN	Create principal by subject DN.

Method Summary

Modifier and Type	Method	Description
static X509Properties.PrincipalTypes	valueOf(String name)	Returns the enum constant of this class with the specified name.
static X509Properties.PrincipalTypes[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CN_EDIPI

public static final X509Properties.PrincipalTypes CN_EDIPI

Create principal by common name and EDIPI.

RFC822_EMAIL

public static final X509Properties.PrincipalTypes RFC822_EMAIL

Create principal from the RFC822 type name (aka email address) in the subject alternative name field. The subject alternative name field contains a list of various types of names, one type is RFC822 e-mail address. This will return the first e-mail address that is found (if there are more than one).

SERIAL_NO

public static final X509Properties.PrincipalTypes SERIAL_NO

Create principal by serial no. Resolve the principal by the serial number with a configurable radix, ranging from 2 to 36. If radix is 16, then the serial number could be filled with leading zeros to even the number of digits.

SERIAL_NO_DN

public static final X509Properties.PrincipalTypes SERIAL_NO_DN

Create principal by serial no and DN.

SUBJECT

public static final X509Properties.PrincipalTypes SUBJECT

Create principal by subject. Resolve the principal by extracting one or more attribute values from the certificate subject DN and combining them with intervening delimiters.

SUBJECT_ALT_NAME

public static final X509Properties.PrincipalTypes SUBJECT_ALT_NAME

Create principal by subject alternative name. Resolve the principal by the subject alternative name extension. (type: otherName)

SUBJECT_DN

public static final X509Properties.PrincipalTypes SUBJECT_DN

Create principal by subject DN.

Method Details

values

public static X509Properties.PrincipalTypes[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static X509Properties.PrincipalTypes valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null