summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/ldap/ILdapAuthInfo.java
diff options
context:
space:
mode:
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/ldap/ILdapAuthInfo.java')
-rw-r--r--pki/base/common/src/com/netscape/certsrv/ldap/ILdapAuthInfo.java33
1 files changed, 19 insertions, 14 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapAuthInfo.java b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapAuthInfo.java
index 46082c73..b62cf20b 100644
--- a/pki/base/common/src/com/netscape/certsrv/ldap/ILdapAuthInfo.java
+++ b/pki/base/common/src/com/netscape/certsrv/ldap/ILdapAuthInfo.java
@@ -17,11 +17,9 @@
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.ldap;
-
import com.netscape.certsrv.base.EBaseException;
import com.netscape.certsrv.base.IConfigStore;
-
/**
* Class for obtaining ldap authentication info from the configuration store.
* Two types of authentication is basic and SSL client authentication.
@@ -39,28 +37,30 @@ public interface ILdapAuthInfo {
static public final String LDAP_BASICAUTH_STR = "BasicAuth";
static public final String LDAP_SSLCLIENTAUTH_STR = "SslClientAuth";
- static public final int LDAP_AUTHTYPE_NONE = 0; // illegal
+ static public final int LDAP_AUTHTYPE_NONE = 0; // illegal
static public final int LDAP_AUTHTYPE_BASICAUTH = 1;
static public final int LDAP_AUTHTYPE_SSLCLIENTAUTH = 2;
/**
* Initialize this class from the config store.
+ *
* @param config The config store from which to initialize.
* @exception EBaseException Due to failure of the initialization process.
- *
+ *
*/
public void init(IConfigStore config) 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.
+ * 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.
+ *
* @param config The config store from which to initialize.
* @exception EBaseException Due to failure of the initialization process.
- *
+ *
*/
public void init(IConfigStore config, String host, int port, boolean secure)
- throws EBaseException;
+ throws EBaseException;
/**
* Reset the connection to the host
@@ -68,28 +68,33 @@ public interface ILdapAuthInfo {
public void reset();
/**
- * Get authentication type.
+ * Get authentication type.
+ *
* @return one of: <br>
- * LdapAuthInfo.LDAP_AUTHTYPE_BASICAUTH or
- * LdapAuthInfo.LDAP_AUTHTYPE_SSLCLIENTAUTH
+ * LdapAuthInfo.LDAP_AUTHTYPE_BASICAUTH or
+ * LdapAuthInfo.LDAP_AUTHTYPE_SSLCLIENTAUTH
*/
public int getAuthType();
/**
* Get params for authentication.
- * @return array of parameters for this authentication as an array of Strings.
+ *
+ * @return array of parameters for this authentication as an array of
+ * Strings.
*/
public String[] getParms();
/**
* Add password to private password data structure.
+ *
* @param prompt Password prompt.
- * @param pw Password itself.
+ * @param pw Password itself.
*/
public void addPassword(String prompt, String pw);
/**
* Remove password from private password data structure.
+ *
* @param prompt Identify password to remove with prompt.
*/
public void removePassword(String prompt);