org.opends.server.admin.std.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
 ManagedObjectDefinition<? extends SubjectDNToUserAttributeCertificateMapperCfgClient,? extends SubjectDNToUserAttributeCertificateMapperCfg> definition()
          Get the configuration definition associated with this Subject DN To User Attribute Certificate Mapper.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 AttributeType getSubjectAttribute()
          Gets the "subject-attribute" property.
 java.util.SortedSet<DN> getUserBaseDN()
          Gets the "user-base-dn" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 void setSubjectAttribute(AttributeType value)
          Sets the "subject-attribute" property.
 void setUserBaseDN(java.util.Collection<DN> values)
          Sets the "user-base-dn" property.
 
Methods inherited from interface org.opends.server.admin.std.client.CertificateMapperCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.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

java.lang.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.

Specified by:
getJavaClass in interface CertificateMapperCfgClient
Returns:
Returns the value of the "java-class" property.

setJavaClass

void setJavaClass(java.lang.String value)
                  throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

getSubjectAttribute

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

void setSubjectAttribute(AttributeType value)
                         throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If the new value is invalid.

getUserBaseDN

java.util.SortedSet<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(java.util.Collection<DN> values)
                   throws IllegalPropertyValueException
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:
IllegalPropertyValueException - If one or more of the new values are invalid.