Interface ILdapAuthInfo

  • All Known Implementing Classes:
    LdapAuthInfo

    public interface ILdapAuthInfo
    Class for obtaining ldap authentication info from the configuration store. Two types of authentication is basic and SSL client authentication.
    Version:
    $Revision$, $Date$
    • Method Detail

      • init

        void init​(IConfigStore config)
           throws EBaseException
        Initialize this class from the config store.
        Parameters:
        config - The config store from which to initialize.
        Throws:
        EBaseException - Due to failure of the initialization process.
      • init

        void init​(IConfigStore config,
                  java.lang.String host,
                  int port,
                  boolean secure)
           throws EBaseException
        Initialize this class from the config store. Based on host, port, and secure boolean info. which allows an actual attempt on the server to verify credentials.
        Parameters:
        config - The config store from which to initialize.
        Throws:
        EBaseException - Due to failure of the initialization process.
      • reset

        void reset()
        Reset the connection to the host
      • getAuthType

        int getAuthType()
        Get authentication type.
        Returns:
        one of:
        LdapAuthInfo.LDAP_AUTHTYPE_BASICAUTH or LdapAuthInfo.LDAP_AUTHTYPE_SSLCLIENTAUTH
      • addPassword

        void addPassword​(java.lang.String prompt,
                         java.lang.String pw)
        Add password to private password data structure.
        Parameters:
        prompt - Password prompt.
        pw - Password itself.
      • removePassword

        void removePassword​(java.lang.String prompt)
        Remove password from private password data structure.
        Parameters:
        prompt - Identify password to remove with prompt.