com.cenqua.fisheye.user.plugin
Class AbstractFishEyeAuthenticator

java.lang.Object
  extended by com.cenqua.fisheye.user.plugin.AbstractFishEyeAuthenticator
All Implemented Interfaces:
FishEyeAuthenticator
Direct Known Subclasses:
ExampleFishEyeAuthenticator, ExampleFishEyeHttpAuthenticator, NullFishEyeAuthenticator

public abstract class AbstractFishEyeAuthenticator
extends java.lang.Object
implements FishEyeAuthenticator

A super class for all Custom FishEye Authenticators. It is best practice to extend this class instead of implementing a custom FishEyeAuthenticator.


Constructor Summary
AbstractFishEyeAuthenticator()
           
 
Method Summary
 AuthToken checkRequest(javax.servlet.http.HttpServletRequest request)
          Called to allow implementations to determine if the request is pre-authenticated, bypassing FishEye's own HTTP authentication.
 boolean isRequestUserStillValid(java.lang.String username, javax.servlet.http.HttpServletRequest req)
          Checks that the given username is still valid for the request.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.cenqua.fisheye.user.plugin.FishEyeAuthenticator
checkPassword, close, hasPermissionToAccess, init, recreateAuth
 

Constructor Detail

AbstractFishEyeAuthenticator

public AbstractFishEyeAuthenticator()
Method Detail

checkRequest

public AuthToken checkRequest(javax.servlet.http.HttpServletRequest request)
Description copied from interface: FishEyeAuthenticator
Called to allow implementations to determine if the request is pre-authenticated, bypassing FishEye's own HTTP authentication.

Specified by:
checkRequest in interface FishEyeAuthenticator
Parameters:
request - the servlet request to check
Returns:
an authentication token if the request is authenticated, or null otherwise.

isRequestUserStillValid

public boolean isRequestUserStillValid(java.lang.String username,
                                       javax.servlet.http.HttpServletRequest req)
Description copied from interface: FishEyeAuthenticator
Checks that the given username is still valid for the request.

Specified by:
isRequestUserStillValid in interface FishEyeAuthenticator
Parameters:
username - the UserName, must not be null
req - the request to check the username against
Returns:
true if the username is still valid, false otherwise.