Package org.forgerock.opendj.server.config.meta

Class FingerprintCertificateMapperCfgDefn

java.lang.Object

org.forgerock.opendj.config.AbstractManagedObjectDefinition<C,S>

org.forgerock.opendj.config.ManagedObjectDefinition<FingerprintCertificateMapperCfgClient,FingerprintCertificateMapperCfg>

org.forgerock.opendj.server.config.meta.FingerprintCertificateMapperCfgDefn

public final class FingerprintCertificateMapperCfgDefn
extends ManagedObjectDefinition<FingerprintCertificateMapperCfgClient,FingerprintCertificateMapperCfg>

An interface for querying the Fingerprint Certificate Mapper managed object definition meta information.

The Fingerprint Certificate Mapper maps client certificates to user entries by looking for the fingerprint in a specified attribute of user entries.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FingerprintCertificateMapperCfgDefn.FingerprintAlgorithm	Defines the set of permissible values for the "fingerprint-algorithm" property.

Method Summary

Modifier and Type	Method	Description
FingerprintCertificateMapperCfgClient	createClientConfiguration(ManagedObject<? extends FingerprintCertificateMapperCfgClient> impl)	Creates a client configuration view of the provided managed object.
FingerprintCertificateMapperCfg	createServerConfiguration(ServerManagedObject<? extends FingerprintCertificateMapperCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
EnumPropertyDefinition<FingerprintCertificateMapperCfgDefn.FingerprintAlgorithm>	getFingerprintAlgorithmPropertyDefinition()	Get the "fingerprint-algorithm" property definition.
AttributeTypePropertyDefinition	getFingerprintAttributePropertyDefinition()	Get the "fingerprint-attribute" property definition.
static FingerprintCertificateMapperCfgDefn	getInstance()	Get the Fingerprint Certificate Mapper configuration definition singleton.
AttributeTypePropertyDefinition	getIssuerAttributePropertyDefinition()	Get the "issuer-attribute" property definition.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<FingerprintCertificateMapperCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
DnPropertyDefinition	getUserBaseDnPropertyDefinition()	Get the "user-base-dn" property definition.

Methods inherited from class org.forgerock.opendj.config.AbstractManagedObjectDefinition

getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseRelationDefinitions, getAllTags, getChild, getChildren, getConstraints, getDeprecated, getDescription, getDescription, getName, getParent, getPropertyDefinition, getPropertyDefinitions, getRelationDefinition, getRelationDefinitions, getReverseAggregationPropertyDefinitions, getReverseRelationDefinitions, getSynopsis, getSynopsis, getUserFriendlyName, getUserFriendlyName, getUserFriendlyPluralName, getUserFriendlyPluralName, hasChildren, hasOption, hasTag, initialize, isChildOf, isParentOf, isTop, registerConstraint, registerDeprecated, registerOption, registerPropertyDefinition, registerRelationDefinition, registerTag, resolveManagedObjectDefinition, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getInstance

public static FingerprintCertificateMapperCfgDefn getInstance()

Get the Fingerprint Certificate Mapper configuration definition singleton.

Returns:

Returns the Fingerprint Certificate Mapper configuration definition singleton.

createClientConfiguration

public FingerprintCertificateMapperCfgClient createClientConfiguration(ManagedObject<? extends FingerprintCertificateMapperCfgClient> impl)

Description copied from class: ManagedObjectDefinition

Creates a client configuration view of the provided managed object. Modifications made to the underlying managed object will be reflected in the client configuration view and vice versa.

Specified by:

createClientConfiguration in class ManagedObjectDefinition<FingerprintCertificateMapperCfgClient,FingerprintCertificateMapperCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

public FingerprintCertificateMapperCfg createServerConfiguration(ServerManagedObject<? extends FingerprintCertificateMapperCfg> impl)

Description copied from class: ManagedObjectDefinition

Creates a server configuration view of the provided server managed object.

Specified by:

createServerConfiguration in class ManagedObjectDefinition<FingerprintCertificateMapperCfgClient,FingerprintCertificateMapperCfg>

Parameters:

impl - The server managed object.

Returns:

Returns a server configuration view of the provided server managed object.

getServerConfigurationClass

public Class<FingerprintCertificateMapperCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

Gets the server configuration class instance associated with this managed object definition.

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<FingerprintCertificateMapperCfgClient,FingerprintCertificateMapperCfg>

Returns:

Returns the server configuration class instance associated with this managed object definition.

getEnabledPropertyDefinition

public BooleanPropertyDefinition getEnabledPropertyDefinition()

Get the "enabled" property definition.

Indicates whether the Fingerprint Certificate Mapper is enabled.

Returns:

Returns the "enabled" property definition.

getFingerprintAlgorithmPropertyDefinition

public EnumPropertyDefinition<FingerprintCertificateMapperCfgDefn.FingerprintAlgorithm> getFingerprintAlgorithmPropertyDefinition()

Get the "fingerprint-algorithm" property definition.

Specifies the name of the digest algorithm to compute the fingerprint of client certificates.

Returns:

Returns the "fingerprint-algorithm" property definition.

getFingerprintAttributePropertyDefinition

public AttributeTypePropertyDefinition getFingerprintAttributePropertyDefinition()

Get the "fingerprint-attribute" property definition.

Specifies the attribute in which to look for the fingerprint.

Values of the fingerprint attribute should exactly match the MD5 or SHA1 representation of the certificate fingerprint.

Returns:

Returns the "fingerprint-attribute" property definition.

getIssuerAttributePropertyDefinition

public AttributeTypePropertyDefinition getIssuerAttributePropertyDefinition()

Get the "issuer-attribute" property definition.

Specifies the name or OID of the attribute whose value should exactly match the certificate issuer DN.

Certificate issuer verification should be enabled whenever multiple CAs are trusted in order to prevent impersonation. In particular, it is possible for different CAs to issue certificates having the same subject DN.

Returns:

Returns the "issuer-attribute" property definition.

getJavaClassPropertyDefinition

public ClassPropertyDefinition getJavaClassPropertyDefinition()

Get the "java-class" property definition.

Specifies the fully-qualified name of the Java class that provides the Fingerprint Certificate Mapper implementation.

Returns:

Returns the "java-class" property definition.

getUserBaseDnPropertyDefinition

public DnPropertyDefinition getUserBaseDnPropertyDefinition()

Get the "user-base-dn" property definition.

Specifies the set of base DNs below which to search for users.

The base DNs are used when performing searches to map the client certificates to a user entry.

Returns:

Returns the "user-base-dn" property definition.