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

      • 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

        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.

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

      • getCertificateMapperDN

        org.forgerock.opendj.ldap.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

        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.