org.opends.server.admin.std.server
Interface ExternalSASLMechanismHandlerCfg

All Superinterfaces:
Configuration, SASLMechanismHandlerCfg

public interface ExternalSASLMechanismHandlerCfg
extends SASLMechanismHandlerCfg

A server-side interface for querying External SASL Mechanism Handler settings.

The External SASL Mechanism Handler performs all processing related to SASL EXTERNAL authentication.


Method Summary
 void addExternalChangeListener(ConfigurationChangeListener<ExternalSASLMechanismHandlerCfg> listener)
          Register to be notified when this External SASL Mechanism Handler is changed.
 java.lang.Class<? extends ExternalSASLMechanismHandlerCfg> configurationClass()
          Gets the configuration class associated with this External SASL Mechanism Handler.
 AttributeType getCertificateAttribute()
          Gets the "certificate-attribute" property.
 java.lang.String getCertificateMapper()
          Gets the "certificate-mapper" property.
 DN getCertificateMapperDN()
          Gets the "certificate-mapper" property as a DN.
 ExternalSASLMechanismHandlerCfgDefn.CertificateValidationPolicy getCertificateValidationPolicy()
          Gets the "certificate-validation-policy" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 void removeExternalChangeListener(ConfigurationChangeListener<ExternalSASLMechanismHandlerCfg> listener)
          Deregister an existing External SASL Mechanism Handler configuration change listener.
 
Methods inherited from interface org.opends.server.admin.std.server.SASLMechanismHandlerCfg
addChangeListener, isEnabled, removeChangeListener
 
Methods inherited from interface org.opends.server.admin.Configuration
dn
 

Method Detail

configurationClass

java.lang.Class<? extends ExternalSASLMechanismHandlerCfg> configurationClass()
Gets the configuration class associated with this External SASL Mechanism Handler.

Specified by:
configurationClass in interface Configuration
Specified by:
configurationClass in interface SASLMechanismHandlerCfg
Returns:
Returns the configuration class associated with this External SASL Mechanism Handler.

addExternalChangeListener

void addExternalChangeListener(ConfigurationChangeListener<ExternalSASLMechanismHandlerCfg> listener)
Register to be notified when this External SASL Mechanism Handler is changed.

Parameters:
listener - The External SASL Mechanism Handler configuration change listener.

removeExternalChangeListener

void removeExternalChangeListener(ConfigurationChangeListener<ExternalSASLMechanismHandlerCfg> listener)
Deregister an existing External SASL Mechanism Handler configuration change listener.

Parameters:
listener - The External SASL Mechanism Handler configuration change listener.

getCertificateAttribute

AttributeType getCertificateAttribute()
Gets the "certificate-attribute" property.

Specifies the name of the attribute to hold user certificates.

This property must specify the name of a valid attribute type defined in the server schema.

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

getCertificateMapper

java.lang.String getCertificateMapper()
Gets the "certificate-mapper" property.

Specifies the name of the certificate mapper that should be used to match client certificates to user entries.

Returns:
Returns the value of the "certificate-mapper" property.

getCertificateMapperDN

DN getCertificateMapperDN()
Gets the "certificate-mapper" property as a DN.

Specifies the name of the certificate mapper that should be used to match client certificates to user entries.

Returns:
Returns the DN value of the "certificate-mapper" property.

getCertificateValidationPolicy

ExternalSASLMechanismHandlerCfgDefn.CertificateValidationPolicy getCertificateValidationPolicy()
Gets the "certificate-validation-policy" property.

Indicates whether to attempt to validate the peer certificate against a certificate held in the user's entry.

Returns:
Returns the value of the "certificate-validation-policy" property.

getJavaClass

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

Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation.

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