http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/5be16a28/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/executor.html ---------------------------------------------------------------------- diff --git a/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/executor.html b/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/executor.html new file mode 100644 index 0000000..374dc5f --- /dev/null +++ b/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/executor.html @@ -0,0 +1,66 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference - The Executor (thread pool)</title><meta content="Filip Hanik" name="author"><style media="print" type="text/css"> + .noPrint {display: none;} + td#mainBody {width: 100%;} + </style></head><body vlink="#525D76" alink="#525D76" link="#525D76" text="#000000" bgcolor="#ffffff"><table cellspacing="0" width="100%" border="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/";><img border="0" alt=" + The Apache Tomcat Servlet/JSP Container + " align="right" src="../images/tomcat.gif"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 6.0</font></h1></td><td><!--APACHE LOGO--><a href="http://www.apache.org/";><img border="0" alt="Apache Logo" align="right" src="../images/asf-logo.gif"></a></td></tr></table><table cellspacing="4" width="100%" border="0"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><tr><!--LEFT SIDE NAVIGATION--><td class="noPrint" nowrap valign="top" width="20%"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li><li><a href="index.html">Config Ref. Home</a></li></ul><p><strong>Top Level Elements</strong></p><ul><li><a href="server.html">Server</a></li><li><a href="service.html">Service</a></li></ul><p><strong>Executors</strong></p><ul><li><a href="executor.html">Executor</a></li></ul><p><strong>Connectors</strong></p><ul><li><a href="http.html">HTTP</a></li><li><a href="ajp.html">AJP</a></li></ul><p><strong>Containers</strong></p> <ul><li><a href="context.html">Context</a></li><li><a href="engine.html">Engine</a></li><li><a href="host.html">Host</a></li><li><a href="cluster.html">Cluster</a></li></ul><p><strong>Nested Components</strong></p><ul><li><a href="listeners.html">Listeners</a></li><li><a href="globalresources.html">Global Resources</a></li><li><a href="loader.html">Loader</a></li><li><a href="manager.html">Manager</a></li><li><a href="realm.html">Realm</a></li><li><a href="resources.html">Resources</a></li><li><a href="valve.html">Valve</a></li></ul><p><strong>Cluster Elements</strong></p><ul><li><a href="cluster.html">Cluster</a></li><li><a href="cluster-manager.html">Manager</a></li><li><a href="cluster-channel.html">Channel</a></li><li><a href="cluster-membership.html">Channel/Membership</a></li><li><a href="cluster-sender.html">Channel/Sender</a></li><li><a href="cluster-receiver.html">Channel/Receiver</a></li><li><a href="cluster-interceptor.html">Channel/Interceptor</a></li><li><a href="cluste r-valve.html">Valve</a></li><li><a href="cluster-deployer.html">Deployer</a></li><li><a href="cluster-listener.html">ClusterListener</a></li></ul><p><strong>Global Settings</strong></p><ul><li><a href="systemprops.html">System properties</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td id="mainBody" align="left" valign="top" width="80%"><h1>Apache Tomcat Configuration Reference</h1><h2>The Executor (thread pool)</h2><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote> +<ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Attributes">Attributes</a><ol><li><a href="#Common_Attributes">Common Attributes</a></li><li><a href="#Standard_Implementation">Standard Implementation</a></li></ol></li></ul> +</blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> + + <p>The <strong>Executor</strong> represents a thread pool that can be shared + between components in Tomcat. Historically there has been a thread pool per + connector created but this allows you to share a thread pool, between (primarly) connector + but also other components when those get configured to support executors</p> + + + <p>The executor has to implement the <code>org.apache.catalina.Executor</code> interface.</p> + + <p>The executor is a nested element to the <a href="service.html">Service</a> element. + And in order for it to be picked up by the connectors, the Executor element has to appear + prior to the Connector element in server.xml</p> +</blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Common Attributes"><!--()--></a><a name="Common_Attributes"><strong>Common Attributes</strong></a></font></td></tr><tr><td><blockquote> + + <p>All implementations of <strong>Executor</strong> + support the following attributes:</p> + + <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><code>className</code></td><td valign="center" align="left"> + <p>The class of the implementation. The implementation has to implement the + <code>org.apache.catalina.Executor</code> interface. + This interface ensures that the object can be referenced through its <code>name</code> attribute + and that implements Lifecycle, so that it can be started and stopped with the container. + The default value for the className is <code>org.apache.catalina.core.StandardThreadExecutor</code></p> + </td></tr><tr><td valign="center" align="left"><strong><code>name</code></strong></td><td valign="center" align="left"> + <p>The name used to reference this pool in other places in server.xml. + The name is required and must be unique.</p> + </td></tr></table> + + </blockquote></td></tr></table> + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Standard Implementation"><!--()--></a><a name="Standard_Implementation"><strong>Standard Implementation</strong></a></font></td></tr><tr><td><blockquote> + + <p> + The default implementation supports the following attributes:</p> + + <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><code>threadPriority</code></td><td valign="center" align="left"> + <p>(int) The thread priority for threads in the executor, the default is <code>Thread.NORM_PRIORITY</code></p> + </td></tr><tr><td valign="center" align="left"><code>daemon</code></td><td valign="center" align="left"> + <p>(boolean) Whether the threads should be daemon threads or not, the default is <code>true</code></p> + </td></tr><tr><td valign="center" align="left"><code>namePrefix</code></td><td valign="center" align="left"> + <p>(String) The name prefix for each thread created by the executor. + The thread name for an individual thread will be <code>namePrefix+threadNumber</code></p> + </td></tr><tr><td valign="center" align="left"><code>maxThreads</code></td><td valign="center" align="left"> + <p>(int) The max number of active threads in this pool, default is <code>200</code></p> + </td></tr><tr><td valign="center" align="left"><code>minSpareThreads</code></td><td valign="center" align="left"> + <p>(int) The minimum number of threads always kept alive, default is <code>25</code></p> + </td></tr><tr><td valign="center" align="left"><code>maxIdleTime</code></td><td valign="center" align="left"> + <p>(int) The number of milliseconds before an idle thread shutsdown, unless the number of active threads are less + or equal to minSpareThreads. Default value is <code>60000</code>(1 minute)</p> + </td></tr></table> + + + </blockquote></td></tr></table> +</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font size="-1" color="#525D76"><em> + Copyright © 1999-2010, Apache Software Foundation + </em></font></div></td></tr></table></body></html> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/5be16a28/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/globalresources.html ---------------------------------------------------------------------- diff --git a/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/globalresources.html b/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/globalresources.html new file mode 100644 index 0000000..aafb68c --- /dev/null +++ b/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/globalresources.html @@ -0,0 +1,202 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference - The GlobalNamingResources Component</title><meta content="Remy Maucherat" name="author"><meta content="Yoav Shapira" name="author"><style media="print" type="text/css"> + .noPrint {display: none;} + td#mainBody {width: 100%;} + </style></head><body vlink="#525D76" alink="#525D76" link="#525D76" text="#000000" bgcolor="#ffffff"><table cellspacing="0" width="100%" border="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/";><img border="0" alt=" + The Apache Tomcat Servlet/JSP Container + " align="right" src="../images/tomcat.gif"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 6.0</font></h1></td><td><!--APACHE LOGO--><a href="http://www.apache.org/";><img border="0" alt="Apache Logo" align="right" src="../images/asf-logo.gif"></a></td></tr></table><table cellspacing="4" width="100%" border="0"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><tr><!--LEFT SIDE NAVIGATION--><td class="noPrint" nowrap valign="top" width="20%"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li><li><a href="index.html">Config Ref. Home</a></li></ul><p><strong>Top Level Elements</strong></p><ul><li><a href="server.html">Server</a></li><li><a href="service.html">Service</a></li></ul><p><strong>Executors</strong></p><ul><li><a href="executor.html">Executor</a></li></ul><p><strong>Connectors</strong></p><ul><li><a href="http.html">HTTP</a></li><li><a href="ajp.html">AJP</a></li></ul><p><strong>Containers</strong></p> <ul><li><a href="context.html">Context</a></li><li><a href="engine.html">Engine</a></li><li><a href="host.html">Host</a></li><li><a href="cluster.html">Cluster</a></li></ul><p><strong>Nested Components</strong></p><ul><li><a href="listeners.html">Listeners</a></li><li><a href="globalresources.html">Global Resources</a></li><li><a href="loader.html">Loader</a></li><li><a href="manager.html">Manager</a></li><li><a href="realm.html">Realm</a></li><li><a href="resources.html">Resources</a></li><li><a href="valve.html">Valve</a></li></ul><p><strong>Cluster Elements</strong></p><ul><li><a href="cluster.html">Cluster</a></li><li><a href="cluster-manager.html">Manager</a></li><li><a href="cluster-channel.html">Channel</a></li><li><a href="cluster-membership.html">Channel/Membership</a></li><li><a href="cluster-sender.html">Channel/Sender</a></li><li><a href="cluster-receiver.html">Channel/Receiver</a></li><li><a href="cluster-interceptor.html">Channel/Interceptor</a></li><li><a href="cluste r-valve.html">Valve</a></li><li><a href="cluster-deployer.html">Deployer</a></li><li><a href="cluster-listener.html">ClusterListener</a></li></ul><p><strong>Global Settings</strong></p><ul><li><a href="systemprops.html">System properties</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td id="mainBody" align="left" valign="top" width="80%"><h1>Apache Tomcat Configuration Reference</h1><h2>The GlobalNamingResources Component</h2><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote> +<ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Attributes">Attributes</a></li><li><a href="#Nested_Components">Nested Components</a></li><li><a href="#Special_Features">Special Features</a><ol><li><a href="#Environment_Entries">Environment Entries</a></li><li><a href="#Resource_Definitions">Resource Definitions</a></li><li><a href="#Resource_Links">Resource Links</a></li><li><a href="#Transaction">Transaction</a></li></ol></li></ul> +</blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> + + <p>The <strong>GlobalNamingResources</strong> element defines the global + JNDI resources for the <a href="server.html">Server</a>.</p> + + <p>These resources are listed in the server's global JNDI resource context. + This context is distinct from the per-web-application JNDI contexts + described in + the <a href="../jndi-resources-howto.html">JNDI Resources HOW-TO</a>. + The resources defined in this element are <strong>not</strong> visible in + the per-web-application contexts unless you explicitly link them with + <a href="context.html#Resource Links"><ResourceLink></a> elements. + </p> + +</blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> + +</blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Nested Components"><!--()--></a><a name="Nested_Components"><strong>Nested Components</strong></a></font></td></tr><tr><td><blockquote> + +</blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Special Features"><!--()--></a><a name="Special_Features"><strong>Special Features</strong></a></font></td></tr><tr><td><blockquote> + + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Environment Entries"><!--()--></a><a name="Environment_Entries"><strong>Environment Entries</strong></a></font></td></tr><tr><td><blockquote> + + <p>You can configure named values that will be made visible to all + web applications as environment entry resources by nesting + <code><Environment></code> entries inside this element. For + example, you can create an environment entry like this:</p> +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +<GlobalNamingResources ...> + ... + <Environment name="maxExemptions" value="10" + type="java.lang.Integer" override="false"/> + ... +</GlobalNamingResources> +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + <p>This is equivalent to the inclusion of the following element in the + web application deployment descriptor (<code>/WEB-INF/web.xml</code>): + </p> +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +<env-entry> + <env-entry-name>maxExemptions</env-entry-name> + <env-entry-value>10</env-entry-value> + <env-entry-type>java.lang.Integer</env-entry-type> +</env-entry> +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + <p>but does <em>not</em> require modification of the deployment descriptor + to customize this value.</p> + + <p>The valid attributes for an <code><Environment></code> element + are as follows:</p> + + <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><code>description</code></td><td valign="center" align="left"> + <p>Optional, human-readable description of this environment entry.</p> + </td></tr><tr><td valign="center" align="left"><strong><code>name</code></strong></td><td valign="center" align="left"> + <p>The name of the environment entry to be created, relative to the + <code>java:comp/env</code> context.</p> + </td></tr><tr><td valign="center" align="left"><code>override</code></td><td valign="center" align="left"> + <p>Set this to <code>false</code> if you do <strong>not</strong> want + an <code><env-entry></code> for the same environment entry name, + found in the web application deployment descriptor, to override the + value specified here. By default, overrides are allowed.</p> + </td></tr><tr><td valign="center" align="left"><strong><code>type</code></strong></td><td valign="center" align="left"> + <p>The fully qualified Java class name expected by the web application + for this environment entry. Must be one of the legal values for + <code><env-entry-type></code> in the web application deployment + descriptor: <code>java.lang.Boolean</code>, + <code>java.lang.Byte</code>, <code>java.lang.Character</code>, + <code>java.lang.Double</code>, <code>java.lang.Float</code>, + <code>java.lang.Integer</code>, <code>java.lang.Long</code>, + <code>java.lang.Short</code>, or <code>java.lang.String</code>.</p> + </td></tr><tr><td valign="center" align="left"><strong><code>value</code></strong></td><td valign="center" align="left"> + <p>The parameter value that will be presented to the application + when requested from the JNDI context. This value must be convertable + to the Java type defined by the <code>type</code> attribute.</p> + </td></tr></table> + + </blockquote></td></tr></table> + + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Resource Definitions"><!--()--></a><a name="Resource_Definitions"><strong>Resource Definitions</strong></a></font></td></tr><tr><td><blockquote> + + <p>You can declare the characteristics of resources + to be returned for JNDI lookups of <code><resource-ref></code> and + <code><resource-env-ref></code> elements in the web application + deployment descriptor by defining them in this element and then linking + them with <a href="context.html#Resource Links"><ResourceLink></a> + elements + in the <code><strong><Context></strong></code> element. + + You <strong>MUST</strong> also define any other needed parameters using + attributes on the Resource element, to configure + the object factory to be used (if not known to Tomcat already), and + the properties used to configure that object factory.</p> + + <p>For example, you can create a resource definition like this:</p> +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +<GlobalNamingResources ...> + ... + <Resource name="jdbc/EmployeeDB" auth="Container" + type="javax.sql.DataSource" + description="Employees Database for HR Applications"/> + ... +</GlobalNamingResources> +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + <p>This is equivalent to the inclusion of the following element in the + web application deployment descriptor (<code>/WEB-INF/web.xml</code>):</p> +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +<resource-ref> + <description>Employees Database for HR Applications</description> + <res-ref-name>jdbc/EmployeeDB</res-ref-name> + <res-ref-type>javax.sql.DataSource</res-ref-type> + <res-auth>Container</res-auth> +</resource-ref> +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + <p>but does <em>not</em> require modification of the deployment + descriptor to customize this value.</p> + + <p>The valid attributes for a <code><Resource></code> element + are as follows:</p> + + <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><code>auth</code></td><td valign="center" align="left"> + <p>Specify whether the web Application code signs on to the + corresponding resource manager programmatically, or whether the + Container will sign on to the resource manager on behalf of the + application. The value of this attribute must be + <code>Application</code> or <code>Container</code>. This + attribute is <strong>required</strong> if the web application + will use a <code><resource-ref></code> element in the web + application deployment descriptor, but is optional if the + application uses a <code><resource-env-ref></code> instead.</p> + </td></tr><tr><td valign="center" align="left"><code>description</code></td><td valign="center" align="left"> + <p>Optional, human-readable description of this resource.</p> + </td></tr><tr><td valign="center" align="left"><strong><code>name</code></strong></td><td valign="center" align="left"> + <p>The name of the resource to be created, relative to the + <code>java:comp/env</code> context.</p> + </td></tr><tr><td valign="center" align="left"><code>scope</code></td><td valign="center" align="left"> + <p>Specify whether connections obtained through this resource + manager can be shared. The value of this attribute must be + <code>Shareable</code> or <code>Unshareable</code>. By default, + connections are assumed to be shareable.</p> + </td></tr><tr><td valign="center" align="left"><strong><code>type</code></strong></td><td valign="center" align="left"> + <p>The fully qualified Java class name expected by the web + application when it performs a lookup for this resource.</p> + </td></tr></table> + + + </blockquote></td></tr></table> + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Resource Links"><!--()--></a><a name="Resource_Links"><strong>Resource Links</strong></a></font></td></tr><tr><td><blockquote> + <p>Use <a href="context.html#Resource Links"><ResourceLink></a> + elements to link resources from the global context into + per-web-application contexts. Here is an example of making a custom + factory available to an application, based on the example definition in the + <a href="../jndi-resources-howto.html#Generic JavaBean Resources"> + JNDI Resource HOW-TO</a>: + </p> + + <div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> + + <Context> + <ResourceLink + name="bean/MyBeanFactory" + global="bean/MyBeanFactory" + type="com.mycompany.MyBean" + /> + </Context> + + </pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + </blockquote></td></tr></table> + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Transaction"><strong>Transaction</strong></a></font></td></tr><tr><td><blockquote> + + <p>You can declare the characteristics of the UserTransaction + to be returned for JNDI lookup for <code>java:comp/UserTransaction</code>. + You <strong>MUST</strong> define an object factory class to instantiate + this object as well as the needed resource parameters as attributes of the + <code>Transaction</code> + element, and the properties used to configure that object factory.</p> + + <p>The valid attributes for the <code><Transaction></code> element + are as follows:</p> + + <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><strong><code>factory</code></strong></td><td valign="center" align="left"> + <p>The class name for the JNDI object factory.</p> + </td></tr></table> + + </blockquote></td></tr></table> + +</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font size="-1" color="#525D76"><em> + Copyright © 1999-2010, Apache Software Foundation + </em></font></div></td></tr></table></body></html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/flex-blazeds/blob/5be16a28/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/host.html ---------------------------------------------------------------------- diff --git a/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/host.html b/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/host.html new file mode 100644 index 0000000..2ecbf38 --- /dev/null +++ b/attic/servers/apache-tomcat-6.0.29/webapps/docs/config/host.html @@ -0,0 +1,548 @@ +<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference - The Host Container</title><meta content="Craig R. McClanahan" name="author"><meta content="Remy Maucherat" name="author"><meta content="Yoav Shapira" name="author"><style media="print" type="text/css"> + .noPrint {display: none;} + td#mainBody {width: 100%;} + </style></head><body vlink="#525D76" alink="#525D76" link="#525D76" text="#000000" bgcolor="#ffffff"><table cellspacing="0" width="100%" border="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/";><img border="0" alt=" + The Apache Tomcat Servlet/JSP Container + " align="right" src="../images/tomcat.gif"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 6.0</font></h1></td><td><!--APACHE LOGO--><a href="http://www.apache.org/";><img border="0" alt="Apache Logo" align="right" src="../images/asf-logo.gif"></a></td></tr></table><table cellspacing="4" width="100%" border="0"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><tr><!--LEFT SIDE NAVIGATION--><td class="noPrint" nowrap valign="top" width="20%"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li><li><a href="index.html">Config Ref. Home</a></li></ul><p><strong>Top Level Elements</strong></p><ul><li><a href="server.html">Server</a></li><li><a href="service.html">Service</a></li></ul><p><strong>Executors</strong></p><ul><li><a href="executor.html">Executor</a></li></ul><p><strong>Connectors</strong></p><ul><li><a href="http.html">HTTP</a></li><li><a href="ajp.html">AJP</a></li></ul><p><strong>Containers</strong></p> <ul><li><a href="context.html">Context</a></li><li><a href="engine.html">Engine</a></li><li><a href="host.html">Host</a></li><li><a href="cluster.html">Cluster</a></li></ul><p><strong>Nested Components</strong></p><ul><li><a href="listeners.html">Listeners</a></li><li><a href="globalresources.html">Global Resources</a></li><li><a href="loader.html">Loader</a></li><li><a href="manager.html">Manager</a></li><li><a href="realm.html">Realm</a></li><li><a href="resources.html">Resources</a></li><li><a href="valve.html">Valve</a></li></ul><p><strong>Cluster Elements</strong></p><ul><li><a href="cluster.html">Cluster</a></li><li><a href="cluster-manager.html">Manager</a></li><li><a href="cluster-channel.html">Channel</a></li><li><a href="cluster-membership.html">Channel/Membership</a></li><li><a href="cluster-sender.html">Channel/Sender</a></li><li><a href="cluster-receiver.html">Channel/Receiver</a></li><li><a href="cluster-interceptor.html">Channel/Interceptor</a></li><li><a href="cluste r-valve.html">Valve</a></li><li><a href="cluster-deployer.html">Deployer</a></li><li><a href="cluster-listener.html">ClusterListener</a></li></ul><p><strong>Global Settings</strong></p><ul><li><a href="systemprops.html">System properties</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td id="mainBody" align="left" valign="top" width="80%"><h1>Apache Tomcat Configuration Reference</h1><h2>The Host Container</h2><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote> +<ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Attributes">Attributes</a><ol><li><a href="#Common_Attributes">Common Attributes</a></li><li><a href="#Standard_Implementation">Standard Implementation</a></li></ol></li><li><a href="#Nested_Components">Nested Components</a></li><li><a href="#Special_Features">Special Features</a><ol><li><a href="#Logging">Logging</a></li><li><a href="#Access_Logs">Access Logs</a></li><li><a href="#Automatic_Application_Deployment">Automatic Application Deployment</a></li><li><a href="#Host_Name_Aliases">Host Name Aliases</a></li><li><a href="#Lifecycle_Listeners">Lifecycle Listeners</a></li><li><a href="#Request_Filters">Request Filters</a></li><li><a href="#Single_Sign_On">Single Sign On</a></li><li><a href="#User_Web_Applications">User Web Applications</a></li></ol></li></ul> +</blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> + + <p>The <strong>Host</strong> element represents a <em>virtual host</em>, + which is an association of a network name for a server (such as + "www.mycompany.com" with the particular server on which Catalina is + running. In order to be effective, this name must be registered in the + <em>Domain Name Service</em> (DNS) server that manages the Internet + domain you belong to - contact your Network Administrator for more + information.</p> + + <p>In many cases, System Administrators wish to associate more than + one network name (such as <code>www.mycompany.com</code> and + <code>company.com</code>) with the same virtual host and applications. + This can be accomplished using the <a href="#Host Name Aliases">Host + Name Aliases</a> feature discussed below.</p> + + <p>One or more <strong>Host</strong> elements are nested inside an + <a href="engine.html">Engine</a> element. Inside the Host element, you + can nest <a href="context.html">Context</a> elements for the web + applications associated with this virtual host. Exactly one of the Hosts + associated with each Engine MUST have a name matching the + <code>defaultHost</code> attribute of that Engine.</p> + + <blockquote><em> + <p>The description below uses the variable name $CATALINA_BASE to refer the + base directory against which most relative paths are resolved. If you have + not configured Tomcat for multiple instances by setting a CATALINA_BASE + directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME, + the directory into which you have installed Tomcat.</p> + </em></blockquote> + +</blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Common Attributes"><!--()--></a><a name="Common_Attributes"><strong>Common Attributes</strong></a></font></td></tr><tr><td><blockquote> + + <p>All implementations of <strong>Host</strong> + support the following attributes:</p> + + <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><strong><code>appBase</code></strong></td><td valign="center" align="left"> + <p>The <em>Application Base</em> directory for this virtual host. + This is the pathname of a directory that may contain web applications + to be deployed on this virtual host. You may specify an + absolute pathname, or a pathname that is relative to the + <code>$CATALINA_BASE</code> directory. See + <a href="#Automatic Application Deployment">Automatic Application + Deployment</a> for more information on automatic recognition and + deployment of web applications. If not specified, the default of + <code>webapps</code> will be used.</p> + </td></tr><tr><td valign="center" align="left"><code>autoDeploy</code></td><td valign="center" align="left"> + <p>This flag value indicates if Tomcat should check periodically for new + or updated web applications while Tomcat is running. If true, Tomcat + periodically checks the <code>appBase</code> and + <code>$CATALINA_BASE/conf/[engine_name]/[host_name]</code> + directories and deploys any new web applications or context XML + descriptors found. Updated web applications or context XML descriptors + will trigger a reload of the web application. The flag's value defaults + to true. See + <a href="#Automatic Application Deployment">Automatic Application + Deployment</a> for more information.</p> + </td></tr><tr><td valign="center" align="left"><code>backgroundProcessorDelay</code></td><td valign="center" align="left"> + <p>This value represents the delay in seconds between the + invocation of the backgroundProcess method on this host and + its child containers, including all contexts. + Child containers will not be invoked if their delay value is not + negative (which would mean they are using their own processing + thread). Setting this to a positive value will cause + a thread to be spawn. After waiting the specified amount of time, + the thread will invoke the backgroundProcess method on this host + and all its child containers. A host will use background processing to + perform live web application deployment related tasks. If not + specified, the default value for this attribute is -1, which means + the host will rely on the background processing thread of its parent + engine.</p> + </td></tr><tr><td valign="center" align="left"><code>className</code></td><td valign="center" align="left"> + <p>Java class name of the implementation to use. This class must + implement the <code>org.apache.catalina.Host</code> interface. + If not specified, the standard value (defined below) will be used.</p> + </td></tr><tr><td valign="center" align="left"><code>deployOnStartup</code></td><td valign="center" align="left"> + <p>This flag value indicates if web applications from this host should + be automatically deployed when Tomcat starts. The flag's value defaults + to true. See + <a href="#Automatic Application Deployment">Automatic Application + Deployment</a> for more information.</p> + </td></tr><tr><td valign="center" align="left"><strong><code>name</code></strong></td><td valign="center" align="left"> + <p>Network name of this virtual host, as registered in your + <em>Domain Name Service</em> server. Regardless of the case used to + specify the hostname, Tomcat will convert it to lower case internally. + One of the Hosts nested within an <a href="engine.html">Engine</a> MUST + have a name that matches the <code>defaultHost</code> setting for that + Engine. See <a href="#Host Name Aliases">Host Name Aliases</a> for + information on how to assign more than one network name to the same + virtual host.</p> + </td></tr></table> + + </blockquote></td></tr></table> + + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Standard Implementation"><!--()--></a><a name="Standard_Implementation"><strong>Standard Implementation</strong></a></font></td></tr><tr><td><blockquote> + + <p>The standard implementation of <strong>Host</strong> is + <strong>org.apache.catalina.core.StandardHost</strong>. + It supports the following additional attributes (in addition to the + common attributes listed above):</p> + + <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><code>deployXML</code></td><td valign="center" align="left"> + <p>Set to <code>false</code> if you want to disable parsing the context + XML descriptor embedded inside the application (located at + <code>/META-INF/context.xml</code>). Security conscious environments + should set this to <code>false</code> to prevent applications from + interacting with the container's configuration. The administrator will + then be responsible for providing an external context configuration + file, and putting it in + <code>$CATALINA_BASE/conf/[engine_name]/[host_name]</code>. The flag's + value defaults to <code>true</code>.</p> + </td></tr><tr><td valign="center" align="left"><code>errorReportValveClass</code></td><td valign="center" align="left"> + <p>Java class name of the error reporting valve which will be used + by this Host. The responsibility of this valve is to output error + reports. Setting this property allows to customize the look of the + error pages which will be generated by Tomcat. This class must + implement the + <code>org.apache.catalina.Valve</code> interface. If none is specified, + the value <code>org.apache.catalina.valves.ErrorReportValve</code> + will be used by default.</p> + </td></tr><tr><td valign="center" align="left"><code>unpackWARs</code></td><td valign="center" align="left"> + <p>Set to <code>true</code> if you want web applications that are + placed in the <code>appBase</code> directory as web application + archive (WAR) files to be unpacked into a corresponding disk directory + structure, <code>false</code> to run such web applications directly + from a WAR file. WAR files located outside of the Host's + <strong>appBase</strong> will not be expanded. See + <a href="#Automatic Application Deployment">Automatic Application + Deployment</a> for more information.</p> + </td></tr><tr><td valign="center" align="left"><code>workDir</code></td><td valign="center" align="left"> + <p>Pathname to a scratch directory to be used by applications for + this Host. Each application will have its own sub directory with + temporary read-write use. Configuring a Context workDir will override + use of the Host workDir configuration. This directory will be made + visible to servlets in the web application by a servlet context + attribute (of type <code>java.io.File</code>) named + <code>javax.servlet.context.tempdir</code> as described in the + Servlet Specification. If not specified, a suitable directory + underneath <code>$CATALINA_BASE/work</code> will be provided.</p> + </td></tr></table> + + </blockquote></td></tr></table> + + +</blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Nested Components"><!--()--></a><a name="Nested_Components"><strong>Nested Components</strong></a></font></td></tr><tr><td><blockquote> + + <p>You can nest one or more <a href="context.html">Context</a> elements + inside this <strong>Host</strong> element, each representing a different web + application associated with this virtual host.</p> + + <p>You can nest at most one instance of the following utility components + by nesting a corresponding element inside your <strong>Host</strong> + element:</p> + <ul> + <li><a href="realm.html"><strong>Realm</strong></a> - + Configure a realm that will allow its + database of users, and their associated roles, to be shared across all + <a href="context.html">Contexts</a> nested inside this Host (unless + overridden by a <a href="realm.html">Realm</a> configuration + at a lower level).</li> + </ul> + +</blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Special Features"><!--()--></a><a name="Special_Features"><strong>Special Features</strong></a></font></td></tr><tr><td><blockquote> + + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Logging"><strong>Logging</strong></a></font></td></tr><tr><td><blockquote> + + <p>A host is associated with the + <code>org.apache.catalina.core.ContainerBase.[engine_name].[host_name]</code> + log category. Note that the brackets are part of the name, + don't omit them.</p> + + </blockquote></td></tr></table> + + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Access Logs"><!--()--></a><a name="Access_Logs"><strong>Access Logs</strong></a></font></td></tr><tr><td><blockquote> + + <p>When you run a web server, one of the output files normally generated + is an <em>access log</em>, which generates one line of information for + each request processed by the server, in a standard format. Catalina + includes an optional <a href="valve.html">Valve</a> implementation that + can create access logs in the same standard format created by web servers, + or in any number of custom formats.</p> + + <p>You can ask Catalina to create an access log for all requests + processed by an <a href="engine.html">Engine</a>, + <a href="host.html">Host</a>, or <a href="context.html">Context</a> + by nesting a <a href="valve.html">Valve</a> element like this:</p> + +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +<Host name="localhost" ...> + ... + <Valve className="org.apache.catalina.valves.AccessLogValve" + prefix="localhost_access_log." suffix=".txt" + pattern="common"/> + ... +</Host> +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + <p>See <a href="valve.html#Access Log Valve">Access Log Valve</a> + for more information on the configuration attributes that are + supported.</p> + + </blockquote></td></tr></table> + + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Automatic Application Deployment"><!--()--></a><a name="Automatic_Application_Deployment"><strong>Automatic Application Deployment</strong></a></font></td></tr><tr><td><blockquote> + + <p>If you are using the standard <strong>Host</strong> implementation, + the following actions take place automatically when Catalina is first + started, if the <code>deployOnStartup</code> property is set to + <code>true</code> (which is the default value):</p> + <ul> + <li>Any XML file in + <code>$CATALINA_BASE/conf/[engine_name]/[host_name]</code> is + assumed to be a context XML descriptor containing a + <a href="context.html">Context</a> element (and its associated + sub-elements) for a single web application. The web applications + associated with each of these context XML descriptor files will be + deployed first.<br> + The <code>docBase</code> attribute of this <code><Context></code> + element must only be set if the docBase is outside the Host's + <code>appBase</code>. For web applications located inside the Host's + <code>appBase</code>, the <code>docBase</code> will be the name of the + XML file with ".xml" replaced with ".war" for a web application archive + or the name of the XML file with ".xml" removed for a directory.<br> + The <code>path</code> attribute must not be set. The context path used + will be a slash character ("/") followed by the name of the XML file + (less the .xml extension). Multi-level context paths may be defined + using #, e.g. <code>foo#bar.xml</code> for a context path of + <code>/foo/bar</code>. The default web application that has a context + path of <code>/</code> may be defined by using a file called + <code>ROOT.xml</code>.</li> + <li>Any web application archive file within the Host's <code>appBase</code> + directory that has not already been deployed as a result of a context + XML descriptor and does not have a corresponding directory of the same + name (without the ".war" extension) will be deployed next. The context + path used will be a slash character ("/") followed by the web + application archive name less the ".war" extension. The one exception to + this rule is that a web application archive named "ROOT.war" will be + deployed with a context path of <code>/</code>. Multi-level contexts may + be defined by using #, e.g. use a WAR named <code>foo#bar.war</code> for + a context path of <code>/foo/bar</code>.<br> + If the <code>unpackWARs</code> attribute is <code>true</code>, the web + application archive file will be expanded to a directory of the same + name (without the ".war" extension".<br> + Note: If you re-deploy an updated WAR file while Tomcat is stopped, be + sure to delete the associated expanded directory before restarting + Tomcat, so that the updated WAR file will be re-expanded when Tomcat + restarts.<br> + Any web application archive file within the Hosts's <code>appBase</code> + directory that does not have a corresponding context XML descriptor + (with a ".xml" extension rather than a ".war" extension) in + <code>$CATALINA_BASE/conf/[engine_name]/[host_name]</code> will be + scanned to see if it contains a context XML descriptor (located at + <code>/META-INF/context.xml</code>) and if one is found the descriptor + will be copied to the + <code>$CATALINA_BASE/conf/[engine_name]/[host_name]</code> directory and + renamed. + </li> + <li>Finally, any sub-directory within the Host's <code>appBase</code> that + has not already been deployed as a result of a context XML descriptor + will be deployed. The context path used will be a slash character + ("/") followed by the directory name, unless the directory name is ROOT, + in which case the context path will <code>/</code>. Multi-level contexts + may be defined by using #, e.g. use a directory named + <code>foo#bar</code> for a context path of <code>/foo/bar</code>.<br> + Any directory within the Hosts's <code>appBase</code> directory that + does not have a corresponding context XML descriptor in + <code>$CATALINA_BASE/conf/[engine_name]/[host_name]</code> will be + scanned to see if it contains a context XML descriptor (located at + <code>/META-INF/context.xml</code>) and if one is found the descriptor + will be copied to + <code>$CATALINA_BASE/conf/[engine_name]/[host_name]</code> and renamed. + </li> + </ul> + + <p>In addition to the automatic deployment that occurs at startup time, + you can also request that new XML configuration files, WAR files, or + sub-directories that are dropped in to the <code>appBase</code> (or + <code>$CATALINA_BASE/conf/[engine_name]/[host_name]</code> in the case of + an XML configuration file) directory while Tomcat is running will be + automatically deployed, according to the rules described above. The + auto deployer will also track web applications for the following changes: + <ul> + <li>An update to the WEB-INF/web.xml file will trigger a reload of the + web application</li> + <li>Deleting a WAR file will trigger an undeploy of the application with + the removal of any associated expanded directory, context file and + work directory. Any current user sessions will not be persisted.</li> + <li>Deleting a directory will trigger an undeploy of the application + with the removal of any associated context file and work directory. + Any current user sessions will not be persisted. If there is an + associated WAR file, it will not be deleted and the application will + be redeployed from the WAR file the next time the auto deployer checks + for changes.</li> + <li>Deleting a context file will trigger an undeploy of the application + with the removal of any associated work directory. Any current user + sessions will not be persisted. If there is an associated WAR file + and/or directory, they will not be deleted and the application will be + redeployed from the WAR file (or from directory if there is no WAR + file) the next time the auto deployer checks for changes.</li> + <li>Updating a WAR file will trigger an undeploy of the application with + the removal of any associated expanded directory, context file and + work directory. Any current user sessions will not be persisted.</li> + <li>Updating a directory (not the directory contents) will trigger an + undeploy of the application with the removal of any associated context + file and work directory. Any current user sessions will not be + persisted. The application will be redeployed the next time the auto + deployer checks for changes.</li> + <li>Updating a context file will trigger an undeploy of the application + with the removal of any associated work directory. Any current user + sessions will not be persisted. The application will be redeployed the + next time the auto deployer checks for changes.</li> + </ul> + </p> + + <p>When using automatic deployment, the <code>docBase</code> defined by + an XML <a href="context.html">Context</a> file should be outside of the + <code>appBase</code> directory. If this is not the case difficulties + may be experienced deploying the web application or the application may + be deployed twice.</p> + + <p>Finally, note that if you are defining contexts explicitly in server.xml, + you should probably turn off automatic application deployment. Otherwise, + the web applications will each be deployed twice, and that may cause + problems for the applications. + </p> + + </blockquote></td></tr></table> + + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Host Name Aliases"><!--()--></a><a name="Host_Name_Aliases"><strong>Host Name Aliases</strong></a></font></td></tr><tr><td><blockquote> + + <p>In many server environments, Network Administrators have configured + more than one network name (in the <em>Domain Name Service</em> (DNS) + server), that resolve to the IP address of the same server. Normally, + each such network name would be configured as a separate + <strong>Host</strong> element in <code>conf/server.xml</code>, each + with its own set of web applications.</p> + + <p>However, in some circumstances, it is desirable that two or more + network names should resolve to the <strong>same</strong> virtual host, + running the same set of applications. A common use case for this + scenario is a corporate web site, where it is desirable that users + be able to utilize either <code>www.mycompany.com</code> or + <code>company.com</code> to access exactly the same content and + applications.</p> + + <p>This is accomplished by utilizing one or more <strong>Alias</strong> + elements nested inside your <strong>Host</strong> element. For + example:</p> +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +<Host name="www.mycompany.com" ...> + ... + <Alias>mycompany.com</Alias> + ... +</Host> +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + <p>In order for this strategy to be effective, all of the network names + involved must be registered in your DNS server to resolve to the + same computer that is running this instance of Catalina.</p> + + </blockquote></td></tr></table> + + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Lifecycle Listeners"><!--()--></a><a name="Lifecycle_Listeners"><strong>Lifecycle Listeners</strong></a></font></td></tr><tr><td><blockquote> + + <p>If you have implemented a Java object that needs to know when this + <strong>Host</strong> is started or stopped, you can declare it by + nesting a <strong>Listener</strong> element inside this element. The + class name you specify must implement the + <code>org.apache.catalina.LifecycleListener</code> interface, and + it will be notified about the occurrence of the corresponding + lifecycle events. Configuration of such a listener looks like this:</p> + +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +<Host name="localhost" ...> + ... + <Listener className="com.mycompany.mypackage.MyListener" ... > + ... +</Host> +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + <p>Note that a Listener can have any number of additional properties + that may be configured from this element. Attribute names are matched + to corresponding JavaBean property names using the standard property + method naming patterns.</p> + + </blockquote></td></tr></table> + + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Request Filters"><!--()--></a><a name="Request_Filters"><strong>Request Filters</strong></a></font></td></tr><tr><td><blockquote> + + <p>You can ask Catalina to check the IP address, or host name, on every + incoming request directed to the surrounding + <a href="engine.html">Engine</a>, <a href="host.html">Host</a>, or + <a href="context.html">Context</a> element. The remote address or name + will be checked against a configured list of "accept" and/or "deny" + filters, which are defined using the Regular Expression syntax supported + by the <a href="http://jakarta.apache.org/regexp/";>Jakarta Regexp</a> + regular expression library. Requests that come from locations that are + not accepted will be rejected with an HTTP "Forbidden" error. + Example filter declarations:</p> + +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +<Host name="localhost" ...> + ... + <Valve className="org.apache.catalina.valves.RemoteHostValve" + allow="*.mycompany.com,www.yourcompany.com"/> + <Valve className="org.apache.catalina.valves.RemoteAddrValve" + deny="192.168.1.*"/> + ... +</Host> +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + <p>See <a href="valve.html#Remote Address Filter">Remote Address Filter</a> + and <a href="valve.html#Remote Host Filter">Remote Host Filter</a> for + more information about the configuration options that are supported.</p> + + </blockquote></td></tr></table> + + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Single Sign On"><!--()--></a><a name="Single_Sign_On"><strong>Single Sign On</strong></a></font></td></tr><tr><td><blockquote> + + <p>In many environments, but particularly in portal environments, it + is desireable to have a user challenged to authenticate themselves only + once over a set of web applications deployed on a particular virtual + host. This can be accomplished by nesting an element like this inside + the Host element for this virtual host:</p> + +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +<Host name="localhost" ...> + ... + <Valve className="org.apache.catalina.authenticator.SingleSignOn" + debug="0"/> + ... +</Host> +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + <p>The Single Sign On facility operates according to the following rules: + </p> + <ul> + <li>All web applications configured for this virtual host must share the + same <a href="realm.html">Realm</a>. In practice, that means you can + nest the Realm element inside this Host element (or the surrounding + <a href="engine.html">Engine</a> element), but not inside a + <a href="context.html">Context</a> element for one of the involved + web applications.</li> + <li>As long as the user accesses only unprotected resources in any of the + web applications on this virtual host, they will not be challenged + to authenticate themselves.</li> + <li>As soon as the user accesses a protected resource in + <strong>any</strong> web application associated with this virtual + host, the user will be challenged to authenticate himself or herself, + using the login method defined for the web application currently + being accessed.</li> + <li>Once authenticated, the roles associated with this user will be + utilized for access control decisions across <strong>all</strong> + of the associated web applications, without challenging the user + to authenticate themselves to each application individually.</li> + <li>As soon as the user logs out of one web application (for example, + by invalidating the corresponding session if form + based login is used), the user's sessions in <strong>all</strong> + web applications will be invalidated. Any subsequent attempt to + access a protected resource in any application will require the + user to authenticate himself or herself again.</li> + <li>The Single Sign On feature utilizes HTTP cookies to transmit a token + that associates each request with the saved user identity, so it can + only be utilized in client environments that support cookies.</li> + </ul> + + </blockquote></td></tr></table> + + + <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="User Web Applications"><!--()--></a><a name="User_Web_Applications"><strong>User Web Applications</strong></a></font></td></tr><tr><td><blockquote> + + <p>Many web servers can automatically map a request URI starting with + a tilde character ("~") and a username to a directory (commonly named + <code>public_html</code>) in that user's home directory on the server. + You can accomplish the same thing in Catalina by using a special + <strong>Listener</strong> element like this (on a Unix system that + uses the <code>/etc/passwd</code> file to identify valid users):</p> + +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +<Host name="localhost" ...> + ... + <Listener className="org.apache.catalina.startup.UserConfig" + directoryName="public_html" + userClass="org.apache.catalina.startup.PasswdUserDatabase"/> + ... +</Host> +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + <p>On a server where <code>/etc/passwd</code> is not in use, you can + request Catalina to consider all directories found in a specified base + directory (such as <code>c:\Homes</code> in this example) to be + considered "user home" directories for the purposes of this directive:</p> + +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +<Host name="localhost" ...> + ... + <Listener className="org.apache.catalina.startup.UserConfig" + directoryName="public_html" + homeBase=c:\Homes" + userClass="org.apache.catalina.startup.HomesUserDatabase"/> + ... +</Host> +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + <p>If a user home directory has been set up for a user named + <code>craigmcc</code>, then its contents will be visible from a + client browser by making a request to a URL like:</p> + +<div align="left"><table border="0" cellpadding="0" cellspacing="4"><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#ffffff"><pre> +http://www.mycompany.com:8080/~craigmcc +</pre></td><td width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr><tr><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td><td height="1" width="1" bgcolor="#023264"><img border="0" hspace="0" vspace="0" height="1" width="1" alt="" src="../images/void.gif"></td></tr></table></div> + + <p>Successful use of this feature requires recognition of the following + considerations:</p> + <ul> + <li>Each user web application will be deployed with characteristics + established by the global and host level default context settings.</li> + <li>It is legal to include more than one instance of this Listener + element. This would only be useful, however, in circumstances + where you wanted to configure more than one "homeBase" directory.</li> + <li>The operating system username under which Catalina is executed + MUST have read access to each user's web application directory, + and all of its contents.</li> + </ul> + + </blockquote></td></tr></table> + + +</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font size="-1" color="#525D76"><em> + Copyright © 1999-2010, Apache Software Foundation + </em></font></div></td></tr></table></body></html> \ No newline at end of file
