| career | drupal | java | mac | mysql | perl | scala | uml | unix  

Tomcat example source code file (

This example Tomcat source code file ( is included in the "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.

Java - Tomcat tags/keywords

basic, basic_method, confidential_transport, form, form_action, form_request_note, form_username, integral, none, none_transport, req_password_note, req_ssoid_note, string, string

The Tomcat source code

 * 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
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * 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 BASIC_METHOD = "BASIC";
    public static final String CERT_METHOD = "CLIENT_CERT";
    public static final String DIGEST_METHOD = "DIGEST";
    public static final String FORM_METHOD = "FORM";

    // 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 = "JSESSIONIDSSO";

    // --------------------------------------------------------- Request Notes

     * <p>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:</p>
     * <ul>
     * <li>request.getAuthType()
     *     will return BASIC, CLIENT_CERT, DIGEST, FORM, or <code>null
     *     if there is no authenticated user.</li>
     * <li>request.getUserPrincipal()
     *     will return the authenticated <code>Principal returned by the
     *     <code>Realm that authenticated this user.
     * </ul>
     * <p>If CLIENT_CERT authentication was performed, the certificate chain
     * will be available as a request attribute, as defined in the
     * servlet specification.</p>

     * The notes key for the password used to authenticate this user.
    public static final String REQ_PASSWORD_NOTE =

     * The notes key for the username used to authenticate this user.
    public static final String REQ_USERNAME_NOTE =

     * The notes key to track the single-sign-on identity with which this
     * request is associated.
    public static final String REQ_SSOID_NOTE =

    // ---------------------------------------------------------- Session Notes

     * If the <code>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
     * <code>Realm.authenticate(), under the following keys:

     * The notes key for the password used to authenticate this user.
    public static final String SESS_PASSWORD_NOTE =

     * The notes key for the username used to authenticate this user.
    public static final String SESS_USERNAME_NOTE =

     * 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 =

     * The original request information, to which the user will be
     * redirected if authentication succeeds.
    public static final String FORM_REQUEST_NOTE =


Other Tomcat examples (source code examples)

Here is a short list of links related to this Tomcat source code file:

... this post is sponsored by my books ...

#1 New Release!

FP Best Seller


new blog posts


Copyright 1998-2021 Alvin Alexander,
All Rights Reserved.

A percentage of advertising revenue from
pages under the /java/jwarehouse URI on this website is
paid back to open source projects.