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

Class CertificateMapperCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<CertificateMapperCfgClient,CertificateMapperCfg>

org.forgerock.opendj.server.config.meta.CertificateMapperCfgDefn

public final class CertificateMapperCfgDefn
extends ManagedObjectDefinition<CertificateMapperCfgClient,CertificateMapperCfg>

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

Certificate Mappers are responsible for establishing a mapping between a client certificate and the entry for the user that corresponds to that certificate.

Method Summary

Modifier and Type	Method	Description
CertificateMapperCfgClient	createClientConfiguration(ManagedObject<? extends CertificateMapperCfgClient> impl)	Creates a client configuration view of the provided managed object.
CertificateMapperCfg	createServerConfiguration(ServerManagedObject<? extends CertificateMapperCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static CertificateMapperCfgDefn	getInstance()	Get the Certificate Mapper configuration definition singleton.
AttributeTypePropertyDefinition	getIssuerAttributePropertyDefinition()	Get the "issuer-attribute" property definition.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<CertificateMapperCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object 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 CertificateMapperCfgDefn getInstance()

Get the Certificate Mapper configuration definition singleton.

Returns:

Returns the Certificate Mapper configuration definition singleton.

createClientConfiguration

public CertificateMapperCfgClient createClientConfiguration(ManagedObject<? extends CertificateMapperCfgClient> 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<CertificateMapperCfgClient,CertificateMapperCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<CertificateMapperCfgClient,CertificateMapperCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<CertificateMapperCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<CertificateMapperCfgClient,CertificateMapperCfg>

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 Certificate Mapper is enabled.

Returns:

Returns the "enabled" 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 Certificate Mapper implementation.

Returns:

Returns the "java-class" property definition.