Package com.ibm.di.api.authentication
Interface AuthenticationInterface
-
- All Known Implementing Classes:
JAASAuthentication,LDAPAuthentication
public interface AuthenticationInterfaceThis is the base interface used by the supported authentication mechanisms.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidauthenticate(java.lang.String aUserName, java.lang.String aPassword)This method authenticates the user specified by the passed arguments.voidauthenticate(java.util.Map<java.lang.String,java.lang.String> aMap)This method authenticates the user using the entries in the provided map.voidclose()Closes any resources opened for the authentication process.voidinitialize(java.util.Map<java.lang.String,java.lang.String> aConfigMap)This method initializes the authentication mechanism.
-
-
-
Method Detail
-
initialize
void initialize(java.util.Map<java.lang.String,java.lang.String> aConfigMap) throws java.lang.ExceptionThis method initializes the authentication mechanism.- Parameters:
aConfigMap- the map containing properties used for the authentication.- Throws:
java.lang.Exception- if an error occurs.
-
authenticate
void authenticate(java.util.Map<java.lang.String,java.lang.String> aMap) throws java.lang.ExceptionThis method authenticates the user using the entries in the provided map.- Parameters:
aMap- the map containing the credentials used for the authentication.- Throws:
java.lang.Exception- if the authentication fails.
-
authenticate
void authenticate(java.lang.String aUserName, java.lang.String aPassword) throws java.lang.ExceptionThis method authenticates the user specified by the passed arguments.- Parameters:
aUserName- this is the user that will be authenticated.aPassword- this is the password used for the authentication.- Throws:
java.lang.Exception- if the authentication fails.
-
close
void close() throws java.lang.ExceptionCloses any resources opened for the authentication process.- Throws:
java.lang.Exception- if an error occurs.
-
-