Package org.forgerock.opendj.server.config.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

Modifier and Type	Method	Description
ManagedObjectDefinition<? extends ExternalSASLMechanismHandlerCfgClient,? extends ExternalSASLMechanismHandlerCfg>	definition()	Get the configuration definition associated with this External SASL Mechanism Handler.
org.forgerock.opendj.ldap.schema.AttributeType	getCertificateAttribute()	Gets the "certificate-attribute" property.
String	getCertificateMapper()	Gets the "certificate-mapper" property.
ExternalSASLMechanismHandlerCfgDefn.CertificateValidationPolicy	getCertificateValidationPolicy()	Gets the "certificate-validation-policy" property.
String	getJavaClass()	Gets the "java-class" property.
void	setCertificateAttribute(org.forgerock.opendj.ldap.schema.AttributeType value)	Sets the "certificate-attribute" property.
void	setCertificateMapper(String value)	Sets the "certificate-mapper" property.
void	setCertificateValidationPolicy(ExternalSASLMechanismHandlerCfgDefn.CertificateValidationPolicy value)	Sets the "certificate-validation-policy" property.
void	setJavaClass(String value)	Sets the "java-class" property.

Methods inherited from interface org.forgerock.opendj.config.ConfigurationClient

commit, properties

Methods inherited from interface org.forgerock.opendj.server.config.client.SASLMechanismHandlerCfgClient

isEnabled, setEnabled

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

org.forgerock.opendj.ldap.schema.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(org.forgerock.opendj.ldap.schema.AttributeType value)
                      throws PropertyException

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:

PropertyException - If the new value is invalid.

getCertificateMapper

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(String value)
                   throws PropertyException

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:

PropertyException - 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 PropertyException

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:

PropertyException - If the new value is invalid.

getJavaClass

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(String value)
           throws PropertyException

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:

PropertyException - If the new value is invalid.