Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Licensed to the Apache Software Foundation (ASF) under one or more
   * contributor license agreements.  See the NOTICE file distributed with
   * this work for additional information regarding copyright ownership.
   * The ASF licenses this file to You under the Apache License, Version 2.0
   * (the "License"); you may not use this file except in compliance with
   * the License.  You may obtain a copy of the License at
   * 
   *      http://www.apache.org/licenses/LICENSE-2.0
  * 
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 
 package org.apache.catalina.authenticator;
 
 
 public class Constants {
 
     public static final String Package = "org.apache.catalina.authenticator";
 
     // Authentication methods for login configuration
     public static final String LOGIN_METHOD = "LOGIN";
 
     // User data constraints for transport guarantee
     public static final String NONE_TRANSPORT = "NONE";
     public static final String INTEGRAL_TRANSPORT = "INTEGRAL";
     public static final String CONFIDENTIAL_TRANSPORT = "CONFIDENTIAL";
 
     // Form based authentication constants
     public static final String FORM_ACTION = "/j_security_check";
     public static final String FORM_PASSWORD = "j_password";
     public static final String FORM_USERNAME = "j_username";
 
     // Cookie name for single sign on support
     public static final String SINGLE_SIGN_ON_COOKIE =
         System.getProperty("org.apache.catalina.authenticator.Constants.JSESSIONIDSSO""JSESSIONIDSSO");
 
 
     // --------------------------------------------------------- Request Notes
 

    

If a user has been authenticated by the web layer, by means of a login method other than CLIENT_CERT, the username and password used to authenticate the user will be attached to the request as Notes for use by other server components. A server component can also call several existing methods on Request to determine whether or not any user has been authenticated:

  • request.getAuthType() will return BASIC, CLIENT_CERT, DIGEST, FORM, or null if there is no authenticated user.
  • request.getUserPrincipal() will return the authenticated Principal returned by the Realm that authenticated this user.

If CLIENT_CERT authentication was performed, the certificate chain will be available as a request attribute, as defined in the servlet specification.

 


    
The notes key for the password used to authenticate this user.
 
     public static final String REQ_PASSWORD_NOTE =
       "org.apache.catalina.request.PASSWORD";


    
The notes key for the username used to authenticate this user.
 
     public static final String REQ_USERNAME_NOTE =
       "org.apache.catalina.request.USERNAME";


    
The notes key to track the single-sign-on identity with which this request is associated.
 
     public static final String REQ_SSOID_NOTE =
       "org.apache.catalina.request.SSOID";
 
 
     // ---------------------------------------------------------- Session Notes
 

    
If the cache property of our authenticator is set, and the current request is part of a session, authentication information will be cached to avoid the need for repeated calls to Realm.authenticate(), under the following keys:
 


    
The notes key for the password used to authenticate this user.
    public static final String SESS_PASSWORD_NOTE =
      "org.apache.catalina.session.PASSWORD";


    
The notes key for the username used to authenticate this user.
    public static final String SESS_USERNAME_NOTE =
      "org.apache.catalina.session.USERNAME";


    
The following note keys are used during form login processing to cache required information prior to the completion of authentication.



    
The previously authenticated principal (if caching is disabled).
    public static final String FORM_PRINCIPAL_NOTE =
        "org.apache.catalina.authenticator.PRINCIPAL";


    
The original request information, to which the user will be redirected if authentication succeeds.
    public static final String FORM_REQUEST_NOTE =
        "org.apache.catalina.authenticator.REQUEST";
New to GrepCode? Check out our FAQ X