se.entra.phantom.server

Interface UserAuthenticationInterface

All Known Implementing Classes:

DefaultUserAuthenticationExit, InternalUserAuthenticationExit

public interface UserAuthenticationInterface

This interface must be supported by the user exit that handles the user authentication.

Method Summary

Modifier and Type	Method and Description
String	changePassword(ClientConnectionData ccd, String oldPassword, String newPassword) Changes the password for a UserID.
void	dispose() Called to perform clean-up.
boolean	isRetryValid(ClientConnectionData ccd, int previousRetryCount) Upon an error for verifyUserIDPassword or changePassword, this method is called to check if further retries should be done, or if the client connection should be dropped.
boolean	isUserIDPasswordRequired(ClientConnectionData ccd) Checks if UserID and Password is required for a particular client IP-address.
String	verifyUserIDPassword(ClientConnectionData ccd, String password, int previousRetryCount) Verifies a UserID and Password entered on the client by a user.

Method Detail

isUserIDPasswordRequired

boolean isUserIDPasswordRequired(ClientConnectionData ccd)

Checks if UserID and Password is required for a particular client IP-address.

verifyUserIDPassword

String verifyUserIDPassword(ClientConnectionData ccd,
                            String password,
                            int previousRetryCount)

Verifies a UserID and Password entered on the client by a user. Return null if OK, empty string to prompt user to change the password or an error string that will be displayed on the client side.

changePassword

String changePassword(ClientConnectionData ccd,
                      String oldPassword,
                      String newPassword)

Changes the password for a UserID. Return null if OK or an error message string.

isRetryValid

boolean isRetryValid(ClientConnectionData ccd,
                     int previousRetryCount)

Upon an error for verifyUserIDPassword or changePassword, this method is called to check if further retries should be done, or if the client connection should be dropped.

dispose

void dispose()

Called to perform clean-up.