com.droplets.api.event
Interface AuthenticationHandler

All Known Implementing Classes:

AuthenticationHandlerAdapter

public interface AuthenticationHandler

Callback interface for handling the results of an authentication request. When a Droplet application requires the user to provide a username and password, it calls the Application.requestAuthentication method, passing in an object that implements this interface. At a subsequent time, the Droplet Server calls one of the methods in this interface.

Two of the methods in this interface, authenticationCompleted(java.lang.String) and authenticationCancelled(), represent the completion of the authentication session. The former indicates that the user provided a valid username and password; the latter indicates that the user hit the "Cancel" button before doing so. If the user provides an invalid username and/or password, no method is called - instead, the authentication dialog reappears with an error message until s/he either provides valid information or hits cancel.

The third method, handlerReplaced(), gets called if and when the application calls Application.requestAuthentication again, providing a different AuthenticationHandler object. In that case, the old authentication handler is replaced and the handlerReplaced method is called to notify it of that fact.

If you only want to implement a subset of the methods in this interface, use the AuthenticationHandlerAdapter class, which provides default, null implementations that can be selectively overridden.

Method Summary

void	authenticationCancelled() Called by the Droplet Server when the user has cancelled the authentication dialog without providing a valid username and password.
void	authenticationCompleted(java.lang.String username) Called by the Droplet Server when the user has provided a valid username and password.
void	handlerReplaced() Called by the Droplet Server when this object has been replaced by a different AuthenticationHandler.

Method Detail

authenticationCompleted

public void authenticationCompleted(java.lang.String username)

Called by the Droplet Server when the user has provided a valid username and password.

Parameters:

username - the username that the user provided

authenticationCancelled

public void authenticationCancelled()

Called by the Droplet Server when the user has cancelled the authentication dialog without providing a valid username and password.

handlerReplaced

public void handlerReplaced()

Called by the Droplet Server when this object has been replaced by a different AuthenticationHandler. This object will no longer be notified of the outcome of the authentication.