org.apache.struts.Globals Maven / Gradle / Ivy
Show all versions of ibis-struts Show documentation
/*
* $Id: Globals.java 54929 2004-10-16 16:38:42Z germuska $
*
* Copyright 2000-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;
import java.io.Serializable;
/**
* Global manifest constants for the entire Struts Framework.
*
* @version $Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
*/
public class Globals implements Serializable {
// ----------------------------------------------------- Manifest Constants
/**
* The context attributes key under which our ActionServlet
* instance will be stored.
*
* @since Struts 1.1
*/
public static final String ACTION_SERVLET_KEY =
"org.apache.struts.action.ACTION_SERVLET";
/**
* The request attributes key under which a boolean true
* value should be stored if this request was cancelled.
*
* @since Struts 1.1
*/
public static final String CANCEL_KEY =
"org.apache.struts.action.CANCEL";
/**
* The base of the context attributes key under which our
* ModuleConfig data structure will be stored. This
* will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual attributes key.
*
* For each request processed by the controller servlet, the
* ModuleConfig object for the module selected by
* the request URI currently being processed will also be exposed under
* this key as a request attribute.
*
* @since Struts 1.1
*/
public static final String MODULE_KEY =
"org.apache.struts.action.MODULE";
/**
* The ServletContext attribute under which we store the module prefixes
* String[].
* @since Struts 1.2
*/
public static final String MODULE_PREFIXES_KEY =
"org.apache.struts.globals.MODULE_PREFIXES";
/**
* The context attributes key under which our default
* configured data source (which must implement
* javax.sql.DataSource) is stored,
* if one is configured for this module.
*/
public static final String DATA_SOURCE_KEY =
"org.apache.struts.action.DATA_SOURCE";
/**
* The request attributes key under which your action should store an
* org.apache.struts.action.ActionErrors object, if you
* are using the corresponding custom tag library elements.
*/
public static final String ERROR_KEY =
"org.apache.struts.action.ERROR";
/**
* The request attributes key under which Struts custom tags might store a
* Throwable that caused them to report a JspException at
* runtime. This value can be used on an error page to provide more
* detailed information about what really went wrong.
*/
public static final String EXCEPTION_KEY =
"org.apache.struts.action.EXCEPTION";
/**
* The session attributes key under which the user's selected
* java.util.Locale is stored, if any. If no such
* attribute is found, the system default locale
* will be used when retrieving internationalized messages. If used, this
* attribute is typically set during user login processing.
*/
public static final String LOCALE_KEY =
"org.apache.struts.action.LOCALE";
/**
* The request attributes key under which our
* org.apache.struts.ActionMapping instance
* is passed.
*/
public static final String MAPPING_KEY =
"org.apache.struts.action.mapping.instance";
/**
* The request attributes key under which your action should store an
* org.apache.struts.action.ActionMessages object, if you
* are using the corresponding custom tag library elements.
*
* @since Struts 1.1
*/
public static final String MESSAGE_KEY =
"org.apache.struts.action.ACTION_MESSAGE";
/**
* The base of the context attributes key under which our
* module MessageResources will be stored. This
* will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual resources key.
*
* For each request processed by the controller servlet, the
* MessageResources object for the module selected by
* the request URI currently being processed will also be exposed under
* this key as a request attribute.
*/
public static final String MESSAGES_KEY =
"org.apache.struts.action.MESSAGE";
/**
* The request attributes key under which our multipart class is stored.
*/
public static final String MULTIPART_KEY =
"org.apache.struts.action.mapping.multipartclass";
/**
* The base of the context attributes key under which an array of
* PlugIn instances will be stored. This
* will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual attributes key.
* @since Struts 1.1
*/
public static final String PLUG_INS_KEY =
"org.apache.struts.action.PLUG_INS";
/**
* The base of the context attributes key under which our
* RequestProcessor instance will be stored. This
* will be suffixed with the actual module prefix (including the
* leading "/" character) to form the actual attributes key.
* @since Struts 1.1
*/
public static final String REQUEST_PROCESSOR_KEY =
"org.apache.struts.action.REQUEST_PROCESSOR";
/**
* The context attributes key under which we store the mapping defined
* for our controller serlet, which will be either a path-mapped pattern
* (/action/*) or an extension mapped pattern
* (*.do).
*/
public static final String SERVLET_KEY =
"org.apache.struts.action.SERVLET_MAPPING";
/**
* The session attributes key under which our transaction token is
* stored, if it is used.
*/
public static final String TRANSACTION_TOKEN_KEY =
"org.apache.struts.action.TOKEN";
/**
* The page attributes key under which xhtml status is stored. This may be "true"
* or "false". When set to true, the html tags output xhtml.
* @since Struts 1.1
*/
public static final String XHTML_KEY =
"org.apache.struts.globals.XHTML";
}