Save This Page
Home » jboss-5.0.0.CR1-src » org » jboss » web » tomcat » tc4 » authenticator » [javadoc | source]
org.jboss.web.tomcat.tc4.authenticator
abstract public class: AuthenticatorBase [javadoc | source]
java.lang.Object
   org.apache.catalina.authenticator.AuthenticatorBase
      org.jboss.web.tomcat.tc4.authenticator.AuthenticatorBase

Direct Known Subclasses:
    NonLoginAuthenticator, BasicAuthenticator, FormAuthenticator, SSLAuthenticator, DigestAuthenticator

Overrides the superclass version by using class org.jboss.web.tomcat.tc4.authenticator.SingleSignOn instead of org.apache.catalina.authenticator.SingleSignOn as its method expected single sign-on valve. This class also differs from the standard Tomcat version in its implementation of method reqister .

Basic implementation of the Valve interface that enforces the <security-constraint> elements in the web application deployment descriptor. This functionality is implemented as a Valve so that it can be ommitted in environments that do not require these features. Individual implementations of each supported authentication method can subclass this base class as required.

USAGE CONSTRAINT: When this class is utilized, the Context to which it is attached (or a parent Container in a hierarchy) must have an associated Realm that can be used for authenticating users and enumerating the roles to which they have been assigned.

USAGE CONSTRAINT: This Valve is only useful when processing HTTP requests. Requests of any other type will simply be passed through.

Field Summary
protected static final  String info    Descriptive information about this implementation. 
protected  SingleSignOn ourSSO    The SingleSignOn implementation in our request processing chain, if there is one.

NOTE: This is an instance of org.jboss.web.tomcat.tc4.authenticator.SingleSignOn, not org.apache.catalina.authenticator.SingleSignOn

Method from org.jboss.web.tomcat.tc4.authenticator.AuthenticatorBase Summary:
associate,   reauthenticateFromSSO,   register,   start,   stop
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.jboss.web.tomcat.tc4.authenticator.AuthenticatorBase Detail:
 protected  void associate(String ssoId,
    Session session) 
    Associate the specified single sign on identifier with the specified Session.

    IMPLEMENTATION NOTE: Overrides the superclass version solely by using a org.jboss.web.tomcat.tc4.authenticator.SingleSignOn instead of an org.apache.catalina.authenticator.SingleSignOn

 protected boolean reauthenticateFromSSO(String ssoId,
    HttpRequest request) 
    Attempts reauthentication to the Realm using the credentials included in argument entry.
 protected  void register(HttpRequest request,
    HttpResponse response,
    Principal principal,
    String authType,
    String username,
    String password) 
    Register an authenticated Principal and authentication type in our request, in the current session (if there is one), and with our SingleSignOn valve, if there is one. Set the appropriate cookie to be returned.

    IMPLEMENTATION NOTE: Differs from the standard Tomcat implementation in checking if any SingleSignOn valve has added a note to the request. If it has, it does not call SingleSignOn.register, instead calling SingleSignOn.update. This behavior supports authenticators like SSLAuthenticator that may attempt to re-register with every request.

 public  void start() throws LifecycleException 
    Prepare for the beginning of active use of the public methods of this component. This method should be called after configure(), and before any of the public methods of the component are utilized.

    IMPLEMENTATION NOTE: Overrides the superclass version solely by using a org.jboss.web.tomcat.tc4.authenticator.SingleSignOn instead of an org.apache.catalina.authenticator.SingleSignOn

 public  void stop() throws LifecycleException 
    Gracefully terminate the active use of the public methods of this component. This method should be the last one called on a given instance of this component.

    IMPLEMENTATION NOTE: Overrides the superclass version solely by using a org.jboss.web.tomcat.tc4.authenticator.SingleSignOn instead of an org.apache.catalina.authenticator.SingleSignOn