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

Enum SubjectDnPrincipalResolverProperties.SubjectDnFormat

java.lang.Object

java.lang.Enum<SubjectDnPrincipalResolverProperties.SubjectDnFormat>

org.apereo.cas.configuration.model.support.x509.SubjectDnPrincipalResolverProperties.SubjectDnFormat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SubjectDnPrincipalResolverProperties.SubjectDnFormat>

Enclosing class:

SubjectDnPrincipalResolverProperties

public static enum SubjectDnPrincipalResolverProperties.SubjectDnFormat
extends java.lang.Enum<SubjectDnPrincipalResolverProperties.SubjectDnFormat>

The format of subject dn to be used.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANONICAL	Canonical String format of Distinguished Names.
DEFAULT	Denigrated result of calling certificate.getSubjectDN() method.
RFC1779	RFC 1779 String format of Distinguished Names.
RFC2253	RFC 2253 String format of Distinguished Names.

Method Summary

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

DEFAULT

public static final SubjectDnPrincipalResolverProperties.SubjectDnFormat DEFAULT

Denigrated result of calling certificate.getSubjectDN() method. Javadocs designate this method as "denigrated" for not being portable and/or not being well defined. It is what has been used by CAS for a long time so it remains the default.

See Also:

DENIGRATED

RFC1779

public static final SubjectDnPrincipalResolverProperties.SubjectDnFormat RFC1779

RFC 1779 String format of Distinguished Names. Calls X500Principal.getName("RFC1779") which emits a subject DN with the attribute keywords defined in RFC 1779 (CN, L, ST, O, OU, C, STREET). Any other attribute type is emitted as an OID.

See Also:

RFC1779

RFC2253

public static final SubjectDnPrincipalResolverProperties.SubjectDnFormat RFC2253

RFC 2253 String format of Distinguished Names. Calls X500Principal.getName("RFC2253") which emits a subject DN with the attribute keywords defined in RFC 2253 (CN, L, ST, O, OU, C, STREET, DC, UID). Any other attribute type is emitted as an OID.

See Also:

RFC2253

CANONICAL

public static final SubjectDnPrincipalResolverProperties.SubjectDnFormat CANONICAL

Canonical String format of Distinguished Names. Calls X500Principal.getName("CANONICAL" which emits a subject DN that starts with RFC 2253 and applies additional canonicalizations described in the javadoc.

See Also:

CANONICAL

Method Detail

values

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

Returns:

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

valueOf

public static SubjectDnPrincipalResolverProperties.SubjectDnFormat 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