Attachment #30793 for bug #55383

View | Details | Raw Unified | Return to bug 55383
Collapse All | Expand All




in Chapter 13 of the Servlet API Specification, version 2.3.  Over time, it
is expected that development tools will be provided that create and edit the
deployment descriptor for you.  In the meantime, to provide a starting point,
a <a href="web.xml.txt" target="_blank">basic web.xml file</a>
is provided.  This file includes comments that describe the purpose of each
included element.</p>



<section name="Deployment With Tomcat">

    <p><em>The description below uses the variable name $CATALINA_BASE to refer the
    <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.</em></p>
    </em></blockquote>

<p>In order to be executed, a web application must be deployed on
a servlet container.  This is true even during development.

Lines 65-71 Link Here

(-)webapps/docs/appdev/index.xml (-1 / +1 lines)
65	<li><a href="processes.html"><strong>Development Processes</strong></a> -	65	<li><a href="processes.html"><strong>Development Processes</strong></a> -
66	Provides brief descriptions of typical development processes	66	Provides brief descriptions of typical development processes
67	utilizing the recommended deployment and source organizations.</li>	67	utilizing the recommended deployment and source organizations.</li>
68	<li><a href="sample/" target="_new"><strong>Example Application</strong></a> -	68	<li><a href="sample/" target="_blank"><strong>Example Application</strong></a> -
69	This directory contains a very simple, but functionally complete,	69	This directory contains a very simple, but functionally complete,
70	"Hello, World" application built according to the principles	70	"Hello, World" application built according to the principles
71	described in this manual. You can use this application to	71	described in this manual. You can use this application to

Lines 39-45 Link Here

(-)webapps/docs/appdev/installation.xml (-2 / +2 lines)
39		39
40	<subsection name="JDK">	40	<subsection name="JDK">
41		41
42	<p>Tomcat 7.0 was designed to run on Java SE 6.	42	<p>Tomcat 8.0 was designed to run on Java SE 7.
43	</p>	43	</p>
44		44
45	<p>Compatible JDKs for many platforms (or links to where they can be found)	45	<p>Compatible JDKs for many platforms (or links to where they can be found)
Lines 53-59 Link Here
53	<p>Binary downloads of the <strong>Tomcat</strong> server are available from	53	<p>Binary downloads of the <strong>Tomcat</strong> server are available from
54	<a href="http://tomcat.apache.org/">http://tomcat.apache.org/</a>.	54	<a href="http://tomcat.apache.org/">http://tomcat.apache.org/</a>.
55	This manual assumes you are using the most recent release	55	This manual assumes you are using the most recent release
56	of Tomcat 7. Detailed instructions for downloading and installing	56	of Tomcat 8. Detailed instructions for downloading and installing
57	Tomcat are available <a href="../setup.html">here</a>.</p>	57	Tomcat are available <a href="../setup.html">here</a>.</p>
58		58
59	<p>In the remainder of this manual, example shell scripts assume that you have	59	<p>In the remainder of this manual, example shell scripts assume that you have





<p>The discussion in this manual is aimed at developers who will be using
a text editor along with command line tools to develop and debug their
applications.  As such, the recommendations are fairly generic &#x2013; but you
should easily be able to apply them in either a Windows-based or Unix-based
development environment.  If you are utilizing an Integrated Development
Environment (IDE) tool, you will need to adapt the advice given here to

information, documentation, and software that is useful in developing
web applications with Tomcat.</p>
<ul>
<li><p><a href="http://jcp.org/aboutJava/communityprocess/mrel/jsr245/index2.html">http://jcp.org/aboutJava/communityprocess/mrel/jsr245/index2.html</a> -
    <i>JavaServer Pages (JSP) Specification, Version 2.3</i>.  Describes
    the programming environment provided by standard implementations
    of the JavaServer Pages (JSP) technology.  In conjunction with

    information on scripting (Chapter 9), tag extensions (Chapter 7),
    and packaging JSP pages (Appendix A) is useful.  The Javadoc
    API Documentation is included in the specification, and with the
    Tomcat download.</p></li>
<li><p><a href="http://jcp.org/aboutJava/communityprocess/final/jsr340/index.html">http://jcp.org/aboutJava/communityprocess/final/jsr340/index.html</a> -
    <i>Servlet API Specification, Version 3.1</i>.  Describes the
    programming environment that must be provided by all servlet
    containers conforming to this specification.  In particular, you

    security (Chapter 13), and the syntax of the <code>web.xml</code>
    Web Application Deployment Descriptor (Chapter 14).  The Javadoc
    API Documentation is included in the specification, and with the
    Tomcat download.</p></li>
</ul>

</section>




<em>Manager</em> web application, you need to perform the following tasks
once (no matter how many web applications you plan to develop).</p>
<ul>
<li><p><em>Configure the Ant custom tasks</em>.  The implementation code for the
    Ant custom tasks is in a JAR file named
    <code>$CATALINA_HOME/lib/catalina-ant.jar</code>, which must be
    copied in to the <code>lib</code> directory of your Ant installation.
    </p></li>
<li><p><em>Define one or more Tomcat users</em>.  The <em>Manager</em> web
    application runs under a security constraint that requires a user to be
    logged in, and have the security role <code>manager-script</code> assigned
    to him or her.  How such users are defined depends on which Realm you have

    <a href="../realm-howto.html">Realm Configuration HOW-TO</a> for more
    information.  You may define any number of users (with any username
    and password that you like) with the <code>manager-script</code> role.
    </p></li>
</ul>

</subsection>

repository.  This might be done by a series of commands like this, where
<code>{project}</code> is the name under which your project should be
stored in the CVS repository, and {username} is your login username:</p>
<source><![CDATA[cd {my home directory}
mkdir myapp <-- Assumed "project source directory"
mkdir myapp &lt;-- Assumed "project source directory"
cd myapp
mkdir docs
mkdir src

mkdir web
mkdir web/WEB-INF
cvs import -m "Initial Project Creation" {project} \
    {username} start]]></source>
</source>

<p>Now, to verify that it was created correctly in CVS, we will perform a
checkout of the new project:</p>
<source><![CDATA[cd ..
cd ..
mv myapp myapp.bu
cvs checkout {project}]]></source>
</source>

<p>Next, you will need to create and check in an initial version of the
<code>build.xml</code> script to be used for development.  For getting

started quickly and easily, base your <code>build.xml</code> on the
<a href="build.xml.txt">basic build.xml file</a>, included with this manual,
or code it from scratch.</p>
<source><![CDATA[cd {my home directory}
cd {my home directory}
cd myapp
emacs build.xml     <-- if you want a real editor :-)
cvs add build.xml
cvs commit]]></source>
</source>

<p>Until you perform the CVS commit, your changes are local to your own
development directory.  Committing makes those changes visible to other

need to define the <code>catalina.home</code> property defining where
Tomcat is installed, and the manager application username and password.
You might end up with something like this:</p>
<source><![CDATA[# Context path to install this application on
# Context path to install this application on
app.path=/hello

# Tomcat 7 installation directory


# Manager webapp username and password
manager.username=myusername
manager.password=mypassword]]></source>
</source>

<p>In general, you will <strong>not</strong> want to check the
<code>build.properties</code> file in to the CVS repository, because it

<p>Now, create the initial version of the web application deployment
descriptor.  You can base <code>web.xml</code> on the
<a href="web.xml.txt">basic web.xml file</a>, or code it from scratch.</p>
<source><![CDATA[cd {my home directory}
cd {my home directory}
cd myapp/web/WEB-INF
emacs web.xml
cvs add web.xml
cvs commit]]></source>
</source>

Note that this is only an example web.xml file.  The full definition
of the deployment descriptor file is in the


<p>Whenever you wish to refresh your development directory to reflect the
work performed by other developers, you will ask CVS to do it for you:</p>
<source><![CDATA[cd {my home directory}
cd {my home directory}
cd myapp
cvs update -dP]]></source>
</source>

<p>To create a new file, go to the appropriate directory, create the file,
and register it with CVS.  When you are satisfied with it's contents (after
building and testing is successful), commit the new file to the repository.
For example, to create a new JSP page:</p>
<source><![CDATA[cd {my home directory}
cd myapp/web        <-- Ultimate destination is document root
cd myapp/web        &lt;-- Ultimate destination is document root
emacs mypage.jsp
cvs add mypage.jsp
... build and test the application ...
cvs commit]]></source>
</source>

<p>Java source code that is defined in packages must be organized in a
directory hierarchy (under the <strong>src/</strong> subdirectory) that

<p>When you are ready to compile the application, issue the following
commands (generally, you will want a shell window open that is set to
the project source directory, so that only the last command is needed):</p>
<source><![CDATA[cd {my home directory}
cd myapp        <-- Normally leave a window open here
ant]]></source>
ant
</source>

<p>The Ant tool will be execute the default "compile" target in your
<code>build.xml</code> file, which will compile any new or updated Java

it will cause everything to be recompiled.</p>

<p>To force the recompilation of your entire application, do this instead:</p>
<source><![CDATA[cd {my home directory}
cd {my home directory}
cd myapp
ant all]]></source>
</source>

<p>This is a very good habit immediately before checking in changes, to
make sure that you have not introduced any subtle problems that Javac's

the sample <code>build.xml</code> script.  Using these commands might follow
a pattern like this:</p>
<ul>
<li><p><em>Start Tomcat if needed</em>.  If Tomcat is not already running,
    you will need to start it in the usual way.
    </p></li>
<li><p><em>Compile your application</em>.  Use the <code>ant compile</code>
    command (or just <code>ant</code>, since this is the default).  Make
    sure that there are no compilation errors.
    </p></li>
<li><p><em>Install the application</em>.  Use the <code>ant install</code>
    command.  This tells Tomcat to immediately start running your app on
    the context path defined in the <code>app.path</code> build property.
    Tomcat does <strong>NOT</strong> have to be restarted for this to
    take effect.
    </p></li>
<li><p><em>Test the application</em>.  Using your browser or other testing
    tools, test the functionality of your application.
    </p></li>
<li><p><em>Modify and rebuild as needed</em>.  As you discover that changes
    are required, make those changes in the original <strong>source</strong>
    files, not in the output build directory, and re-issue the
    <code>ant compile</code> command.  This ensures that your changes will
    be available to be saved (via <code>cvs commit</code>) later on --
    the output build directory is deleted and recreated as necessary.
    </p></li>
<li><p><em>Reload the application</em>.  Tomcat will recognize changes in
    JSP pages automatically, but it will continue to use the old versions
    of any servlet or JavaBean classes until the application is reloaded.
    You can trigger this by executing the <code>ant reload</code> command.
    </p></li>
<li><p><em>Remove the application when you are done</em>.  When you are through
    working on this application, you can remove it from live execution by
    running the <code>ant remove</code> command.
    </p></li>
</ul>

<p>Do not forget to commit your changes to the source code repository when

of your web application that can be deployed on the production server.  The
following general steps are required:</p>
<ul>
<li><p>Issue the command <code>ant all</code> from the project source
    directory, to rebuild everything from scratch one last time.
    </p></li>
<li><p>Use the <code>cvs tag</code> command to create an identifier for
    all of the source files utilized to create this release.  This allows
    you to reliably reconstruct a release (from sources) at a later
    time.
    </p></li>
<li><p>Issue the command <code>ant dist</code> to create a distributable
    web application archive (WAR) file, as well as a JAR file containing
    the corresponding source code.
    </p></li>
<li><p>Package the contents of the <code>dist</code> directory using the
    <strong>tar</strong> or <strong>zip</strong> utility, according to
    the standard release procedures used by your organization.
    </p></li>
</ul>

</subsection>





<section name="Directory Structure">

    <p><em>The description below uses the variable name $CATALINA_BASE to refer the
    <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.</em></p>
    </em></blockquote>

<p>A key recommendation of this manual is to separate the directory
hierarchy containing your source code (described in this section) from

(described in the preceding section).  Maintaining this separation has
the following advantages:</p>
<ul>
<li><p>The contents of the source directories can be more easily administered,
    moved, and backed up if the "executable" version of the application
    is not intermixed.
    </p></li>
<li><p>Source code control is easier to manage on directories that contain
    only source files.
    </p></li>
<li><p>The files that make up an installable distribution of your
    application are much easier to select when the deployment
    hierarchy is separate.</p></li>
</ul>

<p>As we will see, the <code>ant</code> development tool makes the creation

easy way to tell CVS to ignore these directories is to create a file named
<code>.cvsignore</code> (note the leading period) in your top-level source
directory, with the following contents:</p>
<source>build
build
dist
build.properties</source>
</source>

<p>The reason for mentioning <code>build.properties</code> here will be
explained in the <a href="processes.html">Processes</a> section.</p>

the targets that are designed for use by the developer, versus those targets
used internally.  To ask Ant to display the project documentation, change to
the directory containing the <code>build.xml</code> file and type:</p>
<source>ant -projecthelp</source>
ant -projecthelp
</source>

<p>To give you a head start, a <a href="build.xml.txt">basic build.xml file</a>
is provided that you can customize and install in the project source directory




<p>
This page describes how the Tomcat server starts up.  There are several
different ways to start tomcat, including:
</p>
<ul>
  <li>From the command line.</li>
  <li>From a Java program as an embedded server.</li>
  <li>Automatically as a Windows service.</li>
</ul>
</p>

<subsection name="description">
<p>




  the <code>jvmRoute</code> attribute of the
  <a href="engine.html">Engine</a>.</p>

  <p>The native connectors supported with this Tomcat release are:</p>
    <ul>
      <li>JK 1.2.x with any of the supported servers. See
      <a href="http://tomcat.apache.org/connectors-doc/">the JK docs</a>

      <a href="http://httpd.apache.org/docs/2.2/mod/mod_proxy_ajp.html">the
      httpd docs</a> for details.</li>
    </ul>
  </p>

  <p><b>Other native connectors supporting AJP may work, but are no longer
  supported.</b></p>

        <code>org.apache.coyote.ajp.AjpAprProtocol</code>
        - the APR/native connector.<br/>
        Custom implementations may also be used.<br/>
        Take a look at our <a href="#Connector_Comparison">Connector
        Comparison</a> chart.
      </p>
    </attribute>

      <p>If this <strong>Connector</strong> is being used in a proxy
      configuration, configure this attribute to specify the server name
      to be returned for calls to <code>request.getServerName()</code>.
      See <a href="#Proxy_Support">Proxy Support</a> for more
      information.</p>
    </attribute>


      <p>If this <strong>Connector</strong> is being used in a proxy
      configuration, configure this attribute to specify the server port
      to be returned for calls to <code>request.getServerPort()</code>.
      See <a href="#Proxy_Support">Proxy Support</a> for more
      information.</p>
    </attribute>


  <subsection name="Connector Comparison">

    <p>Below is a small chart that shows how the connectors differentiate.</p>
    <source>
                       Java Blocking Connector   Java Nio Blocking Connector   APR/native Connector
                                 BIO                         NIO                       APR
    Classname                AjpProtocol               AjpNioProtocol           AjpAprProtocol
    Tomcat Version           3.x onwards                 7.x onwards              5.5.x onwards
    Support Polling              NO                          YES                       YES
    Polling Size                 N/A                   maxConnections             maxConnections
    Read Request Headers      Blocking                  Sim Blocking                   Blocking
    Read Request Body         Blocking                  Sim Blocking                   Blocking
    Write Response            Blocking                  Sim Blocking                   Blocking
    Wait for next Request     Blocking                  Non Blocking               Non Blocking
    Max Connections        maxConnections              maxConnections             maxConnections

    <table class="defaultTable" style="text-align: center;">
      <tr>
        <th />
        <th>Java Blocking Connector<br />BIO</th>
        <th>Java Nio Blocking Connector<br />NIO</th>
        <th>APR/native Connector<br />APR</th>
      </tr>
      <tr>
        <th style="text-align: left;">Classname</th>
        <td><code class="noHighlight">AjpProtocol</code></td>
        <td><code class="noHighlight">AjpNioProtocol</code></td>
        <td><code class="noHighlight">AjpAprProtocol</code></td>
      </tr>
      <tr>
        <th style="text-align: left;">Tomcat Version</th>
        <td>3.x onwards</td>
        <td>7.x onwards</td>
        <td>5.5.x onwards</td>
      </tr>
      <tr>
        <th style="text-align: left;">Support Polling</th>
        <td>NO</td>
        <td>YES</td>
        <td>YES</td>
      </tr>
      <tr>
        <th style="text-align: left;">Polling Size</th>
        <td>N/A</td>
        <td><code class="noHighlight">maxConnections</code></td>
        <td><code class="noHighlight">maxConnections</code></td>
      </tr>
      <tr>
        <th style="text-align: left;">Read Request Headers</th>
        <td>Blocking</td>
        <td>Sim Blocking</td>
        <td>Blocking</td>
      </tr>
      <tr>
        <th style="text-align: left;">Read Request Body</th>
        <td>Blocking</td>
        <td>Sim Blocking</td>
        <td>Blocking</td>
      </tr>
      <tr>
        <th style="text-align: left;">Write Response</th>
        <td>Blocking</td>
        <td>Sim Blocking</td>
        <td>Blocking</td>
      </tr>
      <tr>
        <th style="text-align: left;">Wait for next Request</th>
        <td>Blocking</td>
        <td>Non Blocking</td>
        <td>Non Blocking</td>
      </tr>
      <tr>
        <th style="text-align: left;">Max Connections</th>
        <td><code class="noHighlight">maxConnections</code></td>
        <td><code class="noHighlight">maxConnections</code></td>
        <td><code class="noHighlight">maxConnections</code></td>
      </tr>
    </table>

  </subsection>





</section>

<section name="Available Interceptors">
 <p>
   <ul>
    <li><code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code></li>
    <li><code>org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor</code></li>

    <li><code>org.apache.catalina.tribes.group.interceptors.GzipInterceptor</code></li>
    <li><code>org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor</code></li>
   </ul>
 </p>
</section>

<section name="Static Membership">

   underneath the <code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code> interceptor.
   Inside the <code>StaticMembershipInterceptor</code> you can add the static members you wish to have.
   The <code>TcpFailureDetector</code> will do a health check on the static members,and also monitor them for crashes
   so they will have the same level of notification mechanism as the members that are automatically discovered.</p>
   <source><![CDATA[     <Interceptor className="org.apache.catalina.tribes.group.interceptors.StaticMembershipInterceptor">
       <Member className="org.apache.catalina.tribes.membership.StaticMember"
                  port="5678"
                  securePort="-1"
                  host="tomcat01.mydomain.com"
                  domain="staging-cluster"
                  uniqueId="{0,1,2,3,4,5,6,7,8,9}"/>
     </Interceptor>]]></source>
     &lt;/Interceptor&gt;

   </source>
  </p>
</section>

<section name="Attributes">

Lines 98-104 Link Here

(-)webapps/docs/config/cluster-membership.xml (-1 / +1 lines)
98	a give time. The default value is <code>3000</code> ms. This means, that if a heartbeat is not received from a	98	a give time. The default value is <code>3000</code> ms. This means, that if a heartbeat is not received from a
99	member in that timeframe, the membership component will notify the cluster of this.<br/>	99	member in that timeframe, the membership component will notify the cluster of this.<br/>
100	On a high latency network you may wish to increase this value, to protect against false positives.<br/>	100	On a high latency network you may wish to increase this value, to protect against false positives.<br/>
101	Apache Tribes also provides a <a href="cluster-interceptor.html#tcpfailuredetector"><code>TcpFailureDetector</code></a> that will	101	Apache Tribes also provides a <a href="cluster-interceptor.html#org.apache.catalina.tribes.group.interceptors.TcpFailureDetector_Attributes"><code>TcpFailureDetector</code></a> that will
102	verify a timeout using a TCP connection when a heartbeat timeout has occurred. This protects against false positives.	102	verify a timeout using a TCP connection when a heartbeat timeout has occurred. This protects against false positives.
103	</p>	103	</p>
104	</attribute>	104	</attribute>

Lines 147-153 Link Here

(-)webapps/docs/config/cluster-sender.xml (-1 / +1 lines)
147	<attribute name="soTrafficClass" required="false">	147	<attribute name="soTrafficClass" required="false">
148	Sets the traffic class level for the socket, the value is between 0 and 255.	148	Sets the traffic class level for the socket, the value is between 0 and 255.
149	Default value is <code>int soTrafficClass = 0x04 \| 0x08 \| 0x010;</code>	149	Default value is <code>int soTrafficClass = 0x04 \| 0x08 \| 0x010;</code>
150	Different values are defined in <a href="http://docs.oracle.com/javase/6/docs/api/java/net/Socket.html#setTrafficClass(int)">	150	Different values are defined in <a href="http://docs.oracle.com/javase/7/docs/api/java/net/Socket.html#setTrafficClass(int)">
151	java.net.Socket#setTrafficClass(int)</a>.	151	java.net.Socket#setTrafficClass(int)</a>.
152	</attribute>	152	</attribute>
153	<attribute name="tcpNoDelay" required="false">	153	<attribute name="tcpNoDelay" required="false">




</section>
<section name="Context Attribute Replication">
  <p>To configure context attribute replication, simply do this by swapping out the context implementation
  used for your application context.</p>
  <source>&lt;Context className=&quot;org.apache.catalina.ha.context.ReplicatedContext&quot;/&gt;</source>
  <p>
    This context extends the Tomcat <code><a href="context.html">StandardContext</a></code>
    so all the options from the <a href="context.html">base implementation</a> are valid.
  </p>

<section name="Nested Components">
  <p><b><a href="cluster-manager.html">Manager</a>:</b> <br/>
    The session manager element identifies what kind of session manager is used in this cluster implementation.
    This manager configuration is identical to the one you would use in a regular <code><a href="context.html#Nested_Components">&lt;Context&gt;</a></code> configuration.
    <br/>The default value is the <code>org.apache.catalina.ha.session.DeltaManager</code> that is closely coupled with
    the <code>SimpleTcpCluster</code> implementation. Other managers like the <code>org.apache.catalina.ha.session.BackupManager</code>
    are/could be loosely coupled and don't rely on the <code>SimpleTcpCluster</code> for its data replication.

    <attribute name="channelSendOptions" required="true">
      <p>The Tribes channel send options, default is <code>8</code>.<br/>
         This option is used to set the flag that all messages sent through the
         SimpleTcpCluster uses. The flag decides how the messages are sent, and is a simple logical OR.</p>

      <source>int options = Channel.SEND_OPTIONS_ASYNCHRONOUS |
              Channel.SEND_OPTIONS_SYNCHRONIZED_ACK |
              Channel.SEND_OPTIONS_USE_ACK;</source>
      <p>Some of the values are:<br/>
      </source>
      Some of the values are:<br/>
      <code>Channel.SEND_OPTIONS_SYNCHRONIZED_ACK = 0x0004</code><br/>
      <code>Channel.SEND_OPTIONS_ASYNCHRONOUS = 0x0008</code><br/>
      <code>Channel.SEND_OPTIONS_USE_ACK = 0x0002</code><br/>

      <p>Sets the start and stop flags for the &lt;Channel&gt; object used by the cluster.
         The default is <code>Channel.DEFAULT</code> which starts all the channel services, such as
         sender, receiver, multicast sender and multicast receiver.
         The following flags are available today:</p>
         <source>Channel.DEFAULT = Channel.SND_RX_SEQ (1) |
                  Channel.SND_TX_SEQ (2) |
                  Channel.MBR_RX_SEQ (4) |
                  Channel.MBR_TX_SEQ (8);</source>
         <p>To start a channel without multicasting, you would want to use the value <code>Channel.SND_RX_SEQ | Channel.SND_TX_SEQ</code>
         that equals to <code>3</code>.
      </p>
    </attribute>





<section name="Introduction">

    <p><em>
    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.
    </em></p>

  <p>The <strong>Context</strong> element represents a <em>web
  application</em>, which is run within a particular virtual host.

    <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>

<source><![CDATA[<Context>
&lt;Context&gt;
  ...
  <Valve className="org.apache.catalina.valves.AccessLogValve"
         prefix="localhost_access_log." suffix=".txt"
         pattern="common"/>
  ...
</Context>]]></source>
</source>

    <p>See <a href="valve.html#Access_Log_Valve">Access Log Valve</a>
    for more information on the configuration attributes that are
    supported.</p>


    web application as servlet context initialization parameters by nesting
    <code>&lt;Parameter&gt;</code> elements inside this element.  For
    example, you can create an initialization parameter like this:</p>
<source><![CDATA[<Context>
&lt;Context&gt;
  ...
  <Parameter name="companyName" value="My Company, Incorporated"
         override="false"/>
  ...
</Context>]]></source>
</source>

    <p>This is equivalent to the inclusion of the following element in the
    web application deployment descriptor (<code>/WEB-INF/web.xml</code>):
    </p>
<source><![CDATA[<context-param>
  <param-name>companyName</param-name>
  <param-value>My Company, Incorporated</param-value>
</context-param>]]></source>
&lt;/context-param&gt;
</source>
    <p>but does <em>not</em> require modification of the deployment descriptor
    to customize this value.</p>


    web application as environment entry resources, by nesting
    <code>&lt;Environment&gt;</code> entries inside this element.  For
    example, you can create an environment entry like this:</p>
<source><![CDATA[<Context>
&lt;Context&gt;
  ...
  <Environment name="maxExemptions" value="10"
         type="java.lang.Integer" override="false"/>
  ...
</Context>]]></source>
</source>

    <p>This is equivalent to the inclusion of the following element in the
    web application deployment descriptor (<code>/WEB-INF/web.xml</code>):
    </p>
<source><![CDATA[<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>]]></source>
&lt;/env-entry&gt;
</source>
    <p>but does <em>not</em> require modification of the deployment descriptor
    to customize this value.</p>


    It will be notified about the occurrence of the corresponding
    lifecycle events.  Configuration of such a listener looks like this:</p>

<source><![CDATA[<Context>
&lt;Context&gt;
  ...
  <Listener className="com.mycompany.mypackage.MyListener" ... >
  ...
</Context>]]></source>
</source>

    <p>Note that a Listener can have any number of additional properties
    that may be configured from this element.  Attribute names are matched

    not accepted will be rejected with an HTTP "Forbidden" error.
    Example filter declarations:</p>

<source><![CDATA[<Context>
&lt;Context&gt;
  ...
  <Valve className="org.apache.catalina.valves.RemoteHostValve"
         allow=".*\.mycompany\.com|www\.yourcompany\.com"/>
  <Valve className="org.apache.catalina.valves.RemoteAddrValve"
         deny="192\.168\.1\.\d+"/>
  ...
</Context>]]></source>
</source>

    <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>

  </subsection>

    already), and the properties used to configure that object factory.</p>

    <p>For example, you can create a resource definition like this:</p>
<source><![CDATA[<Context>
&lt;Context&gt;
  ...
  <Resource name="jdbc/EmployeeDB" auth="Container"
            type="javax.sql.DataSource"
     description="Employees Database for HR Applications"/>
  ...
</Context>]]></source>
</source>

    <p>This is equivalent to the inclusion of the following element in the
    web application deployment descriptor (<code>/WEB-INF/web.xml</code>):</p>
<source><![CDATA[<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>]]></source>
&lt;/resource-ref&gt;
</source>

    <p>but does <em>not</em> require modification of the deployment
    descriptor to customize this value.</p>

     resource.</p>

    <p>For example, you can create a resource link like this:</p>
<source><![CDATA[<Context>
&lt;Context&gt;
  ...
  <ResourceLink name="linkToGlobalResource"
            global="simpleValue"
            type="java.lang.Integer"
  ...
</Context>]]></source>
</source>

    <p>The valid attributes for a <code>&lt;ResourceLink&gt;</code> element
    are as follows:</p>

       two additional attributes to allow a shared data source to be used with different credentials.
       When these two additional attributes are used in combination with the <code>javax.sql.DataSource</code>
       type, different contexts can share a global data source with different credentials.
       Under the hood, what happens is that a call to <a href="http://docs.oracle.com/javase/7/docs/api/javax/sql/DataSource.html#getConnection()"><code>getConnection()</code></a>
       is simply translated to a call <a href="http://docs.oracle.com/javase/7/docs/api/javax/sql/DataSource.html#getConnection(java.lang.String,%20java.lang.String)">
       <code>getConnection(username, password)</code></a> on the global data source. This is an easy way to get code to be transparent to what schemas are being used,
       yet be able to control connections (or pools) in the global configuration.
    </p>

but by default this support is disabled and can be enabled by
<code>alternateUsernameAllowed</code> attribute. See its documentation
for details.</p>
<source><![CDATA[<GlobalNamingResources>
&lt;GlobalNamingResources&gt;
  ...
  <Resource name="sharedDataSource"
            global="sharedDataSource"
            type="javax.sql.DataSource"
            factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
            alternateUsernameAllowed="true"
            username="bar"
            password="barpass"
            ...
  ...
</GlobalNamingResources>

<Context path="/foo"...>
  ...
  <ResourceLink
            name="appDataSource"
            global="sharedDataSource"
            type="javax.sql.DataSource"
            factory="org.apache.naming.factory.DataSourceLinkFactory"
            username="foo"
            password="foopass"
  ...
</Context>
<Context path="/bar"...>
  ...
  <ResourceLink
            name="appDataSource"
            global="sharedDataSource"
            type="javax.sql.DataSource"
  ...
</Context>]]></source>
</source>
    <p>When a request for <code>getConnection()</code> is made in the
       <code>/foo</code> context, the request is translated into
       <code>getConnection(&quot;foo&quot;,&quot;foopass&quot;)</code>,




    <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>

<source><![CDATA[<Engine name="Standalone" ...>
&lt;Engine name="Standalone" ...&gt;
  ...
  <Valve className="org.apache.catalina.valves.AccessLogValve"
         prefix="catalina_access_log." suffix=".txt"
         pattern="common"/>
  ...
</Engine>]]></source>
</source>

    <p>See <a href="valve.html#Access_Log_Valve">Access Log Valve</a>
    for more information on the configuration attributes that are
    supported.</p>


    it will be notified about the occurrence of the corresponding
    lifecycle events.  Configuration of such a listener looks like this:</p>

<source><![CDATA[<Engine name="Standalone" ...>
&lt;Engine name="Standalone" ...&gt;
  ...
  <Listener className="com.mycompany.mypackage.MyListener" ... >
  ...
</Engine>]]></source>
</source>

    <p>Note that a Listener can have any number of additional properties
    that may be configured from this element.  Attribute names are matched

    not accepted will be rejected with an HTTP "Forbidden" error.
    Example filter declarations:</p>

<source><![CDATA[<Engine name="Standalone" ...>
&lt;Engine name="Standalone" ...&gt;
  ...
  <Valve className="org.apache.catalina.valves.RemoteHostValve"
         allow=".*\.mycompany\.com|www\.yourcompany\.com"/>
  <Valve className="org.apache.catalina.valves.RemoteAddrValve"
         deny="192\.168\.1\.\d+"/>
  ...
</Engine>]]></source>
</source>

  <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>

  </subsection>




  web applications by configuring them in the application's
  <code>WEB-INF/web.xml</code>. Each filter is described below.</p>

    <p><em>This description uses the variable name $CATALINA_BASE to refer the
    <p>This description 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.</em></p>
    </em></blockquote>

</section>


    <a href="../images/cors-flowchart.png">flowchart</a> that
    demonstrates request processing by this filter is available.</p>
    <p>The minimal configuration required to use this filter is:</p>
    <source><![CDATA[<filter>
  <filter-name>CorsFilter</filter-name>
  <filter-class>org.apache.catalina.filters.CorsFilter</filter-class>
</filter>
<filter-mapping>
  <filter-name>CorsFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>]]></source>
&lt;/filter-mapping&gt;
    </source>
  </subsection>
  <subsection name="Filter Class Name">
    <p>The filter class name for the CORS Filter is

    </attributes>
    <p>Here's an example of a more advanced configuration, that overrides
    defaults:</p>
    <source><![CDATA[<filter>
  <filter-name>CorsFilter</filter-name>
  <filter-class>org.apache.catalina.filters.CorsFilter</filter-class>
  <init-param>
    <param-name>cors.allowed.origins</param-name>
    <param-value>*</param-value>
  </init-param>
  <init-param>
    <param-name>cors.allowed.methods</param-name>
    <param-value>GET,POST,HEAD,OPTIONS,PUT</param-value>
  </init-param>
  <init-param>
    <param-name>cors.allowed.headers</param-name>
    <param-value>Content-Type,X-Requested-With,accept,Origin,Access-Control-Request-Method,Access-Control-Request-Headers</param-value>
  </init-param>
  <init-param>
    <param-name>cors.exposed.headers</param-name>
    <param-value>Access-Control-Allow-Origin,Access-Control-Allow-Credentials</param-value>
  </init-param>
  <init-param>
    <param-name>cors.support.credentials</param-name>
    <param-value>true</param-value>
  </init-param>
  <init-param>
    <param-name>cors.preflight.maxage</param-name>
    <param-value>10</param-value>
  </init-param>
</filter>
<filter-mapping>
  <filter-name>CorsFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>]]></source>
&lt;/filter-mapping&gt;
    </source>
  </subsection>
  <subsection name="CORS Filter and HttpServletRequest attributes">
    <p>CORS Filter adds information about the request, in HttpServletRequest

    headers to images, css and javascript.
    </p>

    <source><![CDATA[<filter>
 <filter-name>ExpiresFilter</filter-name>
 <filter-class>org.apache.catalina.filters.ExpiresFilter</filter-class>
 <init-param>
    <param-name>ExpiresByType image</param-name>
    <param-value>access plus 10 minutes</param-value>
 </init-param>
 <init-param>
    <param-name>ExpiresByType text/css</param-name>
    <param-value>access plus 10 minutes</param-value>
 </init-param>
 <init-param>
    <param-name>ExpiresByType application/javascript</param-name>
    <param-value>access plus 10 minutes</param-value>
 </init-param>
</filter>
&lt;/filter&gt;
...
<filter-mapping>
 <filter-name>ExpiresFilter</filter-name>
 <url-pattern>/*</url-pattern>
 <dispatcher>REQUEST</dispatcher>
</filter-mapping>]]></source>

    </source>

  </subsection>

  <subsection name="Alternate Syntax">

    defined in a more readable syntax of the form:
    </p>

    <source><![CDATA[<init-param>
 <param-name>ExpiresDefault</param-name>
 <param-value><base> [plus] {<num>   <type>}*</param-value>
</init-param>
&lt;/init-param&gt;

<init-param>
 <param-name>ExpiresByType type</param-name>
 <param-value><base> [plus]   {<num> <type>}*</param-value>
</init-param>

<init-param>
 <param-name>ExpiresByType type;encoding</param-name>
 <param-value><base> [plus]   {<num> <type>}*</param-value>
</init-param>]]></source>
    </source>
    <p>
    where <code>&lt;base&gt;</code> is one of:
    </p>
    <ul>
    <li><code>access</code></li>
    <li><code>now</code> (equivalent to &#x27;<code>access</code>&#x27;)</li>
    <li><code>modification</code></li>
    </ul>

    <p>
    The <code>plus</code> keyword is optional. <code>&lt;num&gt;</code> should be an
    integer value (acceptable to <code>Integer.parseInt()</code>), and
    <code>&lt;type&gt;</code> is one of:
    </p>
    <ul>
    <li><code>years</code></li>
    <li><code>months</code></li>

    <li><code>minutes</code></li>
    <li><code>seconds</code></li>
    </ul>
    <p>
    For example, any of the following directives can be used to make documents
    expire 1 month after being accessed, by default:
    </p>

    <source><![CDATA[<init-param>
 <param-name>ExpiresDefault</param-name>
 <param-value>access plus 1 month</param-value>
</init-param>
&lt;/init-param&gt;

<init-param>
 <param-name>ExpiresDefault</param-name>
 <param-value>access plus 4 weeks</param-value>
</init-param>

<init-param>
 <param-name>ExpiresDefault</param-name>
 <param-value>access plus 30 days</param-value>
</init-param>]]></source>
</source>
<p>
The expiry time can be fine-tuned by adding several &#x27;
<code>&lt;num&gt; &lt;type&gt;</code>&#x27; clauses:
</p>

<source><![CDATA[<init-param>
 <param-name>ExpiresByType text/html</param-name>
 <param-value>access plus 1 month 15   days 2 hours</param-value>
</init-param>
&lt;/init-param&gt;

<init-param>
 <param-name>ExpiresByType image/gif</param-name>
 <param-value>modification plus 5 hours 3   minutes</param-value>
</init-param>]]></source>
    </source>
    <p>
    Note that if you use a modification date based setting, the <code>Expires</code>
    header will <strong>not</strong> be added to content that does not come from

  <subsection name="Expiration headers generation eligibility">
    <p>
    A response is eligible to be enriched by <code>ExpiresFilter</code> if :
    </p>
    <ol>
    <li>no expiration header is defined (<code>Expires</code> header or the
    <code>max-age</code> directive of the <code>Cache-Control</code> header),</li>

    defined the in <code>ExpiresByType</code> directives or the
    <code>ExpiresDefault</code> directive is defined.</li>
    </ol>

    <p>
    Note : If <code>Cache-Control</code> header contains other directives than
    <code>max-age</code>, they are concatenated with the <code>max-age</code> directive

  <subsection name="Expiration configuration selection">
    <p>
    The expiration configuration if elected according to the following algorithm:
    </p>
    <ol>
    <li><code>ExpiresByType</code> matching the exact content-type returned by
    <code>HttpServletResponse.getContentType()</code> possibly including the charset

    &#x27;),</li>
    <li><code>ExpiresDefault</code></li>
    </ol>

  </subsection>

  <subsection name="Filter Class Name">

      </attribute>
    </attributes>

    <p><i>Sample: exclude response status codes 302, 500 and 503</i></p>

<source><![CDATA[<init-param>
 <param-name>ExpiresExcludedResponseStatusCodes</param-name>
 <param-value>302, 500, 503</param-value>
</init-param>]]></source>
&lt;/init-param&gt;
</source>

    <p><i>Sample for ExpiresByType initialization parameter</i></p>

         <source><![CDATA[<init-param>
   <param-name>ExpiresByType text/html</param-name>
   <param-value>access plus 1 month 15   days 2 hours</param-value>
</init-param>
&lt;/init-param&gt;

<init-param>
   <!-- 2592000 seconds = 30 days -->
   <param-name>ExpiresByType image/gif</param-name>
   <param-value>A2592000</param-value>
</init-param>]]></source>
         </source>

  </subsection>


    Extract of logging.properties
    </p>

    <source>org.apache.catalina.filters.ExpiresFilter.level = FINE    </source>
org.apache.catalina.filters.ExpiresFilter.level = FINE
    </source>
    <p>
    Sample of initialization log message:
    </p>

    <source>Mar 26, 2010 2:01:41 PM org.apache.catalina.filters.ExpiresFilter init
Mar 26, 2010 2:01:41 PM org.apache.catalina.filters.ExpiresFilter init
FINE: Filter initialized with configuration ExpiresFilter[
 excludedResponseStatusCode=[304],
 default=null,

 byType={
    image=ExpiresConfiguration[startingPoint=ACCESS_TIME, duration=[10 MINUTE]],
    text/css=ExpiresConfiguration[startingPoint=ACCESS_TIME, duration=[10 MINUTE]],
    text/javascript=ExpiresConfiguration[startingPoint=ACCESS_TIME, duration=[10 MINUTE]]}]</source>
    </source>
    <p>
    Sample of per-request log message where <code>ExpiresFilter</code> adds an
    expiration date is below. The message is on one line and is wrapped here

    for better readability.
    </p>

    <source>Mar 26, 2010 2:09:47 PM org.apache.catalina.filters.ExpiresFilter onBeforeWriteResponseBody
Mar 26, 2010 2:09:47 PM org.apache.catalina.filters.ExpiresFilter onBeforeWriteResponseBody
FINE: Request "/tomcat.gif" with response status "200"
 content-type "image/gif", set expiration date 3/26/10 2:19 PM</source>
    </source>
    <p>
    Sample of per-request log message where <code>ExpiresFilter</code> does not add
    an expiration date:
    </p>

    <source>Mar 26, 2010 2:10:27 PM org.apache.catalina.filters.ExpiresFilter onBeforeWriteResponseBody
Mar 26, 2010 2:10:27 PM org.apache.catalina.filters.ExpiresFilter onBeforeWriteResponseBody
FINE: Request "/docs/config/manager.html" with response status "200"
 content-type "text/html", no expiration configured</source>
    </source>
  </subsection>

</section>


  <subsection name="Example">
    <p>To allow access only for the clients connecting from localhost:</p>
<source><![CDATA[    <filter>
      <filter-name>Remote Address Filter</filter-name>
      <filter-class>org.apache.catalina.filters.RemoteAddrFilter</filter-class>
      <init-param>
        <param-name>allow</param-name>
        <param-value>127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1</param-value>
      </init-param>
    </filter>
    <filter-mapping>
      <filter-name>Remote Address Filter</filter-name>
      <url-pattern>/*</url-pattern>
    </filter-mapping>]]></source>
    &lt;/filter-mapping>
</source>
  </subsection>

</section>

    <p>
    The filter will process the <code>x-forwarded-for</code> http header.
    </p>
    <source><![CDATA[      <filter>
        <filter-name>RemoteIpFilter</filter-name>
        <filter-class>org.apache.catalina.filters.RemoteIpFilter</filter-class>
      </filter>
      &lt;/filter&gt;

      <filter-mapping>
        <filter-name>RemoteIpFilter</filter-name>
        <url-pattern>/*</url-pattern>
        <dispatcher>REQUEST</dispatcher>
      </filter-mapping>]]></source>
    </source>
  </subsection>

  <subsection name="Basic configuration to handle &#x27;x-forwarded-for&#x27; and &#x27;x-forwarded-proto&#x27;">

    <code>x-forwarded-proto</code> http headers. Expected value for the
    <code>x-forwarded-proto</code> header in case of SSL connections is
    <code>https</code> (case insensitive). </p>
    <source><![CDATA[      <filter>
        <filter-name>RemoteIpFilter</filter-name>
        <filter-class>org.apache.catalina.filters.RemoteIpFilter</filter-class>
        <init-param>
          <param-name>protocolHeader</param-name>
          <param-value>x-forwarded-proto</param-value>
        </init-param>
      </filter>
      &lt;/filter&gt;

      <filter-mapping>
        <filter-name>RemoteIpFilter</filter-name>
        <url-pattern>/*</url-pattern>
        <dispatcher>REQUEST</dispatcher>
      </filter-mapping>]]></source>
    </source>
  </subsection>

  <subsection name="Advanced configuration with internal proxies">
    <p>RemoteIpFilter configuration: </p>
    <source><![CDATA[     <filter>
       <filter-name>RemoteIpFilter</filter-name>
       <filter-class>org.apache.catalina.filters.RemoteIpFilter</filter-class>
       <init-param>
         <param-name>allowedInternalProxies</param-name>
         <param-value>192\.168\.0\.10|192\.168\.0\.11</param-value>
       </init-param>
       <init-param>
         <param-name>remoteIpHeader</param-name>
         <param-value>x-forwarded-for</param-value>
       </init-param>
       <init-param>
         <param-name>remoteIpProxiesHeader</param-name>
         <param-value>x-forwarded-by</param-value>
       </init-param>
       <init-param>
         <param-name>protocolHeader</param-name>
         <param-value>x-forwarded-proto</param-value>
       </init-param>
     </filter>]]></source>
    <p>Request values:</p>
    <table class="defaultTable">
    <p>Request values:
    <table border="1" cellpadding="5">
      <tr>
        <th>Property</th>
        <th>Value Before RemoteIpFilter</th>
        <th>Value After RemoteIpFilter</th>
      </tr>
      <tr>
        <td> request.remoteAddr </td>

        <td> 443 </td>
      </tr>
    </table>

    <p>
    Note : <code>x-forwarded-by</code> header is <code>null</code> because only
    internal proxies has been traversed by the request.


  <subsection name="Advanced configuration with trusted proxies">
    <p>RemoteIpFilter configuration: </p>
    <source><![CDATA[     <filter>
       <filter-name>RemoteIpFilter</filter-name>
       <filter-class>org.apache.catalina.filters.RemoteIpFilter</filter-class>
       <init-param>
         <param-name>allowedInternalProxies</param-name>
         <param-value>192\.168\.0\.10|192\.168\.0\.11</param-value>
       </init-param>
       <init-param>
         <param-name>remoteIpHeader</param-name>
         <param-value>x-forwarded-for</param-value>
       </init-param>
       <init-param>
         <param-name>remoteIpProxiesHeader</param-name>
         <param-value>x-forwarded-by</param-value>
       </init-param>
       <init-param>
         <param-name>trustedProxies</param-name>
         <param-value>proxy1|proxy2</param-value>
       </init-param>
     </filter>]]></source>
    <p>Request values:</p>
    <table class="defaultTable">
    <p>Request values: <table border="1" cellpadding="5">
      <tr>
        <th>Property</th>
        <th>Value Before RemoteIpFilter</th>
        <th>Value After RemoteIpFilter</th>
      </tr>
      <tr>
        <td> request.remoteAddr </td>

        <td> proxy1, proxy2 </td>
      </tr>
    </table>

    <p>
    Note : <code>proxy1</code> and <code>proxy2</code> are both trusted proxies that
    come in <code>x-forwarded-for</code> header, they both are migrated in


  <subsection name="Advanced configuration with internal and trusted proxies">
    <p>RemoteIpFilter configuration: </p>
    <source><![CDATA[     <filter>
       <filter-name>RemoteIpFilter</filter-name>
       <filter-class>org.apache.catalina.filters.RemoteIpFilter</filter-class>
       <init-param>
         <param-name>allowedInternalProxies</param-name>
         <param-value>192\.168\.0\.10|192\.168\.0\.11</param-value>
       </init-param>
       <init-param>
         <param-name>remoteIpHeader</param-name>
         <param-value>x-forwarded-for</param-value>
       </init-param>
       <init-param>
         <param-name>remoteIpProxiesHeader</param-name>
         <param-value>x-forwarded-by</param-value>
       </init-param>
       <init-param>
         <param-name>trustedProxies</param-name>
         <param-value>proxy1|proxy2</param-value>
       </init-param>
     </filter>]]></source>
    <p>Request values:</p>
    <table class="defaultTable">
    <p>Request values: <table border="1" cellpadding="5">
      <tr>
        <th>Property</th>
        <th>Value Before RemoteIpFilter</th>
        <th>Value After RemoteIpFilter</th>
      </tr>
      <tr>
        <td> request.remoteAddr </td>

        <td> proxy1, proxy2 </td>
      </tr>
    </table>

    <p>
    Note : <code>proxy1</code> and <code>proxy2</code> are both trusted proxies that
    come in <code>x-forwarded-for</code> header, they both are migrated in

  <subsection name="Advanced configuration with an untrusted proxy">

    <p>RemoteIpFilter configuration: </p>
    <source><![CDATA[     <filter>
       <filter-name>RemoteIpFilter</filter-name>
       <filter-class>org.apache.catalina.filters.RemoteIpFilter</filter-class>
       <init-param>
         <param-name>allowedInternalProxies</param-name>
         <param-value>192\.168\.0\.10|192\.168\.0\.11</param-value>
       </init-param>
       <init-param>
         <param-name>remoteIpHeader</param-name>
         <param-value>x-forwarded-for</param-value>
       </init-param>
       <init-param>
         <param-name>remoteIpProxiesHeader</param-name>
         <param-value>x-forwarded-by</param-value>
       </init-param>
       <init-param>
         <param-name>trustedProxies</param-name>
         <param-value>proxy1|proxy2</param-value>
       </init-param>
     </filter>]]></source>
    <p>Request values:</p>
    <table class="defaultTable">
    <p>Request values: <table border="1" cellpadding="5">
      <tr>
        <th>Property</th>
        <th>Value Before RemoteIpFilter</th>
        <th>Value After RemoteIpFilter</th>
      </tr>
      <tr>
        <td> request.remoteAddr </td>

        <td> proxy1 </td>
      </tr>
    </table>

    <p>
    Note : <code>x-forwarded-by</code> holds the trusted proxy <code>proxy1</code>.
    <code>x-forwarded-by</code> holds <code>140.211.11.130</code> because

    Request Dumper filter for all requests for that web application. If the
    entries were added to <code>CATALINA_BASE/conf/web.xml</code>, the Request
    Dumper Filter would be enabled for all web applications.</p>
    <source><![CDATA[<filter>
    <filter-name>requestdumper</filter-name>
    <filter-class>
    &lt;filter-class&gt;
        org.apache.catalina.filters.RequestDumperFilter
    </filter-class>
</filter>
<filter-mapping>
    <filter-name>requestdumper</filter-name>
    <url-pattern>*</url-pattern>
</filter-mapping>]]></source>
    </source>

    <p>The following entries in CATALINA_BASE/conf/logging.properties would
    create a separate log file for the Request Dumper Filter output.</p>
    <source># To this configuration below, 1request-dumper.org.apache.juli.FileHandler
# To this configuration below, 1request-dumper.org.apache.juli.FileHandler
# also needs to be added to the handlers property near the top of the file
1request-dumper.org.apache.juli.FileHandler.level = INFO
1request-dumper.org.apache.juli.FileHandler.directory = ${catalina.base}/logs

1request-dumper.org.apache.juli.FileHandler.formatter = org.apache.juli.VerbatimFormatter
org.apache.catalina.filters.RequestDumperFilter.level = INFO
org.apache.catalina.filters.RequestDumperFilter.handlers = \
  1request-dumper.org.apache.juli.FileHandler</source>
    </source>
  </subsection>
</section>





  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">&lt;ResourceLink&gt;</a> elements.
  </p>

</section>

    web applications as environment entry resources by nesting
    <code>&lt;Environment&gt;</code> entries inside this element. For
    example, you can create an environment entry like this:</p>
<source><![CDATA[<GlobalNamingResources ...>
&lt;GlobalNamingResources ...&gt;
  ...
  <Environment name="maxExemptions" value="10"
         type="java.lang.Integer" override="false"/>
  ...
</GlobalNamingResources>]]></source>
</source>

    <p>This is equivalent to the inclusion of the following element in the
    web application deployment descriptor (<code>/WEB-INF/web.xml</code>):
    </p>
<source><![CDATA[<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>]]></source>
&lt;/env-entry&gt;
</source>
    <p>but does <em>not</em> require modification of the deployment descriptor
    to customize this value.</p>


    to be returned for JNDI lookups of <code>&lt;resource-ref&gt;</code> and
    <code>&lt;resource-env-ref&gt;</code> elements in the web application
    deployment descriptor by defining them in this element and then linking
    them with <a href="context.html#_Links">&lt;ResourceLink&gt;</a>
    elements
    in the <code><strong>&lt;Context&gt;</strong></code> element.


    the properties used to configure that object factory.</p>

    <p>For example, you can create a resource definition like this:</p>
<source><![CDATA[<GlobalNamingResources ...>
&lt;GlobalNamingResources ...&gt;
  ...
  <Resource name="jdbc/EmployeeDB" auth="Container"
            type="javax.sql.DataSource"
     description="Employees Database for HR Applications"/>
  ...
</GlobalNamingResources>]]></source>
</source>

    <p>This is equivalent to the inclusion of the following element in the
    web application deployment descriptor (<code>/WEB-INF/web.xml</code>):</p>
<source><![CDATA[<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>]]></source>
&lt;/resource-ref&gt;
</source>

    <p>but does <em>not</em> require modification of the deployment
    descriptor to customize this value.</p>

  </subsection>

  <subsection name="Resource Links">
    <p>Use <a href="context.html#Resource_Links"><code>&lt;ResourceLink&gt;</code></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>

    <source><![CDATA[<Context>
  <ResourceLink
    name="bean/MyBeanFactory"
    global="bean/MyBeanFactory"
    type="com.mycompany.MyBean"
  />
</Context>]]></source>
          />
        </Context>
      ]]>
    </source>

   </subsection>





  <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

  not match the name of a <strong>Host</strong> element will be routed to the
  default host.</p>

    <p><em>The description below uses the variable name $CATALINA_BASE to refer the
    <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.</em></p>
    </em></blockquote>

</section>


        specify the host name, 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>
      </attribute>

    <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>

<source><![CDATA[<Host name="localhost" ...>
&lt;Host name="localhost" ...&gt;
  ...
  <Valve className="org.apache.catalina.valves.AccessLogValve"
         prefix="localhost_access_log." suffix=".txt"
         pattern="common"/>
  ...
</Host>]]></source>
</source>

    <p>See <a href="valve.html#Access_Log_Valve">Access Log Valve</a>
    for more information on the configuration attributes that are
    supported.</p>


      for context.xml and/or WAR files.</li>
    </ol>

    <p>When <code>autoDeploy</code> is <code>true</code>, the automatic
    deployment process will monitor the deployed web applications for changes.
    Depending on exactly what changes, the web application will either be
    re-deployed or reloaded. Re-deployment involves the creation of a new web

    <p>This is accomplished by utilizing one or more <strong>Alias</strong>
    elements nested inside your <strong>Host</strong> element.  For
    example:</p>
<source><![CDATA[<Host name="www.mycompany.com" ...>
&lt;Host name="www.mycompany.com" ...&gt;
  ...
  <Alias>mycompany.com</Alias>
  ...
</Host>]]></source>
</source>

    <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

    it will be notified about the occurrence of the corresponding
    lifecycle events.  Configuration of such a listener looks like this:</p>

<source><![CDATA[<Host name="localhost" ...>
&lt;Host name="localhost" ...&gt;
  ...
  <Listener className="com.mycompany.mypackage.MyListener" ... >
  ...
</Host>]]></source>
</source>

    <p>Note that a Listener can have any number of additional properties
    that may be configured from this element.  Attribute names are matched

    not accepted will be rejected with an HTTP "Forbidden" error.
    Example filter declarations:</p>

<source><![CDATA[<Host name="localhost" ...>
&lt;Host name="localhost" ...&gt;
  ...
  <Valve className="org.apache.catalina.valves.RemoteHostValve"
         allow=".*\.mycompany\.com|www\.yourcompany\.com"/>
  <Valve className="org.apache.catalina.valves.RemoteAddrValve"
         deny="192\.168\.1\.\d+"/>
  ...
</Host>]]></source>
</source>

  <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>

  </subsection>

    host.  This can be accomplished by nesting an element like this inside
    the Host element for this virtual host:</p>

<source><![CDATA[<Host name="localhost" ...>
&lt;Host name="localhost" ...&gt;
  ...
  <Valve className="org.apache.catalina.authenticator.SingleSignOn"/>
  ...
</Host>]]></source>
</source>

    <p>The Single Sign On facility operates according to the following rules:
    </p>

    <strong>Listener</strong> element like this (on a Unix system that
    uses the <code>/etc/passwd</code> file to identify valid users):</p>

<source><![CDATA[<Host name="localhost" ...>
&lt;Host name="localhost" ...&gt;
  ...
  <Listener className="org.apache.catalina.startup.UserConfig"
            directoryName="public_html"
            userClass="org.apache.catalina.startup.PasswdUserDatabase"/>
  ...
</Host>]]></source>
</source>

    <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>

<source><![CDATA[<Host name="localhost" ...>
&lt;Host name="localhost" ...&gt;
  ...
  <Listener className="org.apache.catalina.startup.UserConfig"
            directoryName="public_html"
            homeBase=c:\Homes"
            userClass="org.apache.catalina.startup.HomesUserDatabase"/>
  ...
</Host>]]></source>
</source>

    <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>

<source>http://www.mycompany.com:8080/~craigmcc</source>
http://www.mycompany.com:8080/~craigmcc
</source>

    <p>Successful use of this feature requires recognition of the following
    considerations:</p>




        <code>org.apache.coyote.http11.Http11AprProtocol</code> -
              the APR/native connector.<br/>
        Custom implementations may also be used.<br/>
        Take a look at our <a href="#Connector_Comparison">Connector
        Comparison</a> chart. The configuration for both Java connectors is
        identical, for http and https.<br/>
        For more information on the APR connector and APR specific SSL settings

      <p>If this <strong>Connector</strong> is being used in a proxy
      configuration, configure this attribute to specify the server name
      to be returned for calls to <code>request.getServerName()</code>.
      See <a href="#Proxy_Support">Proxy Support</a> for more
      information.</p>
    </attribute>


      <p>If this <strong>Connector</strong> is being used in a proxy
      configuration, configure this attribute to specify the server port
      to be returned for calls to <code>request.getServerPort()</code>.
      See <a href="#Proxy_Support">Proxy Support</a> for more
      information.</p>
    </attribute>


      <code>scheme</code> and the <code>secure</code> attributes as well
      to pass the correct <code>request.getScheme()</code> and
      <code>request.isSecure()</code> values to the servlets
      See <a href="#SSL_Support">SSL Support</a> for more information.
      </p>
    </attribute>


      </attribute>
      <attribute name="socket.performanceConnectionTime" required="false">
        <p>(int)The first value for the performance settings. See
        <a href="http://docs.oracle.com/javase/7/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>
        All three performance attributes must be set else the JVM defaults will
        be used for all three.</p>
      </attribute>
      <attribute name="socket.performanceLatency" required="false">
        <p>(int)The second value for the performance settings. See
        <a href="http://docs.oracle.com/javase/7/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>
        All three performance attributes must be set else the JVM defaults will
        be used for all three.</p>
      </attribute>
      <attribute name="socket.performanceBandwidth" required="false">
        <p>(int)The third value for the performance settings. See
        <a href="http://docs.oracle.com/javase/7/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>
        All three performance attributes must be set else the JVM defaults will
        be used for all three.</p>
      </attribute>

      the JVM default is used. The permitted values may be obtained from the
      JVM documentation for the allowed values for
      <code>SSLSocket.setEnabledProtocols()</code> e.g.
      <a href="http://docs.oracle.com/javase/6/docs/technotes/guides/security/StandardNames.html#jssenames">
      Oracle Java 6</a> and
      <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames">
      Oracle Java 7</a>. Note: There is overlap between this attribute and
      <code>sslProtocol</code>.</p>

      default is <code>TLS</code>. The permitted values may be obtained from the
      JVM documentation for the allowed values for algorithm when creating an
      <code>SSLContext</code> instance e.g.
      <a href="http://docs.oracle.com/javase/6/docs/technotes/guides/security/StandardNames.html#SSLContext">
      Oracle Java 6</a> and
      <a href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#SSLContext">
      Oracle Java 7</a>. Note: There is overlap between this attribute and
      <code>sslEnabledProtocols</code>.</p>

  <subsection name="Connector Comparison">

    <p>Below is a small chart that shows how the connectors differentiate.</p>
    <source>
                       Java Blocking Connector   Java Non Blocking Connector   APR/native Connector
                                 BIO                         NIO                       APR
    Classname              Http11Protocol             Http11NioProtocol         Http11AprProtocol
    Tomcat Version           3.x onwards                 6.x onwards              5.5.x onwards
    Support Polling              NO                          YES                       YES
    Polling Size                 N/A                   maxConnections             maxConnections
    Read HTTP Request         Blocking                  Non Blocking                 Blocking
    Read HTTP Body            Blocking                  Sim Blocking                 Blocking
    Write HTTP Response       Blocking                  Sim Blocking                 Blocking
    Wait for next Request     Blocking                  Non Blocking               Non Blocking
    SSL Support               Java SSL                    Java SSL                   OpenSSL
    SSL Handshake             Blocking                  Non blocking                 Blocking
    Max Connections        maxConnections              maxConnections             maxConnections

    <table class="defaultTable" style="text-align: center;">
      <tr>
        <th />
        <th>Java Blocking Connector<br />BIO</th>
        <th>Java Nio Blocking Connector<br />NIO</th>
        <th>APR/native Connector<br />APR</th>
      </tr>
      <tr>
        <th style="text-align: left;">Classname</th>
        <td><code class="noHighlight">Http11Protocol</code></td>
        <td><code class="noHighlight">Http11NioProtocol</code></td>
        <td><code class="noHighlight">Http11AprProtocol</code></td>
      </tr>
      <tr>
        <th style="text-align: left;">Tomcat Version</th>
        <td>3.x onwards</td>
        <td>6.x onwards</td>
        <td>5.5.x onwards</td>
      </tr>
      <tr>
        <th style="text-align: left;">Support Polling</th>
        <td>NO</td>
        <td>YES</td>
        <td>YES</td>
      </tr>
      <tr>
        <th style="text-align: left;">Polling Size</th>
        <td>N/A</td>
        <td><code class="noHighlight">maxConnections</code></td>
        <td><code class="noHighlight">maxConnections</code></td>
      </tr>
      <tr>
        <th style="text-align: left;">Read HTTP Request</th>
        <td>Blocking</td>
        <td>Non Blocking</td>
        <td>Blocking</td>
      </tr>
      <tr>
        <th style="text-align: left;">Read HTTP Body</th>
        <td>Blocking</td>
        <td>Sim Blocking</td>
        <td>Blocking</td>
      </tr>
      <tr>
        <th style="text-align: left;">Write HTTP Response</th>
        <td>Blocking</td>
        <td>Sim Blocking</td>
        <td>Blocking</td>
      </tr>
      <tr>
        <th style="text-align: left;">Wait for next Request</th>
        <td>Blocking</td>
        <td>Non Blocking</td>
        <td>Non Blocking</td>
      </tr>
      <tr>
        <th style="text-align: left;">SSL Support</th>
        <td>Java SSL</td>
        <td>Java SSL</td>
        <td>OpenSSL</td>
      </tr>
      <tr>
        <th style="text-align: left;">SSL Handshake</th>
        <td>Blocking</td>
        <td>Non blocking</td>
        <td>Blocking</td>
      </tr>
      <tr>
        <th style="text-align: left;">Max Connections</th>
        <td><code class="noHighlight">maxConnections</code></td>
        <td><code class="noHighlight">maxConnections</code></td>
        <td><code class="noHighlight">maxConnections</code></td>
      </tr>
    </table>

    </source>

  </subsection>
</section>






    <h3>Using file-based Authentication and Authorisation</h3>

    <p>If this listener was configured in server.xml as:</p>
  <source><![CDATA[  <Listener className="org.apache.catalina.mbeans.JmxRemoteLifecycleListener"
          rmiRegistryPortPlatform="10001" rmiServerPortPlatform="10002" />]]></source>
    <p>with the following system properties set (e.g. in setenv.sh):</p>
  <source>  -Dcom.sun.management.jmxremote.password.file=$CATALINA_BASE/conf/jmxremote.password
    with the following system properties set (e.g. in setenv.sh):
  <source>
  -Dcom.sun.management.jmxremote.password.file=$CATALINA_BASE/conf/jmxremote.password
  -Dcom.sun.management.jmxremote.access.file=$CATALINA_BASE/conf/jmxremote.access
  -Dcom.sun.management.jmxremote.ssl=false</source>
    <p>$CATALINA_BASE/conf/jmxremote.password containing:</p>
  <source>admin letmein</source>
    <p>$CATALINA_BASE/conf/jmxremote.access containing:</p>
  <source>admin readwrite</source>
    <p>then opening ports 10001 (RMI Registry) and 10002 (JMX/RMI Server) in your
    $CATALINA_BASE/conf/jmxremote.access containing:
  <source>
  admin readwrite
  </source>
    then opening ports 10001 (RMI Registry) and 10002 (JMX/RMI Server) in your
    firewall would enable jconsole to connect to a Tomcat instance running
    behind a firewall using a connection string of the form:</p>
  <source>service:jmx:rmi://&lt;hostname&gt;:10002/jndi/rmi://&lt;hostname&gt;:10001/jmxrmi</source>
    <p>
  </source>
    with a user name of <code>admin</code> and a password of
    <code>letmein</code>.
    </p>


    <h3>Using JAAS</h3>

    <p>If we use the following system properties instead:</p>
  <source>  -Dcom.sun.management.jmxremote.login.config=Tomcat
  -Dcom.sun.management.jmxremote.login.config=Tomcat
  -Djava.security.auth.login.config=$CATALINA_BASE/conf/login.config
  -Dcom.sun.management.jmxremote.access.file=$CATALINA_BASE/conf/jmxremote.access
  -Dcom.sun.management.jmxremote.ssl=false</source>
    <p>$CATALINA_BASE/conf/login.config containing your choice of JAAS LoginModule implementation, for example:</p>
  <source>  Tomcat { /* should match to the com.sun.management.jmxremote.login.config property */
  <source>
  Tomcat { /* should match to the com.sun.management.jmxremote.login.config property */

    /* for illustration purposes only */
    com.sun.security.auth.module.LdapLoginModule REQUIRED

      userFilter="(&amp;(uid={USERNAME})(objectClass=inetOrgPerson))"
      authzIdentity="admin"
      debug=true;
  };</source>
    <p>$CATALINA_BASE/conf/jmxremote.access containing:</p>
  <source>admin readwrite</source>
    <p>
  admin readwrite
  </source>
    then we would need to provide LDAP credentials instead.
    </p>





  <p>For a more in-depth description of the class loader hierarchy
  that is implemented by Catalina, see <a href="../class-loader-howto.html">the ClassLoader HowTo</a>.</p>

    <p><em>The description below uses the variable name $CATALINA_BASE to refer the
    <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.</em></p>
    </em></blockquote>

</section>





    element - this is required for use of <code>PersistentManager</code>.</p>

    <p>This implementation of Manager supports the following attributes in
    addition to the <a href="#Common_Attributes">Common Attributes</a>
    described earlier.</p>

    <attributes>


      <attribute name="className" required="true">
        <p>It has the same meaning as described in the
        <a href="#Common_Attributes">Common Attributes</a> above.
        You <strong>must</strong> specify
        <code>org.apache.catalina.session.PersistentManager</code> to use
        this manager implementation.</p>

  Detailed SQL commands vary depending on the database you are using, but
  a script like this will generally be required:</p>

<source>create table tomcat_sessions (
create table tomcat_sessions (
  session_id     varchar(100) not null primary key,
  valid_session  char(1) not null,
  max_inactive   int not null,

  app_name       varchar(255),
  session_data   mediumblob,
  KEY kapp_name(app_name)
);</source>
</source>

  <p>In order for the JDBC Based Store to successfully connect to your
  database, the JDBC driver you configure must be visible to Tomcat's

    a <a href="context.html">Context</a> configuration file for your web
    application and add the following element there:</p>

    <source><![CDATA[<Manager pathname="" />]]></source>
  </subsection>

</section>




  <a href="../realm-howto.html">Container-Managed Security Guide</a>.
  </p>

    <p><em>The description below uses the variable name $CATALINA_BASE to refer the
    <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.</em></p>
    </em></blockquote>

</section>






    <property name="org.apache.catalina. STRICT_SERVLET_COMPLIANCE">
      <p>The default value of this system property is <code>false</code>.</p>
      <p>If this is <code>true</code> the default values will be changed for:</p>
      <ul>
      <li><code>org.apache.catalina.core.<br/>ApplicationContext.GET_RESOURCE_REQUIRE_SLASH</code></li>
      <li><code>org.apache.catalina.core.<br/>ApplicationDispatcher.WRAP_SAME_OBJECT</code></li>

      <li>The <code>xmlValidation</code> attribute of any
          <a href="context.html">Context</a> element.</li>
      </ul>

      <p>Note that changing a number of the above defaults is likely to break
      the majority of systems as some browsers are unable to correctly handle
      the cookie headers that result from a strict adherence to the


    <property name="org.apache.tomcat.websocket. STRICT_SPEC_COMPLIANCE">
      <p>The default value of this system property is <code>false</code>.</p>
      <p>If this is <code>true</code> the default values will be changed for:</p>
      <ul>
        <li><code>org.apache.tomcat.websocket.server#isEnforceNoAddAfterHandshake</code>
        (default changes from <code>false</code> to <code>true</code>)</li>
      </ul>

    </property>

    <property

         <code>org.apache.juli.logging.UserDataHelper.SUPPRESSION_TIME</code>.
         </p>
      <p>The default value is <code>INFO_THEN_DEBUG</code>.</p>
      <p>The errors currently logged using this system are:</p>
         <ul>
         <li>invalid cookies;</li>
         <li>invalid parameters;</li>

           <code>maxHeaderCount</code> or <code>maxParameterCount</code> limits
           of a <a href="http.html">connector</a>).</li>
         </ul>
         <p>Other errors triggered by invalid input data may be added to this
         system in later versions.</p>
    </property>





  Individual Valves have distinct processing capabilities, and are
  described individually below.</p>

    <p><em>The description below uses the variable name $CATALINA_BASE to refer the
    <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.</em></p>
    </em></blockquote>

</section>


    It is modeled after the
    <a href="http://httpd.apache.org/">Apache HTTP Server</a> log configuration
    syntax:
    </p>
    <ul>
    <li><b><code>%{xxx}i</code></b> for incoming headers</li>
    <li><b><code>%{xxx}o</code></b> for outgoing response headers</li>

    <li><b><code>%{xxx}s</code></b> xxx is an attribute in the HttpSession</li>
    <li><b><code>%{xxx}t</code></b> xxx is an enhanced SimpleDateFormat pattern</li>
    </ul>
    </p>

    <p>All formats supported by SimpleDateFormat are allowed in <code>%{xxx}t</code>.
    In addition the following extensions have been added:</p>


  <subsection name="Example">
    <p>To allow access only for the clients connecting from localhost:</p>
    <source><![CDATA[<Valve className="org.apache.catalina.valves.RemoteAddrValve"
   allow="127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1"/>]]></source>
       allow="127\.\d+\.\d+\.\d+|::1|0:0:0:0:0:0:0:1"/&gt;
</pre>
  </subsection>

</section>

    your virtual host, and then have their identity recognized by all other
    web applications on the same virtual host.</p>

    <p>See the <a href="host.html#Single_Sign_On">Single Sign On</a> special
    feature on the <strong>Host</strong> element for more information.</p>

  </subsection>





table {
  border-collapse: collapse;
  text-align: left;
}
table *:not(table) {
  /* Prevent border-collapsing for table child elements like <div> */
  border-collapse: separate;
}

main {
  /* Remove this once all IEs support <main> element */

}


table.defaultTable tr, table.detail-table tr {
    border: 1px solid #CCC;
}

table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) {
    background-color: #FAFBFF;
}

table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) {
    background-color: #EEEFFF;
}

table.defaultTable th, table.detail-table th {
  background-color: #88b;
  color: #fff;
}

table.detail-table th {
  background-color: #039acc;
  color: #fff;
}
table.detail-table td {
  background-color: #DAF2FA;
}

table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td {
  padding: 5px 8px;
  text-align: left;
}



Lines 307-312 Link Here

(-)webapps/docs/tomcat-docs.xsl (+2 lines)
307		307
308	<div class="subsection">	308	<div class="subsection">
309	<!-- Subsection heading -->	309	<!-- Subsection heading -->
		310	<!-- TODO: When a <subsection> is nested in another <subsection>,
		311	the output should be <h5>, not <h4>. Same with <h6>. -->
310	<h4 id="{$name}">	312	<h4 id="{$name}">
311	<xsl:value-of select="@name"/>	313	<xsl:value-of select="@name"/>
312	</h4>	314	</h4>

Return to bug 55383

Lines 186-202 Link Here

(-)webapps/docs/config/engine.xml (-22 / +16 lines)
186	<a href="host.html">Host</a>, or <a href="context.html">Context</a>	186	<a href="host.html">Host</a>, or <a href="context.html">Context</a>
187	by nesting a <a href="valve.html">Valve</a> element like this:</p>	187	by nesting a <a href="valve.html">Valve</a> element like this:</p>
188		188
189	<source>	189	<source><![CDATA[<Engine name="Standalone" ...>
190	<Engine name="Standalone" ...>
191	...	190	...
192	<Valve className="org.apache.catalina.valves.AccessLogValve"	191	<Valve className="org.apache.catalina.valves.AccessLogValve"
193	prefix="catalina_access_log." suffix=".txt"	192	prefix="catalina_access_log." suffix=".txt"
194	pattern="common"/>	193	pattern="common"/>
195	...	194	...
196	</Engine>	195	</Engine>]]></source>
197	</source>
198		196
199	<p>See <a href="valve.html#Access Log Valve">Access Log Valve</a>	197	<p>See <a href="valve.html#Access_Log_Valve">Access Log Valve</a>
200	for more information on the configuration attributes that are	198	for more information on the configuration attributes that are
201	supported.</p>	199	supported.</p>
202		200
Lines 213-225 Link Here
213	it will be notified about the occurrence of the corresponding	211	it will be notified about the occurrence of the corresponding
214	lifecycle events. Configuration of such a listener looks like this:</p>	212	lifecycle events. Configuration of such a listener looks like this:</p>
215		213
216	<source>	214	<source><![CDATA[<Engine name="Standalone" ...>
217	<Engine name="Standalone" ...>
218	...	215	...
219	<Listener className="com.mycompany.mypackage.MyListener" ... >	216	<Listener className="com.mycompany.mypackage.MyListener" ... >
220	...	217	...
221	</Engine>	218	</Engine>]]></source>
222	</source>
223		219
224	<p>Note that a Listener can have any number of additional properties	220	<p>Note that a Listener can have any number of additional properties
225	that may be configured from this element. Attribute names are matched	221	that may be configured from this element. Attribute names are matched
Lines 241-259 Link Here
241	not accepted will be rejected with an HTTP "Forbidden" error.	237	not accepted will be rejected with an HTTP "Forbidden" error.
242	Example filter declarations:</p>	238	Example filter declarations:</p>
243		239
244	<source>	240	<source><![CDATA[<Engine name="Standalone" ...>
245	<Engine name="Standalone" ...>
246	...	241	...
247	<Valve className="org.apache.catalina.valves.RemoteHostValve"	242	<Valve className="org.apache.catalina.valves.RemoteHostValve"
248	allow=".*\.mycompany\.com\|www\.yourcompany\.com"/>	243	allow=".*\.mycompany\.com\|www\.yourcompany\.com"/>
249	<Valve className="org.apache.catalina.valves.RemoteAddrValve"	244	<Valve className="org.apache.catalina.valves.RemoteAddrValve"
250	deny="192\.168\.1\.\d+"/>	245	deny="192\.168\.1\.\d+"/>
251	...	246	...
252	</Engine>	247	</Engine>]]></source>
253	</source>
254		248
255	<p>See <a href="valve.html#Remote Address Filter">Remote Address Filter</a>	249	<p>See <a href="valve.html#Remote_Address_Filter">Remote Address Filter</a>
256	and <a href="valve.html#Remote Host Filter">Remote Host Filter</a> for	250	and <a href="valve.html#Remote_Host_Filter">Remote Host Filter</a> for
257	more information about the configuration options that are supported.</p>	251	more information about the configuration options that are supported.</p>
258		252
259	</subsection>	253	</subsection>

Lines 48-54 Link Here

(-)webapps/docs/config/host.xml (-54 / +36 lines)
48	<p>In many cases, System Administrators wish to associate more than	48	<p>In many cases, System Administrators wish to associate more than
49	one network name (such as <code>www.mycompany.com</code> and	49	one network name (such as <code>www.mycompany.com</code> and
50	<code>company.com</code>) with the same virtual host and applications.	50	<code>company.com</code>) with the same virtual host and applications.
51	This can be accomplished using the <a href="#Host Name Aliases">Host	51	This can be accomplished using the <a href="#Host_Name_Aliases">Host
52	Name Aliases</a> feature discussed below.</p>	52	Name Aliases</a> feature discussed below.</p>
53		53
54	<p>One or more <strong>Host</strong> elements are nested inside an	54	<p>One or more <strong>Host</strong> elements are nested inside an
Lines 67-79 Link Here
67	not match the name of a <strong>Host</strong> element will be routed to the	67	not match the name of a <strong>Host</strong> element will be routed to the
68	default host.</p>	68	default host.</p>
69		69
70	<blockquote><em>	70	<p><em>The description below uses the variable name $CATALINA_BASE to refer the
71	<p>The description below uses the variable name $CATALINA_BASE to refer the
72	base directory against which most relative paths are resolved. If you have	71	base directory against which most relative paths are resolved. If you have
73	not configured Tomcat for multiple instances by setting a CATALINA_BASE	72	not configured Tomcat for multiple instances by setting a CATALINA_BASE
74	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,	73	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
75	the directory into which you have installed Tomcat.</p>	74	the directory into which you have installed Tomcat.</em></p>
76	</em></blockquote>
77		75
78	</section>	76	</section>
79		77
Lines 183-189 Link Here
183	specify the host name, Tomcat will convert it to lower case internally.	181	specify the host name, Tomcat will convert it to lower case internally.
184	One of the Hosts nested within an <a href="engine.html">Engine</a> MUST	182	One of the Hosts nested within an <a href="engine.html">Engine</a> MUST
185	have a name that matches the <code>defaultHost</code> setting for that	183	have a name that matches the <code>defaultHost</code> setting for that
186	Engine. See <a href="#Host Name Aliases">Host Name Aliases</a> for	184	Engine. See <a href="#Host_Name_Aliases">Host Name Aliases</a> for
187	information on how to assign more than one network name to the same	185	information on how to assign more than one network name to the same
188	virtual host.</p>	186	virtual host.</p>
189	</attribute>	187	</attribute>
Lines 337-353 Link Here
337	<a href="host.html">Host</a>, or <a href="context.html">Context</a>	335	<a href="host.html">Host</a>, or <a href="context.html">Context</a>
338	by nesting a <a href="valve.html">Valve</a> element like this:</p>	336	by nesting a <a href="valve.html">Valve</a> element like this:</p>
339		337
340	<source>	338	<source><![CDATA[<Host name="localhost" ...>
341	<Host name="localhost" ...>
342	...	339	...
343	<Valve className="org.apache.catalina.valves.AccessLogValve"	340	<Valve className="org.apache.catalina.valves.AccessLogValve"
344	prefix="localhost_access_log." suffix=".txt"	341	prefix="localhost_access_log." suffix=".txt"
345	pattern="common"/>	342	pattern="common"/>
346	...	343	...
347	</Host>	344	</Host>]]></source>
348	</source>
349		345
350	<p>See <a href="valve.html#Access Log Valve">Access Log Valve</a>	346	<p>See <a href="valve.html#Access_Log_Valve">Access Log Valve</a>
351	for more information on the configuration attributes that are	347	for more information on the configuration attributes that are
352	supported.</p>	348	supported.</p>
353		349
Lines 394-400 Link Here
394	for context.xml and/or WAR files.</li>	390	for context.xml and/or WAR files.</li>
395	</ol>	391	</ol>
396		392
397	<p>When <code>autoDeploy</code> is <true>true</true>, the automatic	393	<p>When <code>autoDeploy</code> is <code>true</code>, the automatic
398	deployment process will monitor the deployed web applications for changes.	394	deployment process will monitor the deployed web applications for changes.
399	Depending on exactly what changes, the web application will either be	395	Depending on exactly what changes, the web application will either be
400	re-deployed or reloaded. Re-deployment involves the creation of a new web	396	re-deployed or reloaded. Re-deployment involves the creation of a new web
Lines 451-463 Link Here
451	<p>This is accomplished by utilizing one or more <strong>Alias</strong>	447	<p>This is accomplished by utilizing one or more <strong>Alias</strong>
452	elements nested inside your <strong>Host</strong> element. For	448	elements nested inside your <strong>Host</strong> element. For
453	example:</p>	449	example:</p>
454	<source>	450	<source><![CDATA[<Host name="www.mycompany.com" ...>
455	<Host name="www.mycompany.com" ...>
456	...	451	...
457	<Alias>mycompany.com</Alias>	452	<Alias>mycompany.com</Alias>
458	...	453	...
459	</Host>	454	</Host>]]></source>
460	</source>
461		455
462	<p>In order for this strategy to be effective, all of the network names	456	<p>In order for this strategy to be effective, all of the network names
463	involved must be registered in your DNS server to resolve to the	457	involved must be registered in your DNS server to resolve to the
Lines 476-488 Link Here
476	it will be notified about the occurrence of the corresponding	470	it will be notified about the occurrence of the corresponding
477	lifecycle events. Configuration of such a listener looks like this:</p>	471	lifecycle events. Configuration of such a listener looks like this:</p>
478		472
479	<source>	473	<source><![CDATA[<Host name="localhost" ...>
480	<Host name="localhost" ...>
481	...	474	...
482	<Listener className="com.mycompany.mypackage.MyListener" ... >	475	<Listener className="com.mycompany.mypackage.MyListener" ... >
483	...	476	...
484	</Host>	477	</Host>]]></source>
485	</source>
486		478
487	<p>Note that a Listener can have any number of additional properties	479	<p>Note that a Listener can have any number of additional properties
488	that may be configured from this element. Attribute names are matched	480	that may be configured from this element. Attribute names are matched
Lines 504-522 Link Here
504	not accepted will be rejected with an HTTP "Forbidden" error.	496	not accepted will be rejected with an HTTP "Forbidden" error.
505	Example filter declarations:</p>	497	Example filter declarations:</p>
506		498
507	<source>	499	<source><![CDATA[<Host name="localhost" ...>
508	<Host name="localhost" ...>
509	...	500	...
510	<Valve className="org.apache.catalina.valves.RemoteHostValve"	501	<Valve className="org.apache.catalina.valves.RemoteHostValve"
511	allow=".*\.mycompany\.com\|www\.yourcompany\.com"/>	502	allow=".*\.mycompany\.com\|www\.yourcompany\.com"/>
512	<Valve className="org.apache.catalina.valves.RemoteAddrValve"	503	<Valve className="org.apache.catalina.valves.RemoteAddrValve"
513	deny="192\.168\.1\.\d+"/>	504	deny="192\.168\.1\.\d+"/>
514	...	505	...
515	</Host>	506	</Host>]]></source>
516	</source>
517		507
518	<p>See <a href="valve.html#Remote Address Filter">Remote Address Filter</a>	508	<p>See <a href="valve.html#Remote_Address_Filter">Remote Address Filter</a>
519	and <a href="valve.html#Remote Host Filter">Remote Host Filter</a> for	509	and <a href="valve.html#Remote_Host_Filter">Remote Host Filter</a> for
520	more information about the configuration options that are supported.</p>	510	more information about the configuration options that are supported.</p>
521		511
522	</subsection>	512	</subsection>
Lines 530-542 Link Here
530	host. This can be accomplished by nesting an element like this inside	520	host. This can be accomplished by nesting an element like this inside
531	the Host element for this virtual host:</p>	521	the Host element for this virtual host:</p>
532		522
533	<source>	523	<source><![CDATA[<Host name="localhost" ...>
534	<Host name="localhost" ...>
535	...	524	...
536	<Valve className="org.apache.catalina.authenticator.SingleSignOn"/>	525	<Valve className="org.apache.catalina.authenticator.SingleSignOn"/>
537	...	526	...
538	</Host>	527	</Host>]]></source>
539	</source>
540		528
541	<p>The Single Sign On facility operates according to the following rules:	529	<p>The Single Sign On facility operates according to the following rules:
542	</p>	530	</p>
Lines 582-596 Link Here
582	<strong>Listener</strong> element like this (on a Unix system that	570	<strong>Listener</strong> element like this (on a Unix system that
583	uses the <code>/etc/passwd</code> file to identify valid users):</p>	571	uses the <code>/etc/passwd</code> file to identify valid users):</p>
584		572
585	<source>	573	<source><![CDATA[<Host name="localhost" ...>
586	<Host name="localhost" ...>
587	...	574	...
588	<Listener className="org.apache.catalina.startup.UserConfig"	575	<Listener className="org.apache.catalina.startup.UserConfig"
589	directoryName="public_html"	576	directoryName="public_html"
590	userClass="org.apache.catalina.startup.PasswdUserDatabase"/>	577	userClass="org.apache.catalina.startup.PasswdUserDatabase"/>
591	...	578	...
592	</Host>	579	</Host>]]></source>
593	</source>
594		580
595	<p>On a server where <code>/etc/passwd</code> is not in use, you can	581	<p>On a server where <code>/etc/passwd</code> is not in use, you can
596	request Catalina to consider all directories found in a specified base	582	request Catalina to consider all directories found in a specified base
Lines 597-620 Link Here
597	directory (such as <code>c:\Homes</code> in this example) to be	583	directory (such as <code>c:\Homes</code> in this example) to be
598	considered "user home" directories for the purposes of this directive:</p>	584	considered "user home" directories for the purposes of this directive:</p>
599		585
600	<source>	586	<source><![CDATA[<Host name="localhost" ...>
601	<Host name="localhost" ...>
602	...	587	...
603	<Listener className="org.apache.catalina.startup.UserConfig"	588	<Listener className="org.apache.catalina.startup.UserConfig"
604	directoryName="public_html"	589	directoryName="public_html"
605	homeBase=c:\Homes"	590	homeBase=c:\Homes"
606	userClass="org.apache.catalina.startup.HomesUserDatabase"/>	591	userClass="org.apache.catalina.startup.HomesUserDatabase"/>
607	...	592	...
608	</Host>	593	</Host>]]></source>
609	</source>
610		594
611	<p>If a user home directory has been set up for a user named	595	<p>If a user home directory has been set up for a user named
612	<code>craigmcc</code>, then its contents will be visible from a	596	<code>craigmcc</code>, then its contents will be visible from a
613	client browser by making a request to a URL like:</p>	597	client browser by making a request to a URL like:</p>
614		598
615	<source>	599	<source>http://www.mycompany.com:8080/~craigmcc</source>
616	http://www.mycompany.com:8080/~craigmcc
617	</source>
618		600
619	<p>Successful use of this feature requires recognition of the following	601	<p>Successful use of this feature requires recognition of the following
620	considerations:</p>	602	considerations:</p>

Lines 174-180 Link Here

(-)webapps/docs/config/http.xml (-27 / +81 lines)
174	<code>org.apache.coyote.http11.Http11AprProtocol</code> -	174	<code>org.apache.coyote.http11.Http11AprProtocol</code> -
175	the APR/native connector.<br/>	175	the APR/native connector.<br/>
176	Custom implementations may also be used.<br/>	176	Custom implementations may also be used.<br/>
177	Take a look at our <a href="#Connector Comparison">Connector	177	Take a look at our <a href="#Connector_Comparison">Connector
178	Comparison</a> chart. The configuration for both Java connectors is	178	Comparison</a> chart. The configuration for both Java connectors is
179	identical, for http and https.<br/>	179	identical, for http and https.<br/>
180	For more information on the APR connector and APR specific SSL settings	180	For more information on the APR connector and APR specific SSL settings
Lines 186-192 Link Here
186	<p>If this <strong>Connector</strong> is being used in a proxy	186	<p>If this <strong>Connector</strong> is being used in a proxy
187	configuration, configure this attribute to specify the server name	187	configuration, configure this attribute to specify the server name
188	to be returned for calls to <code>request.getServerName()</code>.	188	to be returned for calls to <code>request.getServerName()</code>.
189	See <a href="#Proxy Support">Proxy Support</a> for more	189	See <a href="#Proxy_Support">Proxy Support</a> for more
190	information.</p>	190	information.</p>
191	</attribute>	191	</attribute>
192		192
Lines 194-200 Link Here
194	<p>If this <strong>Connector</strong> is being used in a proxy	194	<p>If this <strong>Connector</strong> is being used in a proxy
195	configuration, configure this attribute to specify the server port	195	configuration, configure this attribute to specify the server port
196	to be returned for calls to <code>request.getServerPort()</code>.	196	to be returned for calls to <code>request.getServerPort()</code>.
197	See <a href="#Proxy Support">Proxy Support</a> for more	197	See <a href="#Proxy_Support">Proxy Support</a> for more
198	information.</p>	198	information.</p>
199	</attribute>	199	</attribute>
200		200
Lines 489-495 Link Here
489	<code>scheme</code> and the <code>secure</code> attributes as well	489	<code>scheme</code> and the <code>secure</code> attributes as well
490	to pass the correct <code>request.getScheme()</code> and	490	to pass the correct <code>request.getScheme()</code> and
491	<code>request.isSecure()</code> values to the servlets	491	<code>request.isSecure()</code> values to the servlets
492	See <a href="#SSL Support">SSL Support</a> for more information.	492	See <a href="#SSL_Support">SSL Support</a> for more information.
493	</p>	493	</p>
494	</attribute>	494	</attribute>
495		495
Lines 565-583 Link Here
565	</attribute>	565	</attribute>
566	<attribute name="socket.performanceConnectionTime" required="false">	566	<attribute name="socket.performanceConnectionTime" required="false">
567	<p>(int)The first value for the performance settings. See	567	<p>(int)The first value for the performance settings. See
568	<a href="http://docs.oracle.com/javase/6/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>	568	<a href="http://docs.oracle.com/javase/7/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>
569	All three performance attributes must be set else the JVM defaults will	569	All three performance attributes must be set else the JVM defaults will
570	be used for all three.</p>	570	be used for all three.</p>
571	</attribute>	571	</attribute>
572	<attribute name="socket.performanceLatency" required="false">	572	<attribute name="socket.performanceLatency" required="false">
573	<p>(int)The second value for the performance settings. See	573	<p>(int)The second value for the performance settings. See
574	<a href="http://docs.oracle.com/javase/6/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>	574	<a href="http://docs.oracle.com/javase/7/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>
575	All three performance attributes must be set else the JVM defaults will	575	All three performance attributes must be set else the JVM defaults will
576	be used for all three.</p>	576	be used for all three.</p>
577	</attribute>	577	</attribute>
578	<attribute name="socket.performanceBandwidth" required="false">	578	<attribute name="socket.performanceBandwidth" required="false">
579	<p>(int)The third value for the performance settings. See	579	<p>(int)The third value for the performance settings. See
580	<a href="http://docs.oracle.com/javase/6/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>	580	<a href="http://docs.oracle.com/javase/7/docs/api/java/net/Socket.html#setPerformancePreferences(int,%20int,%20int)">Socket Performance Options</a>
581	All three performance attributes must be set else the JVM defaults will	581	All three performance attributes must be set else the JVM defaults will
582	be used for all three.</p>	582	be used for all three.</p>
583	</attribute>	583	</attribute>
Lines 1029-1036 Link Here
1029	the JVM default is used. The permitted values may be obtained from the	1029	the JVM default is used. The permitted values may be obtained from the
1030	JVM documentation for the allowed values for	1030	JVM documentation for the allowed values for
1031	<code>SSLSocket.setEnabledProtocols()</code> e.g.	1031	<code>SSLSocket.setEnabledProtocols()</code> e.g.
1032	<a href="http://docs.oracle.com/javase/6/docs/technotes/guides/security/StandardNames.html#jssenames">
1033	Oracle Java 6</a> and
1034	<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames">	1032	<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#jssenames">
1035	Oracle Java 7</a>. Note: There is overlap between this attribute and	1033	Oracle Java 7</a>. Note: There is overlap between this attribute and
1036	<code>sslProtocol</code>.</p>	1034	<code>sslProtocol</code>.</p>
Lines 1049-1056 Link Here
1049	default is <code>TLS</code>. The permitted values may be obtained from the	1047	default is <code>TLS</code>. The permitted values may be obtained from the
1050	JVM documentation for the allowed values for algorithm when creating an	1048	JVM documentation for the allowed values for algorithm when creating an
1051	<code>SSLContext</code> instance e.g.	1049	<code>SSLContext</code> instance e.g.
1052	<a href="http://docs.oracle.com/javase/6/docs/technotes/guides/security/StandardNames.html#SSLContext">
1053	Oracle Java 6</a> and
1054	<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#SSLContext">	1050	<a href="http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#SSLContext">
1055	Oracle Java 7</a>. Note: There is overlap between this attribute and	1051	Oracle Java 7</a>. Note: There is overlap between this attribute and
1056	<code>sslEnabledProtocols</code>.</p>	1052	<code>sslEnabledProtocols</code>.</p>
Lines 1249-1272 Link Here
1249	<subsection name="Connector Comparison">	1245	<subsection name="Connector Comparison">
1250		1246
1251	<p>Below is a small chart that shows how the connectors differentiate.</p>	1247	<p>Below is a small chart that shows how the connectors differentiate.</p>
1252	<source>
1253	Java Blocking Connector Java Non Blocking Connector APR/native Connector
1254	BIO NIO APR
1255	Classname Http11Protocol Http11NioProtocol Http11AprProtocol
1256	Tomcat Version 3.x onwards 6.x onwards 5.5.x onwards
1257	Support Polling NO YES YES
1258	Polling Size N/A maxConnections maxConnections
1259	Read HTTP Request Blocking Non Blocking Blocking
1260	Read HTTP Body Blocking Sim Blocking Blocking
1261	Write HTTP Response Blocking Sim Blocking Blocking
1262	Wait for next Request Blocking Non Blocking Non Blocking
1263	SSL Support Java SSL Java SSL OpenSSL
1264	SSL Handshake Blocking Non blocking Blocking
1265	Max Connections maxConnections maxConnections maxConnections
1266		1248
		1249	<table class="defaultTable" style="text-align: center;">
		1250	<tr>
		1251	<th />
		1252	<th>Java Blocking Connector<br />BIO</th>
		1253	<th>Java Nio Blocking Connector<br />NIO</th>
		1254	<th>APR/native Connector<br />APR</th>
		1255	</tr>
		1256	<tr>
		1257	<th style="text-align: left;">Classname</th>
		1258	<td><code class="noHighlight">Http11Protocol</code></td>
		1259	<td><code class="noHighlight">Http11NioProtocol</code></td>
		1260	<td><code class="noHighlight">Http11AprProtocol</code></td>
		1261	</tr>
		1262	<tr>
		1263	<th style="text-align: left;">Tomcat Version</th>
		1264	<td>3.x onwards</td>
		1265	<td>6.x onwards</td>
		1266	<td>5.5.x onwards</td>
		1267	</tr>
		1268	<tr>
		1269	<th style="text-align: left;">Support Polling</th>
		1270	<td>NO</td>
		1271	<td>YES</td>
		1272	<td>YES</td>
		1273	</tr>
		1274	<tr>
		1275	<th style="text-align: left;">Polling Size</th>
		1276	<td>N/A</td>
		1277	<td><code class="noHighlight">maxConnections</code></td>
		1278	<td><code class="noHighlight">maxConnections</code></td>
		1279	</tr>
		1280	<tr>
		1281	<th style="text-align: left;">Read HTTP Request</th>
		1282	<td>Blocking</td>
		1283	<td>Non Blocking</td>
		1284	<td>Blocking</td>
		1285	</tr>
		1286	<tr>
		1287	<th style="text-align: left;">Read HTTP Body</th>
		1288	<td>Blocking</td>
		1289	<td>Sim Blocking</td>
		1290	<td>Blocking</td>
		1291	</tr>
		1292	<tr>
		1293	<th style="text-align: left;">Write HTTP Response</th>
		1294	<td>Blocking</td>
		1295	<td>Sim Blocking</td>
		1296	<td>Blocking</td>
		1297	</tr>
		1298	<tr>
		1299	<th style="text-align: left;">Wait for next Request</th>
		1300	<td>Blocking</td>
		1301	<td>Non Blocking</td>
		1302	<td>Non Blocking</td>
		1303	</tr>
		1304	<tr>
		1305	<th style="text-align: left;">SSL Support</th>
		1306	<td>Java SSL</td>
		1307	<td>Java SSL</td>
		1308	<td>OpenSSL</td>
		1309	</tr>
		1310	<tr>
		1311	<th style="text-align: left;">SSL Handshake</th>
		1312	<td>Blocking</td>
1313	<td>Non blocking</td>
1314	<td>Blocking</td>
1315	</tr>
1316	<tr>
1317	<th style="text-align: left;">Max Connections</th>
1318	<td><code class="noHighlight">maxConnections</code></td>
1319	<td><code class="noHighlight">maxConnections</code></td>
1320	<td><code class="noHighlight">maxConnections</code></td>
1321	</tr>
1322	</table>
1267		1323
1268	</source>
1269
1270	</subsection>	1324	</subsection>
1271	</section>	1325	</section>
1272		1326

Lines 451-481 Link Here

(-)webapps/docs/config/listeners.xml (-37 / +23 lines)
451		451
452	<h3>Using file-based Authentication and Authorisation</h3>	452	<h3>Using file-based Authentication and Authorisation</h3>
453		453
454	<p>If this listener was configured in server.xml as:	454	<p>If this listener was configured in server.xml as:</p>
455	<source>	455	<source><![CDATA[ <Listener className="org.apache.catalina.mbeans.JmxRemoteLifecycleListener"
456	<Listener className="org.apache.catalina.mbeans.JmxRemoteLifecycleListener"	456	rmiRegistryPortPlatform="10001" rmiServerPortPlatform="10002" />]]></source>
457	rmiRegistryPortPlatform="10001" rmiServerPortPlatform="10002" />	457	<p>with the following system properties set (e.g. in setenv.sh):</p>
458	</source>	458	<source> -Dcom.sun.management.jmxremote.password.file=$CATALINA_BASE/conf/jmxremote.password
459	with the following system properties set (e.g. in setenv.sh):
460	<source>
461	-Dcom.sun.management.jmxremote.password.file=$CATALINA_BASE/conf/jmxremote.password
462	-Dcom.sun.management.jmxremote.access.file=$CATALINA_BASE/conf/jmxremote.access	459	-Dcom.sun.management.jmxremote.access.file=$CATALINA_BASE/conf/jmxremote.access
463	-Dcom.sun.management.jmxremote.ssl=false	460	-Dcom.sun.management.jmxremote.ssl=false</source>
464	</source>	461	<p>$CATALINA_BASE/conf/jmxremote.password containing:</p>
465	$CATALINA_BASE/conf/jmxremote.password containing:	462	<source>admin letmein</source>
466	<source>	463	<p>$CATALINA_BASE/conf/jmxremote.access containing:</p>
467	admin letmein	464	<source>admin readwrite</source>
468	</source>	465	<p>then opening ports 10001 (RMI Registry) and 10002 (JMX/RMI Server) in your
469	$CATALINA_BASE/conf/jmxremote.access containing:
470	<source>
471	admin readwrite
472	</source>
473	then opening ports 10001 (RMI Registry) and 10002 (JMX/RMI Server) in your
474	firewall would enable jconsole to connect to a Tomcat instance running	466	firewall would enable jconsole to connect to a Tomcat instance running
475	behind a firewall using a connection string of the form:	467	behind a firewall using a connection string of the form:</p>
476	<source>	468	<source>service:jmx:rmi://<hostname>:10002/jndi/rmi://<hostname>:10001/jmxrmi</source>
477	service:jmx:rmi://<hostname>:10002/jndi/rmi://<hostname>:10001/jmxrmi	469	<p>
478	</source>
479	with a user name of <code>admin</code> and a password of	470	with a user name of <code>admin</code> and a password of
480	<code>letmein</code>.	471	<code>letmein</code>.
481	</p>	472	</p>
Lines 482-497 Link Here
482		473
483	<h3>Using JAAS</h3>	474	<h3>Using JAAS</h3>
484		475
485	<p>If we use the following system properties instead:	476	<p>If we use the following system properties instead:</p>
486	<source>	477	<source> -Dcom.sun.management.jmxremote.login.config=Tomcat
487	-Dcom.sun.management.jmxremote.login.config=Tomcat
488	-Djava.security.auth.login.config=$CATALINA_BASE/conf/login.config	478	-Djava.security.auth.login.config=$CATALINA_BASE/conf/login.config
489	-Dcom.sun.management.jmxremote.access.file=$CATALINA_BASE/conf/jmxremote.access	479	-Dcom.sun.management.jmxremote.access.file=$CATALINA_BASE/conf/jmxremote.access
490	-Dcom.sun.management.jmxremote.ssl=false	480	-Dcom.sun.management.jmxremote.ssl=false</source>
491	</source>	481	<p>$CATALINA_BASE/conf/login.config containing your choice of JAAS LoginModule implementation, for example:</p>
492	$CATALINA_BASE/conf/login.config containing your choice of JAAS LoginModule implementation, for example:	482	<source> Tomcat { /* should match to the com.sun.management.jmxremote.login.config property */
493	<source>
494	Tomcat { /* should match to the com.sun.management.jmxremote.login.config property */
495		483
496	/* for illustration purposes only */	484	/* for illustration purposes only */
497	com.sun.security.auth.module.LdapLoginModule REQUIRED	485	com.sun.security.auth.module.LdapLoginModule REQUIRED
Lines 499-510 Link Here
499	userFilter="(&(uid={USERNAME})(objectClass=inetOrgPerson))"	487	userFilter="(&(uid={USERNAME})(objectClass=inetOrgPerson))"
500	authzIdentity="admin"	488	authzIdentity="admin"
501	debug=true;	489	debug=true;
502	};	490	};</source>
503	</source>	491	<p>$CATALINA_BASE/conf/jmxremote.access containing:</p>
504	$CATALINA_BASE/conf/jmxremote.access containing:	492	<source>admin readwrite</source>
505	<source>	493	<p>
506	admin readwrite
507	</source>
508	then we would need to provide LDAP credentials instead.	494	then we would need to provide LDAP credentials instead.
509	</p>	495	</p>
510		496

Lines 156-162 Link Here

(-)webapps/docs/appdev/deployment.xml (-5 / +3 lines)
156	in Chapter 13 of the Servlet API Specification, version 2.3. Over time, it	156	in Chapter 13 of the Servlet API Specification, version 2.3. Over time, it
157	is expected that development tools will be provided that create and edit the	157	is expected that development tools will be provided that create and edit the
158	deployment descriptor for you. In the meantime, to provide a starting point,	158	deployment descriptor for you. In the meantime, to provide a starting point,
159	a <a href="web.xml.txt" target="_new">basic web.xml file</a>	159	a <a href="web.xml.txt" target="_blank">basic web.xml file</a>
160	is provided. This file includes comments that describe the purpose of each	160	is provided. This file includes comments that describe the purpose of each
161	included element.</p>	161	included element.</p>
162		162
Lines 186-198 Link Here
186		186
187	<section name="Deployment With Tomcat">	187	<section name="Deployment With Tomcat">
188		188
189	<blockquote><em>	189	<p><em>The description below uses the variable name $CATALINA_BASE to refer the
190	<p>The description below uses the variable name $CATALINA_BASE to refer the
191	base directory against which most relative paths are resolved. If you have	190	base directory against which most relative paths are resolved. If you have
192	not configured Tomcat for multiple instances by setting a CATALINA_BASE	191	not configured Tomcat for multiple instances by setting a CATALINA_BASE
193	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,	192	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
194	the directory into which you have installed Tomcat.</p>	193	the directory into which you have installed Tomcat.</em></p>
195	</em></blockquote>
196		194
197	<p>In order to be executed, a web application must be deployed on	195	<p>In order to be executed, a web application must be deployed on
198	a servlet container. This is true even during development.	196	a servlet container. This is true even during development.

Lines 47-53 Link Here

(-)webapps/docs/appdev/introduction.xml (-5 / +5 lines)
47		47
48	<p>The discussion in this manual is aimed at developers who will be using	48	<p>The discussion in this manual is aimed at developers who will be using
49	a text editor along with command line tools to develop and debug their	49	a text editor along with command line tools to develop and debug their
50	applications. As such, the recommendations are fairly generic -- but you	50	applications. As such, the recommendations are fairly generic – but you
51	should easily be able to apply them in either a Windows-based or Unix-based	51	should easily be able to apply them in either a Windows-based or Unix-based
52	development environment. If you are utilizing an Integrated Development	52	development environment. If you are utilizing an Integrated Development
53	Environment (IDE) tool, you will need to adapt the advice given here to	53	Environment (IDE) tool, you will need to adapt the advice given here to
Lines 62-68 Link Here
62	information, documentation, and software that is useful in developing	62	information, documentation, and software that is useful in developing
63	web applications with Tomcat.</p>	63	web applications with Tomcat.</p>
64	<ul>	64	<ul>
65	<li><a href="http://jcp.org/aboutJava/communityprocess/mrel/jsr245/index2.html">http://jcp.org/aboutJava/communityprocess/mrel/jsr245/index2.html</a> -	65	<li><p><a href="http://jcp.org/aboutJava/communityprocess/mrel/jsr245/index2.html">http://jcp.org/aboutJava/communityprocess/mrel/jsr245/index2.html</a> -
66	<i>JavaServer Pages (JSP) Specification, Version 2.3</i>. Describes	66	<i>JavaServer Pages (JSP) Specification, Version 2.3</i>. Describes
67	the programming environment provided by standard implementations	67	the programming environment provided by standard implementations
68	of the JavaServer Pages (JSP) technology. In conjunction with	68	of the JavaServer Pages (JSP) technology. In conjunction with
Lines 71-78 Link Here
71	information on scripting (Chapter 9), tag extensions (Chapter 7),	71	information on scripting (Chapter 9), tag extensions (Chapter 7),
72	and packaging JSP pages (Appendix A) is useful. The Javadoc	72	and packaging JSP pages (Appendix A) is useful. The Javadoc
73	API Documentation is included in the specification, and with the	73	API Documentation is included in the specification, and with the
74	Tomcat download.<br/><br/></li>	74	Tomcat download.</p></li>
75	<li><a href="http://jcp.org/aboutJava/communityprocess/final/jsr340/index.html">http://jcp.org/aboutJava/communityprocess/final/jsr340/index.html</a> -	75	<li><p><a href="http://jcp.org/aboutJava/communityprocess/final/jsr340/index.html">http://jcp.org/aboutJava/communityprocess/final/jsr340/index.html</a> -
76	<i>Servlet API Specification, Version 3.1</i>. Describes the	76	<i>Servlet API Specification, Version 3.1</i>. Describes the
77	programming environment that must be provided by all servlet	77	programming environment that must be provided by all servlet
78	containers conforming to this specification. In particular, you	78	containers conforming to this specification. In particular, you
Lines 82-88 Link Here
82	security (Chapter 13), and the syntax of the <code>web.xml</code>	82	security (Chapter 13), and the syntax of the <code>web.xml</code>
83	Web Application Deployment Descriptor (Chapter 14). The Javadoc	83	Web Application Deployment Descriptor (Chapter 14). The Javadoc
84	API Documentation is included in the specification, and with the	84	API Documentation is included in the specification, and with the
85	Tomcat download.<br/><br/></li>	85	Tomcat download.</p></li>
86	</ul>	86	</ul>
87		87
88	</section>	88	</section>

Lines 56-67 Link Here

(-)webapps/docs/appdev/processes.xml (-66 / +52 lines)
56	<em>Manager</em> web application, you need to perform the following tasks	56	<em>Manager</em> web application, you need to perform the following tasks
57	once (no matter how many web applications you plan to develop).</p>	57	once (no matter how many web applications you plan to develop).</p>
58	<ul>	58	<ul>
59	<li><em>Configure the Ant custom tasks</em>. The implementation code for the	59	<li><p><em>Configure the Ant custom tasks</em>. The implementation code for the
60	Ant custom tasks is in a JAR file named	60	Ant custom tasks is in a JAR file named
61	<code>$CATALINA_HOME/lib/catalina-ant.jar</code>, which must be	61	<code>$CATALINA_HOME/lib/catalina-ant.jar</code>, which must be
62	copied in to the <code>lib</code> directory of your Ant installation.	62	copied in to the <code>lib</code> directory of your Ant installation.
63	<br/><br/></li>	63	</p></li>
64	<li><em>Define one or more Tomcat users</em>. The <em>Manager</em> web	64	<li><p><em>Define one or more Tomcat users</em>. The <em>Manager</em> web
65	application runs under a security constraint that requires a user to be	65	application runs under a security constraint that requires a user to be
66	logged in, and have the security role <code>manager-script</code> assigned	66	logged in, and have the security role <code>manager-script</code> assigned
67	to him or her. How such users are defined depends on which Realm you have	67	to him or her. How such users are defined depends on which Realm you have
Lines 69-75 Link Here
69	<a href="../realm-howto.html">Realm Configuration HOW-TO</a> for more	69	<a href="../realm-howto.html">Realm Configuration HOW-TO</a> for more
70	information. You may define any number of users (with any username	70	information. You may define any number of users (with any username
71	and password that you like) with the <code>manager-script</code> role.	71	and password that you like) with the <code>manager-script</code> role.
72	<br/><br/></li>	72	</p></li>
73	</ul>	73	</ul>
74		74
75	</subsection>	75	</subsection>
Lines 87-95 Link Here
87	repository. This might be done by a series of commands like this, where	87	repository. This might be done by a series of commands like this, where
88	<code>{project}</code> is the name under which your project should be	88	<code>{project}</code> is the name under which your project should be
89	stored in the CVS repository, and {username} is your login username:</p>	89	stored in the CVS repository, and {username} is your login username:</p>
90	<source>	90	<source><![CDATA[cd {my home directory}
91	cd {my home directory}	91	mkdir myapp <-- Assumed "project source directory"
92	mkdir myapp <-- Assumed "project source directory"
93	cd myapp	92	cd myapp
94	mkdir docs	93	mkdir docs
95	mkdir src	94	mkdir src
Lines 96-111 Link Here
96	mkdir web	95	mkdir web
97	mkdir web/WEB-INF	96	mkdir web/WEB-INF
98	cvs import -m "Initial Project Creation" {project} \	97	cvs import -m "Initial Project Creation" {project} \
99	{username} start	98	{username} start]]></source>
100	</source>
101		99
102	<p>Now, to verify that it was created correctly in CVS, we will perform a	100	<p>Now, to verify that it was created correctly in CVS, we will perform a
103	checkout of the new project:</p>	101	checkout of the new project:</p>
104	<source>	102	<source><![CDATA[cd ..
105	cd ..
106	mv myapp myapp.bu	103	mv myapp myapp.bu
107	cvs checkout {project}	104	cvs checkout {project}]]></source>
108	</source>
109		105
110	<p>Next, you will need to create and check in an initial version of the	106	<p>Next, you will need to create and check in an initial version of the
111	<code>build.xml</code> script to be used for development. For getting	107	<code>build.xml</code> script to be used for development. For getting
Lines 112-124 Link Here
112	started quickly and easily, base your <code>build.xml</code> on the	108	started quickly and easily, base your <code>build.xml</code> on the
113	<a href="build.xml.txt">basic build.xml file</a>, included with this manual,	109	<a href="build.xml.txt">basic build.xml file</a>, included with this manual,
114	or code it from scratch.</p>	110	or code it from scratch.</p>
115	<source>	111	<source><![CDATA[cd {my home directory}
116	cd {my home directory}
117	cd myapp	112	cd myapp
118	emacs build.xml <-- if you want a real editor :-)	113	emacs build.xml <-- if you want a real editor :-)
119	cvs add build.xml	114	cvs add build.xml
120	cvs commit	115	cvs commit]]></source>
121	</source>
122		116
123	<p>Until you perform the CVS commit, your changes are local to your own	117	<p>Until you perform the CVS commit, your changes are local to your own
124	development directory. Committing makes those changes visible to other	118	development directory. Committing makes those changes visible to other
Lines 132-139 Link Here
132	need to define the <code>catalina.home</code> property defining where	126	need to define the <code>catalina.home</code> property defining where
133	Tomcat is installed, and the manager application username and password.	127	Tomcat is installed, and the manager application username and password.
134	You might end up with something like this:</p>	128	You might end up with something like this:</p>
135	<source>	129	<source><![CDATA[# Context path to install this application on
136	# Context path to install this application on
137	app.path=/hello	130	app.path=/hello
138		131
139	# Tomcat 7 installation directory	132	# Tomcat 7 installation directory
Lines 141-148 Link Here
141		134
142	# Manager webapp username and password	135	# Manager webapp username and password
143	manager.username=myusername	136	manager.username=myusername
144	manager.password=mypassword	137	manager.password=mypassword]]></source>
145	</source>
146		138
147	<p>In general, you will <strong>not</strong> want to check the	139	<p>In general, you will <strong>not</strong> want to check the
148	<code>build.properties</code> file in to the CVS repository, because it	140	<code>build.properties</code> file in to the CVS repository, because it
Lines 151-163 Link Here
151	<p>Now, create the initial version of the web application deployment	143	<p>Now, create the initial version of the web application deployment
152	descriptor. You can base <code>web.xml</code> on the	144	descriptor. You can base <code>web.xml</code> on the
153	<a href="web.xml.txt">basic web.xml file</a>, or code it from scratch.</p>	145	<a href="web.xml.txt">basic web.xml file</a>, or code it from scratch.</p>
154	<source>	146	<source><![CDATA[cd {my home directory}
155	cd {my home directory}
156	cd myapp/web/WEB-INF	147	cd myapp/web/WEB-INF
157	emacs web.xml	148	emacs web.xml
158	cvs add web.xml	149	cvs add web.xml
159	cvs commit	150	cvs commit]]></source>
160	</source>
161		151
162	Note that this is only an example web.xml file. The full definition	152	Note that this is only an example web.xml file. The full definition
163	of the deployment descriptor file is in the	153	of the deployment descriptor file is in the
Lines 176-199 Link Here
176		166
177	<p>Whenever you wish to refresh your development directory to reflect the	167	<p>Whenever you wish to refresh your development directory to reflect the
178	work performed by other developers, you will ask CVS to do it for you:</p>	168	work performed by other developers, you will ask CVS to do it for you:</p>
179	<source>	169	<source><![CDATA[cd {my home directory}
180	cd {my home directory}
181	cd myapp	170	cd myapp
182	cvs update -dP	171	cvs update -dP]]></source>
183	</source>
184		172
185	<p>To create a new file, go to the appropriate directory, create the file,	173	<p>To create a new file, go to the appropriate directory, create the file,
186	and register it with CVS. When you are satisfied with it's contents (after	174	and register it with CVS. When you are satisfied with it's contents (after
187	building and testing is successful), commit the new file to the repository.	175	building and testing is successful), commit the new file to the repository.
188	For example, to create a new JSP page:</p>	176	For example, to create a new JSP page:</p>
189	<source>	177	<source><![CDATA[cd {my home directory}
190	cd {my home directory}	178	cd myapp/web <-- Ultimate destination is document root
191	cd myapp/web <-- Ultimate destination is document root
192	emacs mypage.jsp	179	emacs mypage.jsp
193	cvs add mypage.jsp	180	cvs add mypage.jsp
194	... build and test the application ...	181	... build and test the application ...
195	cvs commit	182	cvs commit]]></source>
196	</source>
197		183
198	<p>Java source code that is defined in packages must be organized in a	184	<p>Java source code that is defined in packages must be organized in a
199	directory hierarchy (under the <strong>src/</strong> subdirectory) that	185	directory hierarchy (under the <strong>src/</strong> subdirectory) that
Lines 216-226 Link Here
216	<p>When you are ready to compile the application, issue the following	202	<p>When you are ready to compile the application, issue the following
217	commands (generally, you will want a shell window open that is set to	203	commands (generally, you will want a shell window open that is set to
218	the project source directory, so that only the last command is needed):</p>	204	the project source directory, so that only the last command is needed):</p>
219	<source>	205	<source><![CDATA[cd {my home directory}
220	cd {my home directory}	206	cd myapp <-- Normally leave a window open here
221	cd myapp <-- Normally leave a window open here	207	ant]]></source>
222	ant
223	</source>
224		208
225	<p>The Ant tool will be execute the default "compile" target in your	209	<p>The Ant tool will be execute the default "compile" target in your
226	<code>build.xml</code> file, which will compile any new or updated Java	210	<code>build.xml</code> file, which will compile any new or updated Java
Lines 228-238 Link Here
228	it will cause everything to be recompiled.</p>	212	it will cause everything to be recompiled.</p>
229		213
230	<p>To force the recompilation of your entire application, do this instead:</p>	214	<p>To force the recompilation of your entire application, do this instead:</p>
231	<source>	215	<source><![CDATA[cd {my home directory}
232	cd {my home directory}
233	cd myapp	216	cd myapp
234	ant all	217	ant all]]></source>
235	</source>
236		218
237	<p>This is a very good habit immediately before checking in changes, to	219	<p>This is a very good habit immediately before checking in changes, to
238	make sure that you have not introduced any subtle problems that Javac's	220	make sure that you have not introduced any subtle problems that Javac's
Lines 248-283 Link Here
248	the sample <code>build.xml</code> script. Using these commands might follow	230	the sample <code>build.xml</code> script. Using these commands might follow
249	a pattern like this:</p>	231	a pattern like this:</p>
250	<ul>	232	<ul>
251	<li><em>Start Tomcat if needed</em>. If Tomcat is not already running,	233	<li><p><em>Start Tomcat if needed</em>. If Tomcat is not already running,
252	you will need to start it in the usual way.	234	you will need to start it in the usual way.
253	<br/><br/></li>	235	</p></li>
254	<li><em>Compile your application</em>. Use the <code>ant compile</code>	236	<li><p><em>Compile your application</em>. Use the <code>ant compile</code>
255	command (or just <code>ant</code>, since this is the default). Make	237	command (or just <code>ant</code>, since this is the default). Make
256	sure that there are no compilation errors.	238	sure that there are no compilation errors.
257	<br/><br/></li>	239	</p></li>
258	<li><em>Install the application</em>. Use the <code>ant install</code>	240	<li><p><em>Install the application</em>. Use the <code>ant install</code>
259	command. This tells Tomcat to immediately start running your app on	241	command. This tells Tomcat to immediately start running your app on
260	the context path defined in the <code>app.path</code> build property.	242	the context path defined in the <code>app.path</code> build property.
261	Tomcat does <strong>NOT</strong> have to be restarted for this to	243	Tomcat does <strong>NOT</strong> have to be restarted for this to
262	take effect.<br/><br/></li>	244	take effect.
263	<li><em>Test the application</em>. Using your browser or other testing	245	</p></li>
		246	<li><p><em>Test the application</em>. Using your browser or other testing
264	tools, test the functionality of your application.	247	tools, test the functionality of your application.
265	<br/><br/></li>	248	</p></li>
266	<li><em>Modify and rebuild as needed</em>. As you discover that changes	249	<li><p><em>Modify and rebuild as needed</em>. As you discover that changes
267	are required, make those changes in the original <strong>source</strong>	250	are required, make those changes in the original <strong>source</strong>
268	files, not in the output build directory, and re-issue the	251	files, not in the output build directory, and re-issue the
269	<code>ant compile</code> command. This ensures that your changes will	252	<code>ant compile</code> command. This ensures that your changes will
270	be available to be saved (via <code>cvs commit</code>) later on --	253	be available to be saved (via <code>cvs commit</code>) later on --
271	the output build directory is deleted and recreated as necessary.	254	the output build directory is deleted and recreated as necessary.
272	<br/><br/></li>	255	</p></li>
273	<li><em>Reload the application</em>. Tomcat will recognize changes in	256	<li><p><em>Reload the application</em>. Tomcat will recognize changes in
274	JSP pages automatically, but it will continue to use the old versions	257	JSP pages automatically, but it will continue to use the old versions
275	of any servlet or JavaBean classes until the application is reloaded.	258	of any servlet or JavaBean classes until the application is reloaded.
276	You can trigger this by executing the <code>ant reload</code> command.	259	You can trigger this by executing the <code>ant reload</code> command.
277	<br/><br/></li>	260	</p></li>
278	<li><em>Remove the application when you re done</em>. When you are through	261	<li><p><em>Remove the application when you are done</em>. When you are through
279	working on this application, you can remove it from live execution by	262	working on this application, you can remove it from live execution by
280	running the <code>ant remove</code> command.</li>	263	running the <code>ant remove</code> command.
		264	</p></li>
281	</ul>	265	</ul>
282		266
283	<p>Do not forget to commit your changes to the source code repository when	267	<p>Do not forget to commit your changes to the source code repository when
Lines 293-312 Link Here
293	of your web application that can be deployed on the production server. The	277	of your web application that can be deployed on the production server. The
294	following general steps are required:</p>	278	following general steps are required:</p>
295	<ul>	279	<ul>
296	<li>Issue the command <code>ant all</code> from the project source	280	<li><p>Issue the command <code>ant all</code> from the project source
297	directory, to rebuild everything from scratch one last time.	281	directory, to rebuild everything from scratch one last time.
298	<br/><br/></li>	282	</p></li>
299	<li>Use the <code>cvs tag</code> command to create an identifier for	283	<li><p>Use the <code>cvs tag</code> command to create an identifier for
300	all of the source files utilized to create this release. This allows	284	all of the source files utilized to create this release. This allows
301	you to reliably reconstruct a release (from sources) at a later	285	you to reliably reconstruct a release (from sources) at a later
302	time.</li>	286	time.
303	<li>Issue the command <code>ant dist</code> to create a distributable	287	</p></li>
		288	<li><p>Issue the command <code>ant dist</code> to create a distributable
304	web application archive (WAR) file, as well as a JAR file containing	289	web application archive (WAR) file, as well as a JAR file containing
305	the corresponding source code.	290	the corresponding source code.
306	<br/><br/></li>	291	</p></li>
307	<li>Package the contents of the <code>dist</code> directory using the	292	<li><p>Package the contents of the <code>dist</code> directory using the
308	<strong>tar</strong> or <strong>zip</strong> utility, according to	293	<strong>tar</strong> or <strong>zip</strong> utility, according to
309	the standard release procedures used by your organization.</li>	294	the standard release procedures used by your organization.
		295	</p></li>
310	</ul>	296	</ul>
311		297
312	</subsection>	298	</subsection>

Lines 35-47 Link Here

(-)webapps/docs/appdev/source.xml (-17 / +11 lines)
35		35
36	<section name="Directory Structure">	36	<section name="Directory Structure">
37		37
38	<blockquote><em>	38	<p><em>The description below uses the variable name $CATALINA_BASE to refer the
39	<p>The description below uses the variable name $CATALINA_BASE to refer the
40	base directory against which most relative paths are resolved. If you have	39	base directory against which most relative paths are resolved. If you have
41	not configured Tomcat for multiple instances by setting a CATALINA_BASE	40	not configured Tomcat for multiple instances by setting a CATALINA_BASE
42	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,	41	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
43	the directory into which you have installed Tomcat.</p>	42	the directory into which you have installed Tomcat.</em></p>
44	</em></blockquote>
45		43
46	<p>A key recommendation of this manual is to separate the directory	44	<p>A key recommendation of this manual is to separate the directory
47	hierarchy containing your source code (described in this section) from	45	hierarchy containing your source code (described in this section) from
Lines 49-64 Link Here
49	(described in the preceding section). Maintaining this separation has	47	(described in the preceding section). Maintaining this separation has
50	the following advantages:</p>	48	the following advantages:</p>
51	<ul>	49	<ul>
52	<li>The contents of the source directories can be more easily administered,	50	<li><p>The contents of the source directories can be more easily administered,
53	moved, and backed up if the "executable" version of the application	51	moved, and backed up if the "executable" version of the application
54	is not intermixed.	52	is not intermixed.
55	<br/><br/></li>	53	</p></li>
56	<li>Source code control is easier to manage on directories that contain	54	<li><p>Source code control is easier to manage on directories that contain
57	only source files.	55	only source files.
58	<br/><br/></li>	56	</p></li>
59	<li>The files that make up an installable distribution of your	57	<li><p>The files that make up an installable distribution of your
60	application are much easier to select when the deployment	58	application are much easier to select when the deployment
61	hierarchy is separate.</li>	59	hierarchy is separate.</p></li>
62	</ul>	60	</ul>
63		61
64	<p>As we will see, the <code>ant</code> development tool makes the creation	62	<p>As we will see, the <code>ant</code> development tool makes the creation
Lines 181-191 Link Here
181	easy way to tell CVS to ignore these directories is to create a file named	179	easy way to tell CVS to ignore these directories is to create a file named
182	<code>.cvsignore</code> (note the leading period) in your top-level source	180	<code>.cvsignore</code> (note the leading period) in your top-level source
183	directory, with the following contents:</p>	181	directory, with the following contents:</p>
184	<source>	182	<source>build
185	build
186	dist	183	dist
187	build.properties	184	build.properties</source>
188	</source>
189		185
190	<p>The reason for mentioning <code>build.properties</code> here will be	186	<p>The reason for mentioning <code>build.properties</code> here will be
191	explained in the <a href="processes.html">Processes</a> section.</p>	187	explained in the <a href="processes.html">Processes</a> section.</p>
Lines 244-252 Link Here
244	the targets that are designed for use by the developer, versus those targets	240	the targets that are designed for use by the developer, versus those targets
245	used internally. To ask Ant to display the project documentation, change to	241	used internally. To ask Ant to display the project documentation, change to
246	the directory containing the <code>build.xml</code> file and type:</p>	242	the directory containing the <code>build.xml</code> file and type:</p>
247	<source>	243	<source>ant -projecthelp</source>
248	ant -projecthelp
249	</source>
250		244
251	<p>To give you a head start, a <a href="build.xml.txt">basic build.xml file</a>	245	<p>To give you a head start, a <a href="build.xml.txt">basic build.xml file</a>
252	is provided that you can customize and install in the project source directory	246	is provided that you can customize and install in the project source directory

Lines 35-46 Link Here

(-)webapps/docs/architecture/startup.xml (-1 / +1 lines)
35	<p>	35	<p>
36	This page describes how the Tomcat server starts up. There are several	36	This page describes how the Tomcat server starts up. There are several
37	different ways to start tomcat, including:	37	different ways to start tomcat, including:
		38	</p>
38	<ul>	39	<ul>
39	<li>From the command line.</li>	40	<li>From the command line.</li>
40	<li>From a Java program as an embedded server.</li>	41	<li>From a Java program as an embedded server.</li>
41	<li>Automatically as a Windows service.</li>	42	<li>Automatically as a Windows service.</li>
42	</ul>	43	</ul>
43	</p>
44		44
45	<subsection name="description">	45	<subsection name="description">
46	<p>	46	<p>

Lines 49-55 Link Here

(-)webapps/docs/config/ajp.xml (-18 / +66 lines)
49	the <code>jvmRoute</code> attribute of the	49	the <code>jvmRoute</code> attribute of the
50	<a href="engine.html">Engine</a>.</p>	50	<a href="engine.html">Engine</a>.</p>
51		51
52	<p>The native connectors supported with this Tomcat release are:	52	<p>The native connectors supported with this Tomcat release are:</p>
53	<ul>	53	<ul>
54	<li>JK 1.2.x with any of the supported servers. See	54	<li>JK 1.2.x with any of the supported servers. See
55	<a href="http://tomcat.apache.org/connectors-doc/">the JK docs</a>	55	<a href="http://tomcat.apache.org/connectors-doc/">the JK docs</a>
Lines 59-65 Link Here
59	<a href="http://httpd.apache.org/docs/2.2/mod/mod_proxy_ajp.html">the	59	<a href="http://httpd.apache.org/docs/2.2/mod/mod_proxy_ajp.html">the
60	httpd docs</a> for details.</li>	60	httpd docs</a> for details.</li>
61	</ul>	61	</ul>
62	</p>
63		62
64	<p><b>Other native connectors supporting AJP may work, but are no longer	63	<p><b>Other native connectors supporting AJP may work, but are no longer
65	supported.</b></p>	64	supported.</b></p>
Lines 178-184 Link Here
178	<code>org.apache.coyote.ajp.AjpAprProtocol</code>	177	<code>org.apache.coyote.ajp.AjpAprProtocol</code>
179	- the APR/native connector.<br/>	178	- the APR/native connector.<br/>
180	Custom implementations may also be used.<br/>	179	Custom implementations may also be used.<br/>
181	Take a look at our <a href="#Connector Comparison">Connector	180	Take a look at our <a href="#Connector_Comparison">Connector
182	Comparison</a> chart.	181	Comparison</a> chart.
183	</p>	182	</p>
184	</attribute>	183	</attribute>
Lines 187-193 Link Here
187	<p>If this <strong>Connector</strong> is being used in a proxy	186	<p>If this <strong>Connector</strong> is being used in a proxy
188	configuration, configure this attribute to specify the server name	187	configuration, configure this attribute to specify the server name
189	to be returned for calls to <code>request.getServerName()</code>.	188	to be returned for calls to <code>request.getServerName()</code>.
190	See <a href="#Proxy Support">Proxy Support</a> for more	189	See <a href="#Proxy_Support">Proxy Support</a> for more
191	information.</p>	190	information.</p>
192	</attribute>	191	</attribute>
193		192
Lines 195-201 Link Here
195	<p>If this <strong>Connector</strong> is being used in a proxy	194	<p>If this <strong>Connector</strong> is being used in a proxy
196	configuration, configure this attribute to specify the server port	195	configuration, configure this attribute to specify the server port
197	to be returned for calls to <code>request.getServerPort()</code>.	196	to be returned for calls to <code>request.getServerPort()</code>.
198	See <a href="#Proxy Support">Proxy Support</a> for more	197	See <a href="#Proxy_Support">Proxy Support</a> for more
199	information.</p>	198	information.</p>
200	</attribute>	199	</attribute>
201		200
Lines 667-686 Link Here
667	<subsection name="Connector Comparison">	666	<subsection name="Connector Comparison">
668		667
669	<p>Below is a small chart that shows how the connectors differentiate.</p>	668	<p>Below is a small chart that shows how the connectors differentiate.</p>
670	<source>
671	Java Blocking Connector Java Nio Blocking Connector APR/native Connector
672	BIO NIO APR
673	Classname AjpProtocol AjpNioProtocol AjpAprProtocol
674	Tomcat Version 3.x onwards 7.x onwards 5.5.x onwards
675	Support Polling NO YES YES
676	Polling Size N/A maxConnections maxConnections
677	Read Request Headers Blocking Sim Blocking Blocking
678	Read Request Body Blocking Sim Blocking Blocking
679	Write Response Blocking Sim Blocking Blocking
680	Wait for next Request Blocking Non Blocking Non Blocking
681	Max Connections maxConnections maxConnections maxConnections
682		669
683	</source>	670	<table class="defaultTable" style="text-align: center;">
		671	<tr>
		672	<th />
		673	<th>Java Blocking Connector<br />BIO</th>
		674	<th>Java Nio Blocking Connector<br />NIO</th>
		675	<th>APR/native Connector<br />APR</th>
		676	</tr>
		677	<tr>
		678	<th style="text-align: left;">Classname</th>
		679	<td><code class="noHighlight">AjpProtocol</code></td>
		680	<td><code class="noHighlight">AjpNioProtocol</code></td>
		681	<td><code class="noHighlight">AjpAprProtocol</code></td>
		682	</tr>
		683	<tr>
		684	<th style="text-align: left;">Tomcat Version</th>
		685	<td>3.x onwards</td>
		686	<td>7.x onwards</td>
		687	<td>5.5.x onwards</td>
		688	</tr>
		689	<tr>
		690	<th style="text-align: left;">Support Polling</th>
		691	<td>NO</td>
		692	<td>YES</td>
		693	<td>YES</td>
		694	</tr>
		695	<tr>
		696	<th style="text-align: left;">Polling Size</th>
		697	<td>N/A</td>
		698	<td><code class="noHighlight">maxConnections</code></td>
		699	<td><code class="noHighlight">maxConnections</code></td>
		700	</tr>
		701	<tr>
		702	<th style="text-align: left;">Read Request Headers</th>
		703	<td>Blocking</td>
		704	<td>Sim Blocking</td>
		705	<td>Blocking</td>
		706	</tr>
		707	<tr>
		708	<th style="text-align: left;">Read Request Body</th>
		709	<td>Blocking</td>
		710	<td>Sim Blocking</td>
		711	<td>Blocking</td>
		712	</tr>
		713	<tr>
		714	<th style="text-align: left;">Write Response</th>
		715	<td>Blocking</td>
		716	<td>Sim Blocking</td>
		717	<td>Blocking</td>
		718	</tr>
		719	<tr>
		720	<th style="text-align: left;">Wait for next Request</th>
		721	<td>Blocking</td>
		722	<td>Non Blocking</td>
		723	<td>Non Blocking</td>
		724	</tr>
		725	<tr>
		726	<th style="text-align: left;">Max Connections</th>
		727	<td><code class="noHighlight">maxConnections</code></td>
		728	<td><code class="noHighlight">maxConnections</code></td>
		729	<td><code class="noHighlight">maxConnections</code></td>
		730	</tr>
		731	</table>
684		732
685	</subsection>	733	</subsection>
686		734

Lines 41-47 Link Here

(-)webapps/docs/config/cluster-interceptor.xml (-15 / +9 lines)
41	</section>	41	</section>
42		42
43	<section name="Available Interceptors">	43	<section name="Available Interceptors">
44	<p>
45	<ul>	44	<ul>
46	<li><code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code></li>	45	<li><code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code></li>
47	<li><code>org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor</code></li>	46	<li><code>org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor</code></li>
Lines 57-63 Link Here
57	<li><code>org.apache.catalina.tribes.group.interceptors.GzipInterceptor</code></li>	56	<li><code>org.apache.catalina.tribes.group.interceptors.GzipInterceptor</code></li>
58	<li><code>org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor</code></li>	57	<li><code>org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor</code></li>
59	</ul>	58	</ul>
60	</p>
61	</section>	59	</section>
62		60
63	<section name="Static Membership">	61	<section name="Static Membership">
Lines 67-85 Link Here
67	underneath the <code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code> interceptor.	65	underneath the <code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code> interceptor.
68	Inside the <code>StaticMembershipInterceptor</code> you can add the static members you wish to have.	66	Inside the <code>StaticMembershipInterceptor</code> you can add the static members you wish to have.
69	The <code>TcpFailureDetector</code> will do a health check on the static members,and also monitor them for crashes	67	The <code>TcpFailureDetector</code> will do a health check on the static members,and also monitor them for crashes
70	so they will have the same level of notification mechanism as the members that are automatically discovered.	68	so they will have the same level of notification mechanism as the members that are automatically discovered.</p>
71	<source>	69	<source><![CDATA[ <Interceptor className="org.apache.catalina.tribes.group.interceptors.StaticMembershipInterceptor">
72	<Interceptor className="org.apache.catalina.tribes.group.interceptors.StaticMembershipInterceptor">	70	<Member className="org.apache.catalina.tribes.membership.StaticMember"
73	<Member className="org.apache.catalina.tribes.membership.StaticMember"	71	port="5678"
74	port="5678"	72	securePort="-1"
75	securePort="-1"	73	host="tomcat01.mydomain.com"
76	host="tomcat01.mydomain.com"	74	domain="staging-cluster"
77	domain="staging-cluster"	75	uniqueId="{0,1,2,3,4,5,6,7,8,9}"/>
78	uniqueId="{0,1,2,3,4,5,6,7,8,9}"/>	76	</Interceptor>]]></source>
79	</Interceptor>
80
81	</source>
82	</p>
83	</section>	77	</section>
84		78
85	<section name="Attributes">	79	<section name="Attributes">

Lines 55-62 Link Here

(-)webapps/docs/config/cluster.xml (-15 / +15 lines)
55	</section>	55	</section>
56	<section name="Context Attribute Replication">	56	<section name="Context Attribute Replication">
57	<p>To configure context attribute replication, simply do this by swapping out the context implementation	57	<p>To configure context attribute replication, simply do this by swapping out the context implementation
58	used for your application context.	58	used for your application context.</p>
59	<source><Context className="org.apache.catalina.ha.context.ReplicatedContext"/></source>	59	<source><Context className="org.apache.catalina.ha.context.ReplicatedContext"/></source>
		60	<p>
60	This context extends the Tomcat <code><a href="context.html">StandardContext</a></code>	61	This context extends the Tomcat <code><a href="context.html">StandardContext</a></code>
61	so all the options from the <a href="context.html">base implementation</a> are valid.	62	so all the options from the <a href="context.html">base implementation</a> are valid.
62	</p>	63	</p>
Lines 64-70 Link Here
64	<section name="Nested Components">	65	<section name="Nested Components">
65	<p><b><a href="cluster-manager.html">Manager</a>:</b> <br/>	66	<p><b><a href="cluster-manager.html">Manager</a>:</b> <br/>
66	The session manager element identifies what kind of session manager is used in this cluster implementation.	67	The session manager element identifies what kind of session manager is used in this cluster implementation.
67	This manager configuration is identical to the one you would use in a regular <code><a href="context.html#Nested%20xComponents"><Context></a></code> configuration.	68	This manager configuration is identical to the one you would use in a regular <code><a href="context.html#Nested_Components"><Context></a></code> configuration.
68	<br/>The default value is the <code>org.apache.catalina.ha.session.DeltaManager</code> that is closely coupled with	69	<br/>The default value is the <code>org.apache.catalina.ha.session.DeltaManager</code> that is closely coupled with
69	the <code>SimpleTcpCluster</code> implementation. Other managers like the <code>org.apache.catalina.ha.session.BackupManager</code>	70	the <code>SimpleTcpCluster</code> implementation. Other managers like the <code>org.apache.catalina.ha.session.BackupManager</code>
70	are/could be loosely coupled and don't rely on the <code>SimpleTcpCluster</code> for its data replication.	71	are/could be loosely coupled and don't rely on the <code>SimpleTcpCluster</code> for its data replication.
Lines 113-126 Link Here
113	<attribute name="channelSendOptions" required="true">	114	<attribute name="channelSendOptions" required="true">
114	<p>The Tribes channel send options, default is <code>8</code>.<br/>	115	<p>The Tribes channel send options, default is <code>8</code>.<br/>
115	This option is used to set the flag that all messages sent through the	116	This option is used to set the flag that all messages sent through the
116	SimpleTcpCluster uses. The flag decides how the messages are sent, and is a simple logical OR.<br/>	117	SimpleTcpCluster uses. The flag decides how the messages are sent, and is a simple logical OR.</p>
117		118
118	<source>	119	<source>int options = Channel.SEND_OPTIONS_ASYNCHRONOUS \|
119	int options= Channel.SEND_OPTIONS_ASYNCHRONOUS \|	120	Channel.SEND_OPTIONS_SYNCHRONIZED_ACK \|
120	Channel.SEND_OPTIONS_SYNCHRONIZED_ACK \|	121	Channel.SEND_OPTIONS_USE_ACK;</source>
121	Channel.SEND_OPTIONS_USE_ACK;	122	<p>Some of the values are:<br/>
122	</source>
123	Some of the values are:<br/>
124	<code>Channel.SEND_OPTIONS_SYNCHRONIZED_ACK = 0x0004</code><br/>	123	<code>Channel.SEND_OPTIONS_SYNCHRONIZED_ACK = 0x0004</code><br/>
125	<code>Channel.SEND_OPTIONS_ASYNCHRONOUS = 0x0008</code><br/>	124	<code>Channel.SEND_OPTIONS_ASYNCHRONOUS = 0x0008</code><br/>
126	<code>Channel.SEND_OPTIONS_USE_ACK = 0x0002</code><br/>	125	<code>Channel.SEND_OPTIONS_USE_ACK = 0x0002</code><br/>
Lines 134-144 Link Here
134	<p>Sets the start and stop flags for the <Channel> object used by the cluster.	133	<p>Sets the start and stop flags for the <Channel> object used by the cluster.
135	The default is <code>Channel.DEFAULT</code> which starts all the channel services, such as	134	The default is <code>Channel.DEFAULT</code> which starts all the channel services, such as
136	sender, receiver, multicast sender and multicast receiver.	135	sender, receiver, multicast sender and multicast receiver.
137	The following flags are available today:	136	The following flags are available today:</p>
138	<source>	137	<source>Channel.DEFAULT = Channel.SND_RX_SEQ (1) \|
139	Channel.DEFAULT = Channel.SND_RX_SEQ (1)\| Channel.SND_TX_SEQ (2)\| Channel.MBR_RX_SEQ (4)\| Channel.MBR_TX_SEQ (8);	138	Channel.SND_TX_SEQ (2) \|
140	</source>	139	Channel.MBR_RX_SEQ (4) \|
141	To start a channel without multicasting, you would want to use the value <code>Channel.SND_RX_SEQ \| Channel.SND_TX_SEQ</code>	140	Channel.MBR_TX_SEQ (8);</source>
		141	<p>To start a channel without multicasting, you would want to use the value <code>Channel.SND_RX_SEQ \| Channel.SND_TX_SEQ</code>
142	that equals to <code>3</code>.	142	that equals to <code>3</code>.
143	</p>	143	</p>
144	</attribute>	144	</attribute>

Lines 35-47 Link Here

(-)webapps/docs/config/context.xml (-96 / +74 lines)
35		35
36	<section name="Introduction">	36	<section name="Introduction">
37		37
38	<blockquote><p><em>	38	<p><em>
39	The description below uses the variable name $CATALINA_BASE to refer the	39	The description below uses the variable name $CATALINA_BASE to refer the
40	base directory against which most relative paths are resolved. If you have	40	base directory against which most relative paths are resolved. If you have
41	not configured Tomcat for multiple instances by setting a CATALINA_BASE	41	not configured Tomcat for multiple instances by setting a CATALINA_BASE
42	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,	42	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
43	the directory into which you have installed Tomcat.	43	the directory into which you have installed Tomcat.
44	</em></p></blockquote>	44	</em></p>
45		45
46	<p>The <strong>Context</strong> element represents a <em>web	46	<p>The <strong>Context</strong> element represents a <em>web
47	application</em>, which is run within a particular virtual host.	47	application</em>, which is run within a particular virtual host.
Lines 800-816 Link Here
800	<a href="host.html">Host</a>, or <a href="context.html">Context</a>	800	<a href="host.html">Host</a>, or <a href="context.html">Context</a>
801	by nesting a <a href="valve.html">Valve</a> element like this:</p>	801	by nesting a <a href="valve.html">Valve</a> element like this:</p>
802		802
803	<source>	803	<source><![CDATA[<Context>
804	<Context>
805	...	804	...
806	<Valve className="org.apache.catalina.valves.AccessLogValve"	805	<Valve className="org.apache.catalina.valves.AccessLogValve"
807	prefix="localhost_access_log." suffix=".txt"	806	prefix="localhost_access_log." suffix=".txt"
808	pattern="common"/>	807	pattern="common"/>
809	...	808	...
810	</Context>	809	</Context>]]></source>
811	</source>
812		810
813	<p>See <a href="valve.html#Access Log Valve">Access Log Valve</a>	811	<p>See <a href="valve.html#Access_Log_Valve">Access Log Valve</a>
814	for more information on the configuration attributes that are	812	for more information on the configuration attributes that are
815	supported.</p>	813	supported.</p>
816		814
Lines 854-877 Link Here
854	web application as servlet context initialization parameters by nesting	852	web application as servlet context initialization parameters by nesting
855	<code><Parameter></code> elements inside this element. For	853	<code><Parameter></code> elements inside this element. For
856	example, you can create an initialization parameter like this:</p>	854	example, you can create an initialization parameter like this:</p>
857	<source>	855	<source><![CDATA[<Context>
858	<Context>
859	...	856	...
860	<Parameter name="companyName" value="My Company, Incorporated"	857	<Parameter name="companyName" value="My Company, Incorporated"
861	override="false"/>	858	override="false"/>
862	...	859	...
863	</Context>	860	</Context>]]></source>
864	</source>
865		861
866	<p>This is equivalent to the inclusion of the following element in the	862	<p>This is equivalent to the inclusion of the following element in the
867	web application deployment descriptor (<code>/WEB-INF/web.xml</code>):	863	web application deployment descriptor (<code>/WEB-INF/web.xml</code>):
868	</p>	864	</p>
869	<source>	865	<source><![CDATA[<context-param>
870	<context-param>	866	<param-name>companyName</param-name>
871	<param-name>companyName</param-name>	867	<param-value>My Company, Incorporated</param-value>
872	<param-value>My Company, Incorporated</param-value>	868	</context-param>]]></source>
873	</context-param>
874	</source>
875	<p>but does <em>not</em> require modification of the deployment descriptor	869	<p>but does <em>not</em> require modification of the deployment descriptor
876	to customize this value.</p>	870	to customize this value.</p>
877		871
Lines 913-937 Link Here
913	web application as environment entry resources, by nesting	907	web application as environment entry resources, by nesting
914	<code><Environment></code> entries inside this element. For	908	<code><Environment></code> entries inside this element. For
915	example, you can create an environment entry like this:</p>	909	example, you can create an environment entry like this:</p>
916	<source>	910	<source><![CDATA[<Context>
917	<Context>
918	...	911	...
919	<Environment name="maxExemptions" value="10"	912	<Environment name="maxExemptions" value="10"
920	type="java.lang.Integer" override="false"/>	913	type="java.lang.Integer" override="false"/>
921	...	914	...
922	</Context>	915	</Context>]]></source>
923	</source>
924		916
925	<p>This is equivalent to the inclusion of the following element in the	917	<p>This is equivalent to the inclusion of the following element in the
926	web application deployment descriptor (<code>/WEB-INF/web.xml</code>):	918	web application deployment descriptor (<code>/WEB-INF/web.xml</code>):
927	</p>	919	</p>
928	<source>	920	<source><![CDATA[<env-entry>
929	<env-entry>	921	<env-entry-name>maxExemptions</env-entry-name>
930	<env-entry-name>maxExemptions</env-entry-name>	922	<env-entry-value>10</env-entry-value>
931	<env-entry-value>10</env-entry-value>	923	<env-entry-type>java.lang.Integer</env-entry-type>
932	<env-entry-type>java.lang.Integer</env-entry-type>	924	</env-entry>]]></source>
933	</env-entry>
934	</source>
935	<p>but does <em>not</em> require modification of the deployment descriptor	925	<p>but does <em>not</em> require modification of the deployment descriptor
936	to customize this value.</p>	926	to customize this value.</p>
937		927
Lines 986-998 Link Here
986	It will be notified about the occurrence of the corresponding	976	It will be notified about the occurrence of the corresponding
987	lifecycle events. Configuration of such a listener looks like this:</p>	977	lifecycle events. Configuration of such a listener looks like this:</p>
988		978
989	<source>	979	<source><![CDATA[<Context>
990	<Context>
991	...	980	...
992	<Listener className="com.mycompany.mypackage.MyListener" ... >	981	<Listener className="com.mycompany.mypackage.MyListener" ... >
993	...	982	...
994	</Context>	983	</Context>]]></source>
995	</source>
996		984
997	<p>Note that a Listener can have any number of additional properties	985	<p>Note that a Listener can have any number of additional properties
998	that may be configured from this element. Attribute names are matched	986	that may be configured from this element. Attribute names are matched
Lines 1014-1032 Link Here
1014	not accepted will be rejected with an HTTP "Forbidden" error.	1002	not accepted will be rejected with an HTTP "Forbidden" error.
1015	Example filter declarations:</p>	1003	Example filter declarations:</p>
1016		1004
1017	<source>	1005	<source><![CDATA[<Context>
1018	<Context>
1019	...	1006	...
1020	<Valve className="org.apache.catalina.valves.RemoteHostValve"	1007	<Valve className="org.apache.catalina.valves.RemoteHostValve"
1021	allow=".*\.mycompany\.com\|www\.yourcompany\.com"/>	1008	allow=".*\.mycompany\.com\|www\.yourcompany\.com"/>
1022	<Valve className="org.apache.catalina.valves.RemoteAddrValve"	1009	<Valve className="org.apache.catalina.valves.RemoteAddrValve"
1023	deny="192\.168\.1\.\d+"/>	1010	deny="192\.168\.1\.\d+"/>
1024	...	1011	...
1025	</Context>	1012	</Context>]]></source>
1026	</source>
1027		1013
1028	<p>See <a href="valve.html#Remote Address Filter">Remote Address Filter</a>	1014	<p>See <a href="valve.html#Remote_Address_Filter">Remote Address Filter</a>
1029	and <a href="valve.html#Remote Host Filter">Remote Host Filter</a> for	1015	and <a href="valve.html#Remote_Host_Filter">Remote Host Filter</a> for
1030	more information about the configuration options that are supported.</p>	1016	more information about the configuration options that are supported.</p>
1031		1017
1032	</subsection>	1018	</subsection>
Lines 1043-1068 Link Here
1043	already), and the properties used to configure that object factory.</p>	1029	already), and the properties used to configure that object factory.</p>
1044		1030
1045	<p>For example, you can create a resource definition like this:</p>	1031	<p>For example, you can create a resource definition like this:</p>
1046	<source>	1032	<source><![CDATA[<Context>
1047	<Context>
1048	...	1033	...
1049	<Resource name="jdbc/EmployeeDB" auth="Container"	1034	<Resource name="jdbc/EmployeeDB" auth="Container"
1050	type="javax.sql.DataSource"	1035	type="javax.sql.DataSource"
1051	description="Employees Database for HR Applications"/>	1036	description="Employees Database for HR Applications"/>
1052	...	1037	...
1053	</Context>	1038	</Context>]]></source>
1054	</source>
1055		1039
1056	<p>This is equivalent to the inclusion of the following element in the	1040	<p>This is equivalent to the inclusion of the following element in the
1057	web application deployment descriptor (<code>/WEB-INF/web.xml</code>):</p>	1041	web application deployment descriptor (<code>/WEB-INF/web.xml</code>):</p>
1058	<source>	1042	<source><![CDATA[<resource-ref>
1059	<resource-ref>	1043	<description>Employees Database for HR Applications</description>
1060	<description>Employees Database for HR Applications</description>	1044	<res-ref-name>jdbc/EmployeeDB</res-ref-name>
1061	<res-ref-name>jdbc/EmployeeDB</res-ref-name>	1045	<res-ref-type>javax.sql.DataSource</res-ref-type>
1062	<res-ref-type>javax.sql.DataSource</res-ref-type>	1046	<res-auth>Container</res-auth>
1063	<res-auth>Container</res-auth>	1047	</resource-ref>]]></source>
1064	</resource-ref>
1065	</source>
1066		1048
1067	<p>but does <em>not</em> require modification of the deployment	1049	<p>but does <em>not</em> require modification of the deployment
1068	descriptor to customize this value.</p>	1050	descriptor to customize this value.</p>
Lines 1142-1156 Link Here
1142	resource.</p>	1124	resource.</p>
1143		1125
1144	<p>For example, you can create a resource link like this:</p>	1126	<p>For example, you can create a resource link like this:</p>
1145	<source>	1127	<source><![CDATA[<Context>
1146	<Context>
1147	...	1128	...
1148	<ResourceLink name="linkToGlobalResource"	1129	<ResourceLink name="linkToGlobalResource"
1149	global="simpleValue"	1130	global="simpleValue"
1150	type="java.lang.Integer"	1131	type="java.lang.Integer"
1151	...	1132	...
1152	</Context>	1133	</Context>]]></source>
1153	</source>
1154		1134
1155	<p>The valid attributes for a <code><ResourceLink></code> element	1135	<p>The valid attributes for a <code><ResourceLink></code> element
1156	are as follows:</p>	1136	are as follows:</p>
Lines 1182-1189 Link Here
1182	two additional attributes to allow a shared data source to be used with different credentials.	1162	two additional attributes to allow a shared data source to be used with different credentials.
1183	When these two additional attributes are used in combination with the <code>javax.sql.DataSource</code>	1163	When these two additional attributes are used in combination with the <code>javax.sql.DataSource</code>
1184	type, different contexts can share a global data source with different credentials.	1164	type, different contexts can share a global data source with different credentials.
1185	Under the hood, what happens is that a call to <a href="http://docs.oracle.com/javase/6/docs/api/javax/sql/DataSource.html#getConnection()"><code>getConnection()</code></a>	1165	Under the hood, what happens is that a call to <a href="http://docs.oracle.com/javase/7/docs/api/javax/sql/DataSource.html#getConnection()"><code>getConnection()</code></a>
1186	is simply translated to a call <a href="http://docs.oracle.com/javase/6/docs/api/javax/sql/DataSource.html#getConnection(java.lang.String,%20java.lang.String)">	1166	is simply translated to a call <a href="http://docs.oracle.com/javase/7/docs/api/javax/sql/DataSource.html#getConnection(java.lang.String,%20java.lang.String)">
1187	<code>getConnection(username, password)</code></a> on the global data source. This is an easy way to get code to be transparent to what schemas are being used,	1167	<code>getConnection(username, password)</code></a> on the global data source. This is an easy way to get code to be transparent to what schemas are being used,
1188	yet be able to control connections (or pools) in the global configuration.	1168	yet be able to control connections (or pools) in the global configuration.
1189	</p>	1169	</p>
Lines 1212-1251 Link Here
1212	but by default this support is disabled and can be enabled by	1192	but by default this support is disabled and can be enabled by
1213	<code>alternateUsernameAllowed</code> attribute. See its documentation	1193	<code>alternateUsernameAllowed</code> attribute. See its documentation
1214	for details.</p>	1194	for details.</p>
1215	<source>	1195	<source><![CDATA[<GlobalNamingResources>
1216	<GlobalNamingResources>
1217	...	1196	...
1218	<Resource name="sharedDataSource"	1197	<Resource name="sharedDataSource"
1219	global="sharedDataSource"	1198	global="sharedDataSource"
1220	type="javax.sql.DataSource"	1199	type="javax.sql.DataSource"
1221	factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"	1200	factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
1222	alternateUsernameAllowed="true"	1201	alternateUsernameAllowed="true"
1223	username="bar"	1202	username="bar"
1224	password="barpass"	1203	password="barpass"
1225	...	1204	...
1226	...	1205	...
1227	</GlobalNamingResources>	1206	</GlobalNamingResources>
1228		1207
1229	<Context path="/foo"...>	1208	<Context path="/foo"...>
1230	...	1209	...
1231	<ResourceLink	1210	<ResourceLink
1232	name="appDataSource"	1211	name="appDataSource"
1233	global="sharedDataSource"	1212	global="sharedDataSource"
1234	type="javax.sql.DataSource"	1213	type="javax.sql.DataSource"
1235	factory="org.apache.naming.factory.DataSourceLinkFactory"	1214	factory="org.apache.naming.factory.DataSourceLinkFactory"
1236	username="foo"	1215	username="foo"
1237	password="foopass"	1216	password="foopass"
1238	...	1217	...
1239	</Context>	1218	</Context>
1240	<Context path="/bar"...>	1219	<Context path="/bar"...>
1241	...	1220	...
1242	<ResourceLink	1221	<ResourceLink
1243	name="appDataSource"	1222	name="appDataSource"
1244	global="sharedDataSource"	1223	global="sharedDataSource"
1245	type="javax.sql.DataSource"	1224	type="javax.sql.DataSource"
1246	...	1225	...
1247	</Context>	1226	</Context>]]></source>
1248	</source>
1249	<p>When a request for <code>getConnection()</code> is made in the	1227	<p>When a request for <code>getConnection()</code> is made in the
1250	<code>/foo</code> context, the request is translated into	1228	<code>/foo</code> context, the request is translated into
1251	<code>getConnection("foo","foopass")</code>,	1229	<code>getConnection("foo","foopass")</code>,

Lines 45-51 Link Here

(-)webapps/docs/config/globalresources.xml (-42 / +30 lines)
45	the <a href="../jndi-resources-howto.html">JNDI Resources HOW-TO</a>.	45	the <a href="../jndi-resources-howto.html">JNDI Resources HOW-TO</a>.
46	The resources defined in this element are <strong>not</strong> visible in	46	The resources defined in this element are <strong>not</strong> visible in
47	the per-web-application contexts unless you explicitly link them with	47	the per-web-application contexts unless you explicitly link them with
48	<a href="context.html#Resource Links"><ResourceLink></a> elements.	48	<a href="context.html#Resource_Links"><ResourceLink></a> elements.
49	</p>	49	</p>
50		50
51	</section>	51	</section>
Lines 70-94 Link Here
70	web applications as environment entry resources by nesting	70	web applications as environment entry resources by nesting
71	<code><Environment></code> entries inside this element. For	71	<code><Environment></code> entries inside this element. For
72	example, you can create an environment entry like this:</p>	72	example, you can create an environment entry like this:</p>
73	<source>	73	<source><![CDATA[<GlobalNamingResources ...>
74	<GlobalNamingResources ...>
75	...	74	...
76	<Environment name="maxExemptions" value="10"	75	<Environment name="maxExemptions" value="10"
77	type="java.lang.Integer" override="false"/>	76	type="java.lang.Integer" override="false"/>
78	...	77	...
79	</GlobalNamingResources>	78	</GlobalNamingResources>]]></source>
80	</source>
81		79
82	<p>This is equivalent to the inclusion of the following element in the	80	<p>This is equivalent to the inclusion of the following element in the
83	web application deployment descriptor (<code>/WEB-INF/web.xml</code>):	81	web application deployment descriptor (<code>/WEB-INF/web.xml</code>):
84	</p>	82	</p>
85	<source>	83	<source><![CDATA[<env-entry>
86	<env-entry>	84	<env-entry-name>maxExemptions</env-entry-name>
87	<env-entry-name>maxExemptions</env-entry-name>	85	<env-entry-value>10</env-entry-value>
88	<env-entry-value>10</env-entry-value>	86	<env-entry-type>java.lang.Integer</env-entry-type>
89	<env-entry-type>java.lang.Integer</env-entry-type>	87	</env-entry>]]></source>
90	</env-entry>
91	</source>
92	<p>but does <em>not</em> require modification of the deployment descriptor	88	<p>but does <em>not</em> require modification of the deployment descriptor
93	to customize this value.</p>	89	to customize this value.</p>
94		90
Lines 137-143 Link Here
137	to be returned for JNDI lookups of <code><resource-ref></code> and	133	to be returned for JNDI lookups of <code><resource-ref></code> and
138	<code><resource-env-ref></code> elements in the web application	134	<code><resource-env-ref></code> elements in the web application
139	deployment descriptor by defining them in this element and then linking	135	deployment descriptor by defining them in this element and then linking
140	them with <a href="context.html#Resource Links"><ResourceLink></a>	136	them with <a href="context.html#_Links"><ResourceLink></a>
141	elements	137	elements
142	in the <code><strong><Context></strong></code> element.	138	in the <code><strong><Context></strong></code> element.
143		139
Lines 147-172 Link Here
147	the properties used to configure that object factory.</p>	143	the properties used to configure that object factory.</p>
148		144
149	<p>For example, you can create a resource definition like this:</p>	145	<p>For example, you can create a resource definition like this:</p>
150	<source>	146	<source><![CDATA[<GlobalNamingResources ...>
151	<GlobalNamingResources ...>
152	...	147	...
153	<Resource name="jdbc/EmployeeDB" auth="Container"	148	<Resource name="jdbc/EmployeeDB" auth="Container"
154	type="javax.sql.DataSource"	149	type="javax.sql.DataSource"
155	description="Employees Database for HR Applications"/>	150	description="Employees Database for HR Applications"/>
156	...	151	...
157	</GlobalNamingResources>	152	</GlobalNamingResources>]]></source>
158	</source>
159		153
160	<p>This is equivalent to the inclusion of the following element in the	154	<p>This is equivalent to the inclusion of the following element in the
161	web application deployment descriptor (<code>/WEB-INF/web.xml</code>):</p>	155	web application deployment descriptor (<code>/WEB-INF/web.xml</code>):</p>
162	<source>	156	<source><![CDATA[<resource-ref>
163	<resource-ref>	157	<description>Employees Database for HR Applications</description>
164	<description>Employees Database for HR Applications</description>	158	<res-ref-name>jdbc/EmployeeDB</res-ref-name>
165	<res-ref-name>jdbc/EmployeeDB</res-ref-name>	159	<res-ref-type>javax.sql.DataSource</res-ref-type>
166	<res-ref-type>javax.sql.DataSource</res-ref-type>	160	<res-auth>Container</res-auth>
167	<res-auth>Container</res-auth>	161	</resource-ref>]]></source>
168	</resource-ref>
169	</source>
170		162
171	<p>but does <em>not</em> require modification of the deployment	163	<p>but does <em>not</em> require modification of the deployment
172	descriptor to customize this value.</p>	164	descriptor to customize this value.</p>
Lines 239-263 Link Here
239	</subsection>	231	</subsection>
240		232
241	<subsection name="Resource Links">	233	<subsection name="Resource Links">
242	<p>Use <a href="context.html#Resource Links"><ResourceLink></a>	234	<p>Use <a href="context.html#Resource_Links"><code><ResourceLink></code></a>
243	elements to link resources from the global context into	235	elements to link resources from the global context into
244	per-web-application contexts. Here is an example of making a custom	236	per-web-application contexts. Here is an example of making a custom
245	factory available to an application, based on the example definition in the	237	factory available to an application, based on the example definition in the
246	<a href="../jndi-resources-howto.html#Generic JavaBean Resources">	238	<a href="../jndi-resources-howto.html#Generic_JavaBean_Resources">
247	JNDI Resource HOW-TO</a>:	239	JNDI Resource HOW-TO</a>:
248	</p>	240	</p>
249		241
250	<source>	242	<source><![CDATA[<Context>
251	<![CDATA[	243	<ResourceLink
252	<Context>	244	name="bean/MyBeanFactory"
253	<ResourceLink	245	global="bean/MyBeanFactory"
254	name="bean/MyBeanFactory"	246	type="com.mycompany.MyBean"
255	global="bean/MyBeanFactory"	247	/>
256	type="com.mycompany.MyBean"	248	</Context>]]></source>
257	/>
258	</Context>
259	]]>
260	</source>
261		249
262	</subsection>	250	</subsection>
263		251

Lines 56-68 Link Here

(-)webapps/docs/config/loader.xml (-4 / +2 lines)
56	<p>For a more in-depth description of the class loader hierarchy	56	<p>For a more in-depth description of the class loader hierarchy
57	that is implemented by Catalina, see <a href="../class-loader-howto.html">the ClassLoader HowTo</a>.</p>	57	that is implemented by Catalina, see <a href="../class-loader-howto.html">the ClassLoader HowTo</a>.</p>
58		58
59	<blockquote><em>	59	<p><em>The description below uses the variable name $CATALINA_BASE to refer the
60	<p>The description below uses the variable name $CATALINA_BASE to refer the
61	base directory against which most relative paths are resolved. If you have	60	base directory against which most relative paths are resolved. If you have
62	not configured Tomcat for multiple instances by setting a CATALINA_BASE	61	not configured Tomcat for multiple instances by setting a CATALINA_BASE
63	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,	62	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
64	the directory into which you have installed Tomcat.</p>	63	the directory into which you have installed Tomcat.</em></p>
65	</em></blockquote>
66		64
67	</section>	65	</section>
68		66

Lines 195-201 Link Here

(-)webapps/docs/config/manager.xml (-7 / +5 lines)
195	element - this is required for use of <code>PersistentManager</code>.</p>	195	element - this is required for use of <code>PersistentManager</code>.</p>
196		196
197	<p>This implementation of Manager supports the following attributes in	197	<p>This implementation of Manager supports the following attributes in
198	addition to the <a href="#Common Attributes">Common Attributes</a>	198	addition to the <a href="#Common_Attributes">Common Attributes</a>
199	described earlier.</p>	199	described earlier.</p>
200		200
201	<attributes>	201	<attributes>
Lines 202-208 Link Here
202		202
203	<attribute name="className" required="true">	203	<attribute name="className" required="true">
204	<p>It has the same meaning as described in the	204	<p>It has the same meaning as described in the
205	<a href="#Common Attributes">Common Attributes</a> above.	205	<a href="#Common_Attributes">Common Attributes</a> above.
206	You <strong>must</strong> specify	206	You <strong>must</strong> specify
207	<code>org.apache.catalina.session.PersistentManager</code> to use	207	<code>org.apache.catalina.session.PersistentManager</code> to use
208	this manager implementation.</p>	208	this manager implementation.</p>
Lines 432-439 Link Here
432	Detailed SQL commands vary depending on the database you are using, but	432	Detailed SQL commands vary depending on the database you are using, but
433	a script like this will generally be required:</p>	433	a script like this will generally be required:</p>
434		434
435	<source>	435	<source>create table tomcat_sessions (
436	create table tomcat_sessions (
437	session_id varchar(100) not null primary key,	436	session_id varchar(100) not null primary key,
438	valid_session char(1) not null,	437	valid_session char(1) not null,
439	max_inactive int not null,	438	max_inactive int not null,
Lines 441-448 Link Here
441	app_name varchar(255),	440	app_name varchar(255),
442	session_data mediumblob,	441	session_data mediumblob,
443	KEY kapp_name(app_name)	442	KEY kapp_name(app_name)
444	);	443	);</source>
445	</source>
446		444
447	<p>In order for the JDBC Based Store to successfully connect to your	445	<p>In order for the JDBC Based Store to successfully connect to your
448	database, the JDBC driver you configure must be visible to Tomcat's	446	database, the JDBC driver you configure must be visible to Tomcat's
Lines 481-487 Link Here
481	a <a href="context.html">Context</a> configuration file for your web	479	a <a href="context.html">Context</a> configuration file for your web
482	application and add the following element there:</p>	480	application and add the following element there:</p>
483		481
484	<source><Manager pathname="" /></source>	482	<source><![CDATA[<Manager pathname="" />]]></source>
485	</subsection>	483	</subsection>
486		484
487	</section>	485	</section>

Lines 55-67 Link Here

(-)webapps/docs/config/realm.xml (-4 / +2 lines)
55	<a href="../realm-howto.html">Container-Managed Security Guide</a>.	55	<a href="../realm-howto.html">Container-Managed Security Guide</a>.
56	</p>	56	</p>
57		57
58	<blockquote><em>	58	<p><em>The description below uses the variable name $CATALINA_BASE to refer the
59	<p>The description below uses the variable name $CATALINA_BASE to refer the
60	base directory against which most relative paths are resolved. If you have	59	base directory against which most relative paths are resolved. If you have
61	not configured Tomcat for multiple instances by setting a CATALINA_BASE	60	not configured Tomcat for multiple instances by setting a CATALINA_BASE
62	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,	61	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
63	the directory into which you have installed Tomcat.</p>	62	the directory into which you have installed Tomcat.</em></p>
64	</em></blockquote>
65		63
66	</section>	64	</section>
67		65

Lines 278-284 Link Here

(-)webapps/docs/config/systemprops.xml (-6 / +6 lines)
278		278
279	<property name="org.apache.catalina. STRICT_SERVLET_COMPLIANCE">	279	<property name="org.apache.catalina. STRICT_SERVLET_COMPLIANCE">
280	<p>The default value of this system property is <code>false</code>.</p>	280	<p>The default value of this system property is <code>false</code>.</p>
281	<p>If this is <code>true</code> the default values will be changed for:	281	<p>If this is <code>true</code> the default values will be changed for:</p>
282	<ul>	282	<ul>
283	<li><code>org.apache.catalina.core.<br/>ApplicationContext.GET_RESOURCE_REQUIRE_SLASH</code></li>	283	<li><code>org.apache.catalina.core.<br/>ApplicationContext.GET_RESOURCE_REQUIRE_SLASH</code></li>
284	<li><code>org.apache.catalina.core.<br/>ApplicationDispatcher.WRAP_SAME_OBJECT</code></li>	284	<li><code>org.apache.catalina.core.<br/>ApplicationDispatcher.WRAP_SAME_OBJECT</code></li>
Lines 298-304 Link Here
298	<li>The <code>xmlValidation</code> attribute of any	298	<li>The <code>xmlValidation</code> attribute of any
299	<a href="context.html">Context</a> element.</li>	299	<a href="context.html">Context</a> element.</li>
300	</ul>	300	</ul>
301	</p>	301
302	<p>Note that changing a number of the above defaults is likely to break	302	<p>Note that changing a number of the above defaults is likely to break
303	the majority of systems as some browsers are unable to correctly handle	303	the majority of systems as some browsers are unable to correctly handle
304	the cookie headers that result from a strict adherence to the	304	the cookie headers that result from a strict adherence to the
Lines 342-353 Link Here
342		342
343	<property name="org.apache.tomcat.websocket. STRICT_SPEC_COMPLIANCE">	343	<property name="org.apache.tomcat.websocket. STRICT_SPEC_COMPLIANCE">
344	<p>The default value of this system property is <code>false</code>.</p>	344	<p>The default value of this system property is <code>false</code>.</p>
345	<p>If this is <code>true</code> the default values will be changed for:	345	<p>If this is <code>true</code> the default values will be changed for:</p>
346	<ul>	346	<ul>
347	<li><code>org.apache.tomcat.websocket.server#isEnforceNoAddAfterHandshake</code>	347	<li><code>org.apache.tomcat.websocket.server#isEnforceNoAddAfterHandshake</code>
348	(default changes from <code>false</code> to <code>true</code>)</li>	348	(default changes from <code>false</code> to <code>true</code>)</li>
349	</ul>	349	</ul>
350	</p>	350
351	</property>	351	</property>
352		352
353	<property	353	<property
Lines 510-516 Link Here
510	<code>org.apache.juli.logging.UserDataHelper.SUPPRESSION_TIME</code>.	510	<code>org.apache.juli.logging.UserDataHelper.SUPPRESSION_TIME</code>.
511	</p>	511	</p>
512	<p>The default value is <code>INFO_THEN_DEBUG</code>.</p>	512	<p>The default value is <code>INFO_THEN_DEBUG</code>.</p>
513	<p>The errors currently logged using this system are:	513	<p>The errors currently logged using this system are:</p>
514	<ul>	514	<ul>
515	<li>invalid cookies;</li>	515	<li>invalid cookies;</li>
516	<li>invalid parameters;</li>	516	<li>invalid parameters;</li>
Lines 518-524 Link Here
518	<code>maxHeaderCount</code> or <code>maxParameterCount</code> limits	518	<code>maxHeaderCount</code> or <code>maxParameterCount</code> limits
519	of a <a href="http.html">connector</a>).</li>	519	of a <a href="http.html">connector</a>).</li>
520	</ul>	520	</ul>
521	Other errors triggered by invalid input data may be added to this	521	<p>Other errors triggered by invalid input data may be added to this
522	system in later versions.</p>	522	system in later versions.</p>
523	</property>	523	</property>
524		524

Lines 42-54 Link Here

(-)webapps/docs/config/valve.xml (-10 / +6 lines)
42	Individual Valves have distinct processing capabilities, and are	42	Individual Valves have distinct processing capabilities, and are
43	described individually below.</p>	43	described individually below.</p>
44		44
45	<blockquote><em>	45	<p><em>The description below uses the variable name $CATALINA_BASE to refer the
46	<p>The description below uses the variable name $CATALINA_BASE to refer the
47	base directory against which most relative paths are resolved. If you have	46	base directory against which most relative paths are resolved. If you have
48	not configured Tomcat for multiple instances by setting a CATALINA_BASE	47	not configured Tomcat for multiple instances by setting a CATALINA_BASE
49	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,	48	directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME,
50	the directory into which you have installed Tomcat.</p>	49	the directory into which you have installed Tomcat.</em></p>
51	</em></blockquote>
52		50
53	</section>	51	</section>
54		52
Lines 297-302 Link Here
297	It is modeled after the	295	It is modeled after the
298	<a href="http://httpd.apache.org/">Apache HTTP Server</a> log configuration	296	<a href="http://httpd.apache.org/">Apache HTTP Server</a> log configuration
299	syntax:	297	syntax:
		298	</p>
300	<ul>	299	<ul>
301	<li><b><code>%{xxx}i</code></b> for incoming headers</li>	300	<li><b><code>%{xxx}i</code></b> for incoming headers</li>
302	<li><b><code>%{xxx}o</code></b> for outgoing response headers</li>	301	<li><b><code>%{xxx}o</code></b> for outgoing response headers</li>
Lines 305-311 Link Here
305	<li><b><code>%{xxx}s</code></b> xxx is an attribute in the HttpSession</li>	304	<li><b><code>%{xxx}s</code></b> xxx is an attribute in the HttpSession</li>
306	<li><b><code>%{xxx}t</code></b> xxx is an enhanced SimpleDateFormat pattern</li>	305	<li><b><code>%{xxx}t</code></b> xxx is an enhanced SimpleDateFormat pattern</li>
307	</ul>	306	</ul>
308	</p>
309		307
310	<p>All formats supported by SimpleDateFormat are allowed in <code>%{xxx}t</code>.	308	<p>All formats supported by SimpleDateFormat are allowed in <code>%{xxx}t</code>.
311	In addition the following extensions have been added:</p>	309	In addition the following extensions have been added:</p>
Lines 518-527 Link Here
518		516
519	<subsection name="Example">	517	<subsection name="Example">
520	<p>To allow access only for the clients connecting from localhost:</p>	518	<p>To allow access only for the clients connecting from localhost:</p>
521	<pre>	519	<source><![CDATA[<Valve className="org.apache.catalina.valves.RemoteAddrValve"
522	<Valve className="org.apache.catalina.valves.RemoteAddrValve"	520	allow="127\.\d+\.\d+\.\d+\|::1\|0:0:0:0:0:0:0:1"/>]]></source>
523	allow="127\.\d+\.\d+\.\d+\|::1\|0:0:0:0:0:0:0:1"/>
524	</pre>
525	</subsection>	521	</subsection>
526		522
527	</section>	523	</section>
Lines 605-611 Link Here
605	your virtual host, and then have their identity recognized by all other	601	your virtual host, and then have their identity recognized by all other
606	web applications on the same virtual host.</p>	602	web applications on the same virtual host.</p>
607		603
608	<p>See the <a href="host.html#Single Sign On">Single Sign On</a> special	604	<p>See the <a href="host.html#Single_Sign_On">Single Sign On</a> special
609	feature on the <strong>Host</strong> element for more information.</p>	605	feature on the <strong>Host</strong> element for more information.</p>
610		606
611	</subsection>	607	</subsection>

Lines 38-44 Link Here

(-)webapps/docs/images/docs-stylesheet.css (-13 / +9 lines)
38		38
39	table {	39	table {
40	border-collapse: collapse;	40	border-collapse: collapse;
		41	text-align: left;
41	}	42	}
		43	table *:not(table) {
		44	/* Prevent border-collapsing for table child elements like <div> */
		45	border-collapse: separate;
		46	}
42		47
43	main {	48	main {
44	/* Remove this once all IEs support <main> element */	49	/* Remove this once all IEs support <main> element */
Lines 213-246 Link Here
213	}	218	}
214		219
215		220
216	table.defaultTable tr {	221	table.defaultTable tr, table.detail-table tr {
217	border: 1px solid #CCC;	222	border: 1px solid #CCC;
218	}	223	}
219		224
220	table.defaultTable tr:nth-child(even) {	225	table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) {
221	background-color: #FAFBFF;	226	background-color: #FAFBFF;
222	}	227	}
223		228
224	table.defaultTable tr:nth-child(odd) {	229	table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) {
225	background-color: #EEEFFF;	230	background-color: #EEEFFF;
226	}	231	}
227		232
228	table.defaultTable th {	233	table.defaultTable th, table.detail-table th {
229	background-color: #88b;	234	background-color: #88b;
230	color: #fff;	235	color: #fff;
231	}	236	}
232		237
233	table.detail-table th {
234	background-color: #039acc;
235	color: #fff;
236	}
237	table.detail-table td {
238	background-color: #DAF2FA;
239	}
240
241	table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td {	238	table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td {
242	padding: 5px 8px;	239	padding: 5px 8px;
243	text-align: left;
244	}	240	}
245		241
246		242