Interface PlainSaslMechanismHandlerCfg

  • All Superinterfaces:
    Configuration, SaslMechanismHandlerCfg

    public interface PlainSaslMechanismHandlerCfg
    extends SaslMechanismHandlerCfg
    A server-side interface for querying Plain SASL Mechanism Handler settings.

    The Plain SASL Mechanism Handler performs all processing related to SASL PLAIN authentication.

    • Method Detail

      • addPlainChangeListener

        void addPlainChangeListener​(ConfigurationChangeListener<PlainSaslMechanismHandlerCfg> listener)
        Register to be notified when this Plain SASL Mechanism Handler is changed.
        Parameters:
        listener - The Plain SASL Mechanism Handler configuration change listener.
      • removePlainChangeListener

        void removePlainChangeListener​(ConfigurationChangeListener<PlainSaslMechanismHandlerCfg> listener)
        Deregister an existing Plain SASL Mechanism Handler configuration change listener.
        Parameters:
        listener - The Plain SASL Mechanism Handler configuration change listener.
      • getIdentityMapper

        SortedSet<String> getIdentityMapper()
        Gets the "identity-mapper" property.

        Specifies the name(s) of the identity mapper(s) that is to be used with this SASL mechanism handler to match the authentication or authorization ID included in the SASL bind request to the corresponding user in the directory.

        Returns:
        Returns an unmodifiable set containing the values of the "identity-mapper" property.
      • getIdentityMapperDns

        SortedSet<Dn> getIdentityMapperDns()
        Gets the "identity-mapper" property as a set of DNs.

        Specifies the name(s) of the identity mapper(s) that is to be used with this SASL mechanism handler to match the authentication or authorization ID included in the SASL bind request to the corresponding user in the directory.

        Returns:
        Returns the DN values of the "identity-mapper" 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.

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

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