org.mortbay.http

Interface Authenticator

All Superinterfaces:
Serializable
Known Implementing Classes:
BasicAuthenticator, BasicAuthenticator, ClientCertAuthenticator, DigestAuthenticator, DigestAuthenticator, FormAuthenticator

public interface Authenticator
extends Serializable

Authenticator Interface. This is the interface that must be implemented to provide authentication implementations to the HttpContext.

Method Summary

Principal
authenticate(UserRealm realm, String pathInContext, HttpRequest request, HttpResponse response)
Authenticate.
String
getAuthMethod()

Method Details

authenticate

public Principal authenticate(UserRealm realm,
                              String pathInContext,
                              HttpRequest request,
                              HttpResponse response)
            throws IOException
Authenticate.
Parameters:
realm - an UserRealm value
pathInContext - a String value
request - a HttpRequest value
response - a HttpResponse value. If non-null response is passed, then a failed authentication will result in a challenge response being set in the response.
Returns:
User Principal if authenticated. Null if Authentication failed. If the SecurityConstraint.__NOBODY instance is returned, the request is considered as part of the authentication process.

getAuthMethod

public String getAuthMethod()

Copyright © 2004 Mortbay Consulting Pty. Ltd. All Rights Reserved.