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

Class SubjectDnToUserAttributeCertificateMapperCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<SubjectDnToUserAttributeCertificateMapperCfgClient,SubjectDnToUserAttributeCertificateMapperCfg>

org.forgerock.opendj.server.config.meta.SubjectDnToUserAttributeCertificateMapperCfgDefn

public final class SubjectDnToUserAttributeCertificateMapperCfgDefn
extends ManagedObjectDefinition<SubjectDnToUserAttributeCertificateMapperCfgClient,SubjectDnToUserAttributeCertificateMapperCfg>

An interface for querying the Subject DN To User Attribute Certificate Mapper managed object definition meta information.

The Subject DN To User Attribute Certificate Mapper maps client certificates to user entries by looking for the certificate subject DN in a specified attribute of user entries.

Method Summary

Modifier and Type	Method	Description
SubjectDnToUserAttributeCertificateMapperCfgClient	createClientConfiguration(ManagedObject<? extends SubjectDnToUserAttributeCertificateMapperCfgClient> impl)	Creates a client configuration view of the provided managed object.
SubjectDnToUserAttributeCertificateMapperCfg	createServerConfiguration(ServerManagedObject<? extends SubjectDnToUserAttributeCertificateMapperCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static SubjectDnToUserAttributeCertificateMapperCfgDefn	getInstance()	Get the Subject DN To User Attribute Certificate Mapper configuration definition singleton.
AttributeTypePropertyDefinition	getIssuerAttributePropertyDefinition()	Get the "issuer-attribute" property definition.
ClassPropertyDefinition	getJavaClassPropertyDefinition()	Get the "java-class" property definition.
Class<SubjectDnToUserAttributeCertificateMapperCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
AttributeTypePropertyDefinition	getSubjectAttributePropertyDefinition()	Get the "subject-attribute" property definition.
DnPropertyDefinition	getUserBaseDnPropertyDefinition()	Get the "user-base-dn" property definition.

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

getAggregationPropertyDefinition, getAggregationPropertyDefinitions, getAllAggregationPropertyDefinitions, getAllChildren, getAllConstraints, getAllPropertyDefinitions, getAllRelationDefinitions, getAllReverseAggregationPropertyDefinitions, 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 Detail

getInstance

public static SubjectDnToUserAttributeCertificateMapperCfgDefn getInstance()

Get the Subject DN To User Attribute Certificate Mapper configuration definition singleton.

Returns:

Returns the Subject DN To User Attribute Certificate Mapper configuration definition singleton.

createClientConfiguration

public SubjectDnToUserAttributeCertificateMapperCfgClient createClientConfiguration(ManagedObject<? extends SubjectDnToUserAttributeCertificateMapperCfgClient> 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<SubjectDnToUserAttributeCertificateMapperCfgClient,SubjectDnToUserAttributeCertificateMapperCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<SubjectDnToUserAttributeCertificateMapperCfgClient,SubjectDnToUserAttributeCertificateMapperCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<SubjectDnToUserAttributeCertificateMapperCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<SubjectDnToUserAttributeCertificateMapperCfgClient,SubjectDnToUserAttributeCertificateMapperCfg>

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 Subject DN To User Attribute 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 Subject DN To User Attribute Certificate Mapper implementation.

Returns:

Returns the "java-class" property definition.

getSubjectAttributePropertyDefinition

public AttributeTypePropertyDefinition getSubjectAttributePropertyDefinition()

Get the "subject-attribute" property definition.

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

Returns:

Returns the "subject-attribute" property definition.

getUserBaseDnPropertyDefinition

public DnPropertyDefinition getUserBaseDnPropertyDefinition()

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

Specifies the base DNs that should be used when performing searches to map the client certificate to a user entry.

Returns:

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