org.apache.struts.chain.Constants Maven / Gradle / Ivy
/*
* $Id$
*
* 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.struts.chain;
import org.apache.struts.dispatcher.Dispatcher;
/**
* Global constants for the Chain of Responsibility Library.
*/
public final class Constants {
// -------------------------------------------------- Context Attribute Keys
/**
* The default context attribute under which the Action for the current
* request will be stored.
*/
public static final String ACTION_KEY = "action";
/**
* The default context attribute under which the ActionConfig for the
* current request will be stored.
*/
public static final String ACTION_CONFIG_KEY = "actionConfig";
/**
* The default context attribute under which the ActionForm for the
* current request will be stored.
*/
public static final String ACTION_FORM_KEY = "actionForm";
/**
* The default context attribute under which the ActionServet for the
* current application will be stored.
*/
public static final String ACTION_SERVLET_KEY = "actionServlet";
/**
* The default context attribute under which a boolean flag indicating
* whether this request has been cancelled will be stored.
*/
public static final String CANCEL_KEY = "cancel";
/**
* The default context attribute under which an Exception will be
* stored before passing it to an exception handler chain.
*/
public static final String EXCEPTION_KEY = "exception";
/**
* The default context attribute under which the ForwardConfig for the
* current request will be stored.
*/
public static final String FORWARD_CONFIG_KEY = "forwardConfig";
/**
* The default context attribute under which the include path for the
* current request will be stored.
*/
public static final String INCLUDE_KEY = "include";
/**
* The default context attribute under which the Locale for the current
* request will be stored.
*/
public static final String LOCALE_KEY = "locale";
/**
* The default context attribute under which the MessageResources for
* the current request will be stored.
*/
public static final String MESSAGE_RESOURCES_KEY = "messageResources";
/**
* The default context attribute under which the ModuleConfig for the
* current request will be stored.
*/
public static final String MODULE_CONFIG_KEY = "moduleConfig";
/**
* The default context attribute key under which a Boolean is stored,
* indicating the valid state of the current request. If not present, a
* value of Boolean.FALSE should be assumed.
*/
public static final String VALID_KEY = "valid";
// --------------------------------------------------------- Other Constants
/**
*
The base part of the context attribute under which a Map containing
* the Action 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.
*/
public static final String ACTIONS_KEY = "actions";
/**
* The base part of the context attribute under which a Map containing
* the Dispatcher 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.
*
* @see Dispatcher
* @since Struts 1.4
*/
public static final String DISPATCHERS_KEY = "dispatchers";
/**
* The context attribute under which the Catalog containing our defined
* command chains has been stored.
*/
public static final String CATALOG_ATTR = "org.apache.struts.chain.CATALOG";
/**
* The request attribute under which the path information is stored for
* processing during a RequestDispatcher.include() call.
*/
public static final String INCLUDE_PATH_INFO =
"jakarta.servlet.include.path_info";
/**
* The request attribute under which the servlet path is stored for
* processing during a RequestDispatcher.include() call.
*/
public static final String INCLUDE_SERVLET_PATH =
"jakarta.servlet.include.servlet_path";
}