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.
ValueOrExpression<AttributeType>	getCertificateAttribute()	Gets the "certificate-attribute" property.
SortedSet<ValueOrExpression<String>>	getCertificateMapper()	Gets the "certificate-mapper" property.
ValueOrExpression<ExternalSaslMechanismHandlerCfgDefn.CertificateValidationPolicy>	getCertificateValidationPolicy()	Gets the "certificate-validation-policy" property.
ValueOrExpression<String>	getJavaClass()	Gets the "java-class" property.
void	setCertificateAttribute(ValueOrExpression<AttributeType> value)	Sets the "certificate-attribute" property.
void	setCertificateMapper(Collection<ValueOrExpression<String>> values)	Sets the "certificate-mapper" property.
void	setCertificateValidationPolicy(ValueOrExpression<ExternalSaslMechanismHandlerCfgDefn.CertificateValidationPolicy> value)	Sets the "certificate-validation-policy" property.
void	setJavaClass(ValueOrExpression<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

ValueOrExpression<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.

Default value: userCertificate

Returns:

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

setCertificateAttribute

void setCertificateAttribute(ValueOrExpression<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

@MandatoryProperty
SortedSet<ValueOrExpression<String>> getCertificateMapper()

Gets the "certificate-mapper" property.

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

Returns:

Returns the values of the "certificate-mapper" property.

setCertificateMapper

@MandatoryProperty
void setCertificateMapper(Collection<ValueOrExpression<String>> values)
                   throws PropertyException

Sets the "certificate-mapper" property.

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

Parameters:

values - The values of the "certificate-mapper" property.

Throws:

PropertyException - If one or more of the new values are invalid.

getCertificateValidationPolicy

@MandatoryProperty
ValueOrExpression<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

@MandatoryProperty
void setCertificateValidationPolicy(ValueOrExpression<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

@MandatoryProperty
ValueOrExpression<String> getJavaClass()

Gets the "java-class" property.

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

Default value: org.opends.server.extensions.ExternalSASLMechanismHandler

Specified by:

getJavaClass in interface SaslMechanismHandlerCfgClient

Returns:

Returns the value of the "java-class" property.

setJavaClass

@MandatoryProperty
void setJavaClass(ValueOrExpression<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.