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

Class SubjectAttributeToUserAttributeCertificateMapperCfgDefn

java.lang.Object

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

org.forgerock.opendj.config.ManagedObjectDefinition<SubjectAttributeToUserAttributeCertificateMapperCfgClient,SubjectAttributeToUserAttributeCertificateMapperCfg>

org.forgerock.opendj.server.config.meta.SubjectAttributeToUserAttributeCertificateMapperCfgDefn

public final class SubjectAttributeToUserAttributeCertificateMapperCfgDefn
extends ManagedObjectDefinition<SubjectAttributeToUserAttributeCertificateMapperCfgClient,SubjectAttributeToUserAttributeCertificateMapperCfg>

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

The Subject Attribute To User Attribute Certificate Mapper maps client certificates to user entries by mapping the values of attributes contained in the certificate subject to attributes contained in user entries.

Method Summary

Modifier and Type	Method	Description
SubjectAttributeToUserAttributeCertificateMapperCfgClient	createClientConfiguration(ManagedObject<? extends SubjectAttributeToUserAttributeCertificateMapperCfgClient> impl)	Creates a client configuration view of the provided managed object.
SubjectAttributeToUserAttributeCertificateMapperCfg	createServerConfiguration(ServerManagedObject<? extends SubjectAttributeToUserAttributeCertificateMapperCfg> impl)	Creates a server configuration view of the provided server managed object.
BooleanPropertyDefinition	getEnabledPropertyDefinition()	Get the "enabled" property definition.
static SubjectAttributeToUserAttributeCertificateMapperCfgDefn	getInstance()	Get the Subject Attribute 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<SubjectAttributeToUserAttributeCertificateMapperCfg>	getServerConfigurationClass()	Gets the server configuration class instance associated with this managed object definition.
StringPropertyDefinition	getSubjectAttributeMappingPropertyDefinition()	Get the "subject-attribute-mapping" property 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 SubjectAttributeToUserAttributeCertificateMapperCfgDefn getInstance()

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

Returns:

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

createClientConfiguration

public SubjectAttributeToUserAttributeCertificateMapperCfgClient createClientConfiguration(ManagedObject<? extends SubjectAttributeToUserAttributeCertificateMapperCfgClient> 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<SubjectAttributeToUserAttributeCertificateMapperCfgClient,SubjectAttributeToUserAttributeCertificateMapperCfg>

Parameters:

impl - The managed object.

Returns:

Returns a client configuration view of the provided managed object.

createServerConfiguration

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

Description copied from class: ManagedObjectDefinition

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

Specified by:

createServerConfiguration in class ManagedObjectDefinition<SubjectAttributeToUserAttributeCertificateMapperCfgClient,SubjectAttributeToUserAttributeCertificateMapperCfg>

Parameters:

impl - The server managed object.

Returns:

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

getServerConfigurationClass

public Class<SubjectAttributeToUserAttributeCertificateMapperCfg> getServerConfigurationClass()

Description copied from class: ManagedObjectDefinition

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

Specified by:

getServerConfigurationClass in class ManagedObjectDefinition<SubjectAttributeToUserAttributeCertificateMapperCfgClient,SubjectAttributeToUserAttributeCertificateMapperCfg>

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

Returns:

Returns the "java-class" property definition.

getSubjectAttributeMappingPropertyDefinition

public StringPropertyDefinition getSubjectAttributeMappingPropertyDefinition()

Get the "subject-attribute-mapping" property definition.

Specifies a mapping between certificate attributes and user attributes.

Each value should be in the form "certattr:userattr" where certattr is the name of the attribute in the certificate subject and userattr is the name of the corresponding attribute in user entries. There may be multiple mappings defined, and when performing the mapping values for all attributes present in the certificate subject that have mappings defined must be present in the corresponding user entries.

Returns:

Returns the "subject-attribute-mapping" 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.