org.opends.server.admin.std.client
Interface FingerprintCertificateMapperCfgClient

All Superinterfaces:
CertificateMapperCfgClient, ConfigurationClient

public interface FingerprintCertificateMapperCfgClient
extends CertificateMapperCfgClient

A client-side interface for reading and modifying Fingerprint Certificate Mapper settings.

The Fingerprint Certificate Mapper maps client certificates to user entries by looking for the MD5 or SHA1 fingerprint in a specified attribute of user entries.


Method Summary
 ManagedObjectDefinition<? extends FingerprintCertificateMapperCfgClient,? extends FingerprintCertificateMapperCfg> definition()
          Get the configuration definition associated with this Fingerprint Certificate Mapper.
 FingerprintCertificateMapperCfgDefn.FingerprintAlgorithm getFingerprintAlgorithm()
          Gets the "fingerprint-algorithm" property.
 AttributeType getFingerprintAttribute()
          Gets the "fingerprint-attribute" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 java.util.SortedSet<DN> getUserBaseDN()
          Gets the "user-base-dn" property.
 void setFingerprintAlgorithm(FingerprintCertificateMapperCfgDefn.FingerprintAlgorithm value)
          Sets the "fingerprint-algorithm" property.
 void setFingerprintAttribute(AttributeType value)
          Sets the "fingerprint-attribute" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" 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 FingerprintCertificateMapperCfgClient,? extends FingerprintCertificateMapperCfg> definition()
Get the configuration definition associated with this Fingerprint Certificate Mapper.

Specified by:
definition in interface CertificateMapperCfgClient
Specified by:
definition in interface ConfigurationClient
Returns:
Returns the configuration definition associated with this Fingerprint Certificate Mapper.

getFingerprintAlgorithm

FingerprintCertificateMapperCfgDefn.FingerprintAlgorithm getFingerprintAlgorithm()
Gets the "fingerprint-algorithm" property.

Specifies the name of the digest algorithm to compute the fingerprint of client certificates.

Returns:
Returns the value of the "fingerprint-algorithm" property.

setFingerprintAlgorithm

void setFingerprintAlgorithm(FingerprintCertificateMapperCfgDefn.FingerprintAlgorithm value)
                             throws IllegalPropertyValueException
Sets the "fingerprint-algorithm" property.

Specifies the name of the digest algorithm to compute the fingerprint of client certificates.

Parameters:
value - The value of the "fingerprint-algorithm" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getFingerprintAttribute

AttributeType getFingerprintAttribute()
Gets the "fingerprint-attribute" property.

Specifies the attribute in which to look for the fingerprint.

Values of the fingerprint attribute should exactly match the MD5 or SHA1 representation of the certificate fingerprint.

Returns:
Returns the value of the "fingerprint-attribute" property.

setFingerprintAttribute

void setFingerprintAttribute(AttributeType value)
                             throws IllegalPropertyValueException
Sets the "fingerprint-attribute" property.

Specifies the attribute in which to look for the fingerprint.

Values of the fingerprint attribute should exactly match the MD5 or SHA1 representation of the certificate fingerprint.

Parameters:
value - The value of the "fingerprint-attribute" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.

getJavaClass

java.lang.String getJavaClass()
Gets the "java-class" property.

Specifies the fully-qualified name of the Java class that provides the Fingerprint 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 Fingerprint 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.

getUserBaseDN

java.util.SortedSet<DN> getUserBaseDN()
Gets the "user-base-dn" property.

Specifies the set of base DNs below which to search for users.

The base DNs are used when performing searches to map the client certificates 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 set of base DNs below which to search for users.

The base DNs are used when performing searches to map the client certificates 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.