com.crankuptheamps.client

Interface Authenticator

All Known Implementing Classes:

DefaultAuthenticator

public interface Authenticator

Interface used by the AMPS Java Client to manage user authentication. This interface is responsible for providing a password or token that will be sent to AMPS for authentication. Implementations of this interface can define how the client retrieves the password or token, such as fetching single-use certificates, dynamic tokens, or other credentials. Implementations can throw an AuthenticationException to indicate failure at any point. Check the following link to view an example of the Authenticator.

See Also:

Kerberos implementations in this public repository can be used as examples for your own implementations., the public repository with examples

Method Summary

Modifier and Type	Method and Description
java.lang.String	authenticate(java.lang.String username_, java.lang.String currentPassword_) Called by the AMPS.Client just before the logon command is sent to the server.
void	completed(java.lang.String username_, java.lang.String password_, int reason_) Called when a logon completes successfully.
java.lang.String	retry(java.lang.String username_, java.lang.String password_) Called when the server responds to a logon attempt with a status of "retry".

Method Detail

authenticate

java.lang.String authenticate(java.lang.String username_,
                              java.lang.String currentPassword_)
                       throws AuthenticationException

Called by the AMPS.Client just before the logon command is sent to the server. This method allows the client to provide the password or token to be included in the Password header field of the logon command. For example, this could fetch a single-use certificate or token if required by the AMPS configuration.

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 password or token to include in the Password header field of the logon command.

Throws:

AuthenticationException - If an error occurs while retrieving or generating the password.

retry

java.lang.String retry(java.lang.String username_,
                       java.lang.String password_)
                throws AuthenticationException

Called when the server responds to a logon attempt with a status of "retry". This method provides a mechanism for the client to update the password or token to use for the next logon attempt. AMPS will continue retrying the logon as long as the server indicates "retry".

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 updated password or token to include in the Password header for the next logon attempt.

Throws:

AuthenticationException - If an error occurs while updating the password.

completed

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

Called when a logon completes successfully. This method notifies the authenticator that the logon was successful and provides the username, password, and the reason for the successful logon. This can be used for auditing, logging, or updating the state of the client application.

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 of the logon.

Throws:

AuthenticationException - If the client-side authentication module detects an error.