Package com.netscape.certsrv.ldap
Interface ILdapAuthInfo
-
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$
-
-
Field Summary
Fields Modifier and Type Field Description static int
LDAP_AUTHTYPE_BASICAUTH
static int
LDAP_AUTHTYPE_NONE
static int
LDAP_AUTHTYPE_SSLCLIENTAUTH
static java.lang.String
LDAP_BASICAUTH_STR
static java.lang.String
LDAP_SSLCLIENTAUTH_STR
static java.lang.String
PROP_BINDDN
static java.lang.String
PROP_BINDDN_DEFAULT
static java.lang.String
PROP_BINDPW
static java.lang.String
PROP_BINDPW_PROMPT
static java.lang.String
PROP_CLIENTCERTNICKNAME
static java.lang.String
PROP_LDAPAUTHTYPE
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addPassword(java.lang.String prompt, java.lang.String pw)
Add password to private password data structure.int
getAuthType()
Get authentication type.java.lang.String[]
getParms()
Get params for authentication.void
init(IConfigStore config)
Initialize this class from the config store.void
init(IConfigStore config, java.lang.String host, int port, boolean secure)
Initialize this class from the config store.void
removePassword(java.lang.String prompt)
Remove password from private password data structure.void
reset()
Reset the connection to the host
-
-
-
Field Detail
-
PROP_LDAPAUTHTYPE
static final java.lang.String PROP_LDAPAUTHTYPE
- See Also:
- Constant Field Values
-
PROP_CLIENTCERTNICKNAME
static final java.lang.String PROP_CLIENTCERTNICKNAME
- See Also:
- Constant Field Values
-
PROP_BINDDN
static final java.lang.String PROP_BINDDN
- See Also:
- Constant Field Values
-
PROP_BINDPW
static final java.lang.String PROP_BINDPW
- See Also:
- Constant Field Values
-
PROP_BINDPW_PROMPT
static final java.lang.String PROP_BINDPW_PROMPT
- See Also:
- Constant Field Values
-
PROP_BINDDN_DEFAULT
static final java.lang.String PROP_BINDDN_DEFAULT
- See Also:
- Constant Field Values
-
LDAP_BASICAUTH_STR
static final java.lang.String LDAP_BASICAUTH_STR
- See Also:
- Constant Field Values
-
LDAP_SSLCLIENTAUTH_STR
static final java.lang.String LDAP_SSLCLIENTAUTH_STR
- See Also:
- Constant Field Values
-
LDAP_AUTHTYPE_NONE
static final int LDAP_AUTHTYPE_NONE
- See Also:
- Constant Field Values
-
LDAP_AUTHTYPE_BASICAUTH
static final int LDAP_AUTHTYPE_BASICAUTH
- See Also:
- Constant Field Values
-
LDAP_AUTHTYPE_SSLCLIENTAUTH
static final int LDAP_AUTHTYPE_SSLCLIENTAUTH
- See Also:
- Constant Field Values
-
-
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
-
getParms
java.lang.String[] getParms()
Get params for authentication.- Returns:
- array of parameters for this authentication as an array of Strings.
-
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.
-
-