constants.java

jakarta-struts-1.2.4-src

/*
 * Copyright 2003,2004 The Apache Software Foundation.
 * 
 * Licensed 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.struts.chain;


/**
 * <p>Global constants for the Chain of Responsibility Library.</p>
 */
public final class Constants {


    // -------------------------------------------------- Context Attribute Keys


    /**
     * <p>The default context attribute under which the
     * <code>Action</code> for the current request
     * will be stored.</p>
     */
    public static final String ACTION_KEY = "action";


    /**
     * <p>The default context attribute under which the
     * <code>ActionConfig</code> for the current request
     * will be stored.</p>
     */
    public static final String ACTION_CONFIG_KEY = "actionConfig";


    /**
     * <p>The default context attribute under which the
     * <code>ActionForm</code> for the current request
     * will be stored.</p>
     */
    public static final String ACTION_FORM_KEY = "actionForm";


    /**
     * <p>The default context attribute under which the
     * <code>ActionServet</code> for the current application
     * will be stored.</p>
     */
    public static final String ACTION_SERVLET_KEY = "actionServlet";


    /**
     * <p>The default context attribute under which a
     * boolean flag indicating whether this request has been
     * cancelled will be stored.</p>
     */
    public static final String CANCEL_KEY = "cancel";


    /**
     * <p>The default context attribute under which our
     * <code>Catalog</code> will be stored.</p>
     */
    public static final String CATALOG_KEY = "catalog";


    /**
     * <p>The default context attribute under which an
     * <code>Exception</code> will be stored before passing
     * it to an exception handler chain.</p>
     */
    public static final String EXCEPTION_KEY = "exception";


    /**
     * <p>The default context attribute under which the
     * <code>ForwardConfig</code> for the current request
     * will be stored.</p>
     */
    public static final String FORWARD_CONFIG_KEY = "forwardConfig";
    
    /**
     * <p>The default context attribute under which the
     * include path for the current request
     * will be stored.</p>
     */
    public static final String INCLUDE_KEY = "include";

    /**
     * <p>The default context attribute under which the
     * <code>Locale</code> for the current request will be stored.</p>
     */
    public static final String LOCALE_KEY = "locale";


    /**
     * <p>The default context attribute under which the
     * <code>MessageResources</code> for the current request
     * will be stored.</p>
     */
    public static final String MESSAGE_RESOURCES_KEY = "messageResources";


    /**
     * <p>The default context attribute under which the
     * <code>ModuleConfig</code> for the current request
     * will be stored.</p>
     */
    public static final String MODULE_CONFIG_KEY = "moduleConfig";


    /**
     * <p>The default context attribute key under which a <code>Boolean</code>
     * is stored, indicating the valid state of the current request.  If not
     * present, a value of <code>Boolean.FALSE</code> should be assumed.
     */
    public static final String VALID_KEY = "valid";


    // --------------------------------------------------------- Other Constants


    /**
     * <p>The base part of the context attribute under which a Map containing
     * the <code>Action</code> instances associated with this module are
     * stored.  This value must be suffixed with the module prefix in order
     * to create a unique key per module.</p>
     */
    public static final String ACTIONS_KEY = "actions";


    /**
     * <p>The context attribute under which the <code>Catalog</code> containing
     * our defined command chains has been stored.</p>
     */
    public static final String CATALOG_ATTR =
        "org.apache.struts.chain.CATALOG";


    /**
     * <p>The request attribute under which the path information is stored for
     * processing during a RequestDispatcher.include() call.</p>
     */
    public static final String INCLUDE_PATH_INFO =
        "javax.servlet.include.path_info";


    /**
     * <p>The request attribute under which the servlet path is stored for
     * processing during a RequestDispatcher.include() call.</p>
     */
    public static final String INCLUDE_SERVLET_PATH =
        "javax.servlet.include.servlet_path";


}