|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
---|
void initialize(java.util.Map<java.lang.String,java.lang.String> aConfigMap) throws java.lang.Exception
aConfigMap
- the map containing properties used for the authentication.
java.lang.Exception
- if an error occurs.void authenticate(java.util.Map<java.lang.String,java.lang.String> aMap) throws java.lang.Exception
aMap
- the map containing the credentials used for the
authentication.
java.lang.Exception
- if the authentication fails.void authenticate(java.lang.String aUserName, java.lang.String aPassword) throws java.lang.Exception
aUserName
- this is the user that will be authenticated.aPassword
- this is the password used for the authentication.
java.lang.Exception
- if the authentication fails.void close() throws java.lang.Exception
java.lang.Exception
- if an error occurs.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |