Package org.forgerock.opendj.server.config.client

Interface SubjectDnToUserAttributeCertificateMapperCfgClient

All Superinterfaces:

CertificateMapperCfgClient, ConfigurationClient

public interface SubjectDnToUserAttributeCertificateMapperCfgClient
extends CertificateMapperCfgClient

A client-side interface for reading and modifying Subject DN To User Attribute Certificate Mapper settings.

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
ManagedObjectDefinition<? extends SubjectDnToUserAttributeCertificateMapperCfgClient,? extends SubjectDnToUserAttributeCertificateMapperCfg>	definition()	Get the configuration definition associated with this Subject DN To User Attribute Certificate Mapper.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
ValueOrExpression<AttributeType>	getSubjectAttribute()	Gets the "subject-attribute" property.
SortedSet<ValueOrExpression<Dn>>	getUserBaseDn()	Gets the "user-base-dn" property.
void	setJavaClass(ValueOrExpression<String> value)	Sets the "java-class" property.
void	setSubjectAttribute(ValueOrExpression<AttributeType> value)	Sets the "subject-attribute" property.
void	setUserBaseDn(Collection<ValueOrExpression<Dn>> values)	Sets the "user-base-dn" property.

Methods inherited from interface org.forgerock.opendj.server.config.client.CertificateMapperCfgClient

getIssuerAttribute, isEnabled, setEnabled, setIssuerAttribute

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Method Detail

definition

ManagedObjectDefinition<? extends SubjectDnToUserAttributeCertificateMapperCfgClient,? extends SubjectDnToUserAttributeCertificateMapperCfg> definition()

Get the configuration definition associated with this Subject DN To User Attribute Certificate Mapper.

Specified by:

definition in interface CertificateMapperCfgClient

Specified by:

definition in interface ConfigurationClient

Returns:

Returns the configuration definition associated with this Subject DN To User Attribute Certificate Mapper.

getJavaClass

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Subject DN To User Attribute Certificate Mapper implementation.

Default value: org.opends.server.extensions.SubjectDNToUserAttributeCertificateMapper

Specified by:

getJavaClass in interface CertificateMapperCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<String> value)
           throws PropertyException

Sets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Subject DN To User Attribute Certificate Mapper implementation.

Specified by:

setJavaClass in interface CertificateMapperCfgClient

Parameters:

value - The value of the "java-class" property.

Throws:

PropertyException - If the new value is invalid.

getSubjectAttribute

@MandatoryProperty
ValueOrExpression<AttributeType> getSubjectAttribute()

Gets the "subject-attribute" property.

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

Returns:

Returns the value of the "subject-attribute" property.

setSubjectAttribute

@MandatoryProperty
void setSubjectAttribute(ValueOrExpression<AttributeType> value)
                  throws PropertyException

Sets the "subject-attribute" property.

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

Parameters:

value - The value of the "subject-attribute" property.

Throws:

PropertyException - If the new value is invalid.

getUserBaseDn

SortedSet<ValueOrExpression<Dn>> getUserBaseDn()

Gets the "user-base-dn" property.

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

Returns:

Returns the values of the "user-base-dn" property.

setUserBaseDn

void setUserBaseDn(Collection<ValueOrExpression<Dn>> values)
            throws PropertyException

Sets the "user-base-dn" property.

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

Parameters:

values - The values of the "user-base-dn" property.

Throws:

PropertyException - If one or more of the new values are invalid.