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

All Superinterfaces:
ConfigurationClient, SASLMechanismHandlerCfgClient

public interface ExternalSASLMechanismHandlerCfgClient
extends SASLMechanismHandlerCfgClient

A client-side interface for reading and modifying External SASL Mechanism Handler settings.

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


Method Summary
 ManagedObjectDefinition<? extends ExternalSASLMechanismHandlerCfgClient,? extends ExternalSASLMechanismHandlerCfg> definition()
          Get the configuration definition associated with this External SASL Mechanism Handler.
 AttributeType getCertificateAttribute()
          Gets the "certificate-attribute" property.
 java.lang.String getCertificateMapper()
          Gets the "certificate-mapper" property.
 ExternalSASLMechanismHandlerCfgDefn.CertificateValidationPolicy getCertificateValidationPolicy()
          Gets the "certificate-validation-policy" property.
 java.lang.String getJavaClass()
          Gets the "java-class" property.
 void setCertificateAttribute(AttributeType value)
          Sets the "certificate-attribute" property.
 void setCertificateMapper(java.lang.String value)
          Sets the "certificate-mapper" property.
 void setCertificateValidationPolicy(ExternalSASLMechanismHandlerCfgDefn.CertificateValidationPolicy value)
          Sets the "certificate-validation-policy" property.
 void setJavaClass(java.lang.String value)
          Sets the "java-class" property.
 
Methods inherited from interface org.opends.server.admin.std.client.SASLMechanismHandlerCfgClient
isEnabled, setEnabled
 
Methods inherited from interface org.opends.server.admin.ConfigurationClient
commit, properties
 

Method Detail

definition

ManagedObjectDefinition<? extends ExternalSASLMechanismHandlerCfgClient,? extends ExternalSASLMechanismHandlerCfg> definition()
Get the configuration definition associated with this External SASL Mechanism Handler.

Specified by:
definition in interface ConfigurationClient
Specified by:
definition in interface SASLMechanismHandlerCfgClient
Returns:
Returns the configuration definition associated with this External SASL Mechanism Handler.

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.

setCertificateAttribute

void setCertificateAttribute(AttributeType value)
                             throws IllegalPropertyValueException
Sets 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.

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

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.

setCertificateMapper

void setCertificateMapper(java.lang.String value)
                          throws IllegalPropertyValueException
Sets the "certificate-mapper" property.

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

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

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.

setCertificateValidationPolicy

void setCertificateValidationPolicy(ExternalSASLMechanismHandlerCfgDefn.CertificateValidationPolicy value)
                                    throws IllegalPropertyValueException
Sets the "certificate-validation-policy" property.

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

Parameters:
value - The value of the "certificate-validation-policy" 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 SASL mechanism handler implementation.

Specified by:
getJavaClass in interface SASLMechanismHandlerCfgClient
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 SASL mechanism handler implementation.

Specified by:
setJavaClass in interface SASLMechanismHandlerCfgClient
Parameters:
value - The value of the "java-class" property.
Throws:
IllegalPropertyValueException - If the new value is invalid.