blob: 6946e42d9598e66fa9f2667ad1b406f9fde0279c [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Fri Aug 22 03:43:57 EDT 2003 -->
<TITLE>
Globals (Apache Struts API Documentation)
</TITLE>
<META NAME="keywords" CONTENT="org.apache.struts.Globals,Globals class">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
</HEAD>
<SCRIPT>
function asd()
{
parent.document.title="Globals (Apache Struts API Documentation)";
}
</SCRIPT>
<BODY BGCOLOR="white" onload="asd();">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Globals.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Globals.html" TARGET="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.struts</FONT>
<BR>
Class Globals</H2>
<PRE>
java.lang.Object
|
+--<B>org.apache.struts.Globals</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
</DL>
<HR>
<DL>
<DT>public class <B>Globals</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL>
<P>
<p>Global manifest constants for the entire Struts Framework.</p>
<p>Many of these constants were initially defined in <code>Action</code>,
but were moved here so that they could be referenced without referencing
the <code>Action</code> class itself. For backwards compatibility,
constant references there point at this class, and the constant values
themselves have not changed.</p>
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Revision: 1.1 $ $Date$</DD>
<DT><B>Author:</B></DT>
<DD>Craig R. McClanahan</DD>
<DT><B>See Also:</B><DD><A HREF="../../../serialized-form.html" TARGET="org.apache.struts.Globals">Serialized Form</A></DL>
<HR>
<P>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Field Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#ACTION_SERVLET_KEY">ACTION_SERVLET_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The context attributes key under which our <code>ActionServlet</code>
instance will be stored.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#APPLICATION_KEY">APPLICATION_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Use MODULE_KEY</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#CANCEL_KEY">CANCEL_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The request attributes key under which a boolean <code>true</code>
value should be stored if this request was cancelled.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#DATA_SOURCE_KEY">DATA_SOURCE_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The context attributes key under which our <strong>default</strong>
configured data source (which must implement
<code>javax.sql.DataSource</code>) is stored,
if one is configured for this module.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#ERROR_KEY">ERROR_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The request attributes key under which your action should store an
<code>org.apache.struts.action.ActionErrors</code> object, if you
are using the corresponding custom tag library elements.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#EXCEPTION_KEY">EXCEPTION_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The request attributes key under which Struts custom tags might store a
<code>Throwable</code> that caused them to report a JspException at
runtime.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#FORM_BEANS_KEY">FORM_BEANS_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Replaced by collection in ModuleConfig</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#FORWARDS_KEY">FORWARDS_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Replaced by collection in ModuleConfig.</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#LOCALE_KEY">LOCALE_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The session attributes key under which the user's selected
<code>java.util.Locale</code> is stored, if any.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#MAPPING_KEY">MAPPING_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The request attributes key under which our
<code>org.apache.struts.ActionMapping</code> instance
is passed.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#MAPPINGS_KEY">MAPPINGS_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<B>Deprecated.</B>&nbsp;<I>Replaced by collection in ModuleConfig</I></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#MESSAGE_KEY">MESSAGE_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The request attributes key under which your action should store an
<code>org.apache.struts.action.ActionMessages</code> object, if you
are using the corresponding custom tag library elements.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#MESSAGES_KEY">MESSAGES_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The base of the context attributes key under which our
module <code>MessageResources</code> will be stored.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#MODULE_KEY">MODULE_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The base of the context attributes key under which our
<code>ModuleConfig</code> data structure will be stored.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#MULTIPART_KEY">MULTIPART_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The request attributes key under which our multipart class is stored.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#PLUG_INS_KEY">PLUG_INS_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The base of the context attributes key under which an array of
<code>PlugIn</code> instances will be stored.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#REQUEST_PROCESSOR_KEY">REQUEST_PROCESSOR_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The base of the context attributes key under which our
<code>RequestProcessor</code> instance will be stored.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#SERVLET_KEY">SERVLET_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The context attributes key under which we store the mapping defined
for our controller serlet, which will be either a path-mapped pattern
(<code>/action/*</code>) or an extension mapped pattern
(<code>*.do</code>).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#TRANSACTION_TOKEN_KEY">TRANSACTION_TOKEN_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The session attributes key under which our transaction token is
stored, if it is used.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#XHTML_KEY">XHTML_KEY</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The page attributes key under which xhtml status is stored.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../org/apache/struts/Globals.html#Globals()">Globals</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="ACTION_SERVLET_KEY"><!-- --></A><H3>
ACTION_SERVLET_KEY</H3>
<PRE>
public static final java.lang.String <B>ACTION_SERVLET_KEY</B></PRE>
<DL>
<DD>The context attributes key under which our <code>ActionServlet</code>
instance will be stored.
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.ACTION_SERVLET_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="APPLICATION_KEY"><!-- --></A><H3>
APPLICATION_KEY</H3>
<PRE>
public static final java.lang.String <B>APPLICATION_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Use MODULE_KEY</I>
<P>
<DD><p>The base of the context attributes key under which our
<code>ModuleConfig</code> data structure will be stored. This
will be suffixed with the actual module prefix (including the
leading "/" character) to form the actual attributes key.</p>
<p>For each request processed by the controller servlet, the
<code>ModuleConfig</code> object for the module selected by
the request URI currently being processed will also be exposed under
this key as a request attribute.</p>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.APPLICATION_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="CANCEL_KEY"><!-- --></A><H3>
CANCEL_KEY</H3>
<PRE>
public static final java.lang.String <B>CANCEL_KEY</B></PRE>
<DL>
<DD><p>The request attributes key under which a boolean <code>true</code>
value should be stored if this request was cancelled.</p>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.CANCEL_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MODULE_KEY"><!-- --></A><H3>
MODULE_KEY</H3>
<PRE>
public static final java.lang.String <B>MODULE_KEY</B></PRE>
<DL>
<DD><p>The base of the context attributes key under which our
<code>ModuleConfig</code> data structure will be stored. This
will be suffixed with the actual module prefix (including the
leading "/" character) to form the actual attributes key.</p>
<p>For each request processed by the controller servlet, the
<code>ModuleConfig</code> object for the module selected by
the request URI currently being processed will also be exposed under
this key as a request attribute.</p>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.MODULE_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DATA_SOURCE_KEY"><!-- --></A><H3>
DATA_SOURCE_KEY</H3>
<PRE>
public static final java.lang.String <B>DATA_SOURCE_KEY</B></PRE>
<DL>
<DD>The context attributes key under which our <strong>default</strong>
configured data source (which must implement
<code>javax.sql.DataSource</code>) is stored,
if one is configured for this module.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.DATA_SOURCE_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="ERROR_KEY"><!-- --></A><H3>
ERROR_KEY</H3>
<PRE>
public static final java.lang.String <B>ERROR_KEY</B></PRE>
<DL>
<DD>The request attributes key under which your action should store an
<code>org.apache.struts.action.ActionErrors</code> object, if you
are using the corresponding custom tag library elements.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.ERROR_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="EXCEPTION_KEY"><!-- --></A><H3>
EXCEPTION_KEY</H3>
<PRE>
public static final java.lang.String <B>EXCEPTION_KEY</B></PRE>
<DL>
<DD>The request attributes key under which Struts custom tags might store a
<code>Throwable</code> 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.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.EXCEPTION_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FORM_BEANS_KEY"><!-- --></A><H3>
FORM_BEANS_KEY</H3>
<PRE>
public static final java.lang.String <B>FORM_BEANS_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Replaced by collection in ModuleConfig</I>
<P>
<DD>The context attributes key under which our
<code>org.apache.struts.action.ActionFormBeans</code> collection
is normally stored, unless overridden when initializing our
ActionServlet.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.FORM_BEANS_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="FORWARDS_KEY"><!-- --></A><H3>
FORWARDS_KEY</H3>
<PRE>
public static final java.lang.String <B>FORWARDS_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Replaced by collection in ModuleConfig.</I>
<P>
<DD>The context attributes key under which our
<code>org.apache.struts.action.ActionForwards</code> collection
is normally stored, unless overridden when initializing our
ActionServlet.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.FORWARDS_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="LOCALE_KEY"><!-- --></A><H3>
LOCALE_KEY</H3>
<PRE>
public static final java.lang.String <B>LOCALE_KEY</B></PRE>
<DL>
<DD>The session attributes key under which the user's selected
<code>java.util.Locale</code> 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.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.LOCALE_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MAPPING_KEY"><!-- --></A><H3>
MAPPING_KEY</H3>
<PRE>
public static final java.lang.String <B>MAPPING_KEY</B></PRE>
<DL>
<DD>The request attributes key under which our
<code>org.apache.struts.ActionMapping</code> instance
is passed.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.MAPPING_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MAPPINGS_KEY"><!-- --></A><H3>
MAPPINGS_KEY</H3>
<PRE>
public static final java.lang.String <B>MAPPINGS_KEY</B></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>Replaced by collection in ModuleConfig</I>
<P>
<DD>The context attributes key under which our
<code>org.apache.struts.action.ActionMappings</code> collection
is normally stored, unless overridden when initializing our
ActionServlet.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.MAPPINGS_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MESSAGE_KEY"><!-- --></A><H3>
MESSAGE_KEY</H3>
<PRE>
public static final java.lang.String <B>MESSAGE_KEY</B></PRE>
<DL>
<DD>The request attributes key under which your action should store an
<code>org.apache.struts.action.ActionMessages</code> object, if you
are using the corresponding custom tag library elements.
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.MESSAGE_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MESSAGES_KEY"><!-- --></A><H3>
MESSAGES_KEY</H3>
<PRE>
public static final java.lang.String <B>MESSAGES_KEY</B></PRE>
<DL>
<DD><p>The base of the context attributes key under which our
module <code>MessageResources</code> will be stored. This
will be suffixed with the actual module prefix (including the
leading "/" character) to form the actual resources key.</p>
<p>For each request processed by the controller servlet, the
<code>MessageResources</code> object for the module selected by
the request URI currently being processed will also be exposed under
this key as a request attribute.</p>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.MESSAGES_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="MULTIPART_KEY"><!-- --></A><H3>
MULTIPART_KEY</H3>
<PRE>
public static final java.lang.String <B>MULTIPART_KEY</B></PRE>
<DL>
<DD>The request attributes key under which our multipart class is stored.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.MULTIPART_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="PLUG_INS_KEY"><!-- --></A><H3>
PLUG_INS_KEY</H3>
<PRE>
public static final java.lang.String <B>PLUG_INS_KEY</B></PRE>
<DL>
<DD><p>The base of the context attributes key under which an array of
<code>PlugIn</code> instances will be stored. This
will be suffixed with the actual module prefix (including the
leading "/" character) to form the actual attributes key.</p>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.PLUG_INS_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="REQUEST_PROCESSOR_KEY"><!-- --></A><H3>
REQUEST_PROCESSOR_KEY</H3>
<PRE>
public static final java.lang.String <B>REQUEST_PROCESSOR_KEY</B></PRE>
<DL>
<DD><p>The base of the context attributes key under which our
<code>RequestProcessor</code> instance will be stored. This
will be suffixed with the actual module prefix (including the
leading "/" character) to form the actual attributes key.</p>
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.REQUEST_PROCESSOR_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="SERVLET_KEY"><!-- --></A><H3>
SERVLET_KEY</H3>
<PRE>
public static final java.lang.String <B>SERVLET_KEY</B></PRE>
<DL>
<DD>The context attributes key under which we store the mapping defined
for our controller serlet, which will be either a path-mapped pattern
(<code>/action/*</code>) or an extension mapped pattern
(<code>*.do</code>).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.SERVLET_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="TRANSACTION_TOKEN_KEY"><!-- --></A><H3>
TRANSACTION_TOKEN_KEY</H3>
<PRE>
public static final java.lang.String <B>TRANSACTION_TOKEN_KEY</B></PRE>
<DL>
<DD>The session attributes key under which our transaction token is
stored, if it is used.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.TRANSACTION_TOKEN_KEY">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="XHTML_KEY"><!-- --></A><H3>
XHTML_KEY</H3>
<PRE>
public static final java.lang.String <B>XHTML_KEY</B></PRE>
<DL>
<DD>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.
<P>
<DL>
<DT><B>Since:</B></DT>
<DD>Struts 1.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.apache.struts.Globals.XHTML_KEY">Constant Field Values</A></DL>
</DL>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="Globals()"><!-- --></A><H3>
Globals</H3>
<PRE>
public <B>Globals</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Globals.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Globals.html" TARGET="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;
<SCRIPT>
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#methods_inherited_from_class_java.lang.Object">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;METHOD</FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright © 2000-2003 - Apache Software Foundation
</BODY>
</HTML>