org.opends.server.admin.std.server
Interface FingerprintCertificateMapperCfg

All Superinterfaces:
CertificateMapperCfg, Configuration

public interface FingerprintCertificateMapperCfg
extends CertificateMapperCfg

A server-side interface for querying 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
 void addFingerprintChangeListener(ConfigurationChangeListener<FingerprintCertificateMapperCfg> listener)
          Register to be notified when this Fingerprint Certificate Mapper is changed.
 java.lang.Class<? extends FingerprintCertificateMapperCfg> configurationClass()
          Gets the configuration class 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 removeFingerprintChangeListener(ConfigurationChangeListener<FingerprintCertificateMapperCfg> listener)
          Deregister an existing Fingerprint Certificate Mapper configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.CertificateMapperCfg
addChangeListener, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends FingerprintCertificateMapperCfg> configurationClass()
Gets the configuration class associated with this Fingerprint Certificate Mapper.

Specified by:
configurationClass in interface CertificateMapperCfg
Specified by:
configurationClass in interface Configuration
Returns:
Returns the configuration class associated with this Fingerprint Certificate Mapper.

addFingerprintChangeListener

void addFingerprintChangeListener(ConfigurationChangeListener<FingerprintCertificateMapperCfg> listener)
Register to be notified when this Fingerprint Certificate Mapper is changed.

Parameters:
listener - The Fingerprint Certificate Mapper configuration change listener.

removeFingerprintChangeListener

void removeFingerprintChangeListener(ConfigurationChangeListener<FingerprintCertificateMapperCfg> listener)
Deregister an existing Fingerprint Certificate Mapper configuration change listener.

Parameters:
listener - The Fingerprint Certificate Mapper configuration change listener.

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.

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.

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 CertificateMapperCfg
Returns:
Returns the value of the "java-class" property.

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 an unmodifiable set containing the values of the "user-base-dn" property.