com.crankuptheamps.client
Interface Authenticator

All Known Implementing Classes:

DefaultAuthenticator

public interface Authenticator

authenticate

String authenticate(String username_,
                    String currentPassword_)
                    throws AuthenticationException

Called by AMPS.Client, just before the logon command is sent.

Parameters:

username_ - The current value of the username as specified in the URI.

currentPassword_ - The current value of the password, as specified in the URI.

Returns:

The value that should be placed into the Password header field of the logon command.

Throws:

AuthenticationException - An error occured while authenticating.

retry

String retry(String username_,
             String password_)
             throws AuthenticationException

Called when a logon "ack" is received with a status of "retry". AMPS will continue trying to logon as long as the server returns "retry", and this method continues to succeed.

Parameters:

username_ - The username returned by the server's ACK message.

password_ - The password or token returned in the server's ACK message.

Returns:

The value that should be placed into the Password header for the next logon attempt.

Throws:

AuthenticationException - An error occured while authenticating.

completed

void completed(String username_,
               String password_,
               int reason_)
               throws AuthenticationException

Called when a logon completes successfully. Once a logon has completed, this method is called with the username and password that caused a successful logon

Parameters:

username_ - The username that successfully logged on to the server.

password_ - The password that successfully logged on to the server.

reason_ - The reason (a value from Message.Reason) for the successful completion.

Throws:

AuthenticationException - The client-side authentication module detected an error.