org.mortbay.http
Interface Authenticator

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

public interface Authenticator
extends java.io.Serializable

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


Method Summary
 java.security.Principal authenticate(UserRealm realm, java.lang.String pathInContext, HttpRequest request, HttpResponse response)
          Authenticate.
 java.lang.String getAuthMethod()
           
 

Method Detail

authenticate

java.security.Principal authenticate(UserRealm realm,
                                     java.lang.String pathInContext,
                                     HttpRequest request,
                                     HttpResponse response)
                                     throws java.io.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.
Throws:
java.io.IOException - if an error occurs

getAuthMethod

java.lang.String getAuthMethod()


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