com.ibm.di.api.authentication
Interface AuthenticationInterface

All Known Implementing Classes:

JAASAuthentication, LDAPAuthentication

public interface AuthenticationInterface

This is the base interface used by the supported authentication mechanisms.

Method Summary

void	authenticate(java.util.Map<java.lang.String,java.lang.String> aMap) This method authenticates the user using the entries in the provided map.
void	authenticate(java.lang.String aUserName, java.lang.String aPassword) This method authenticates the user specified by the passed arguments.
void	close() Closes any resources opened for the authentication process.
void	initialize(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.Exception

This 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.Exception

This 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.Exception

This 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.Exception

Closes any resources opened for the authentication process.

Throws:

java.lang.Exception - if an error occurs.