|
|
Tomcat example source code file (ajp.xml)
This example Tomcat source code file (ajp.xml) is included in the DevDaily.com
"Java Source Code
Warehouse" project. The intent of this project is to help you "Learn Java by Example" TM.
The Tomcat ajp.xml source code
<?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
]>
<document url="ajp.html">
&project;
<properties>
<author email="remm@apache.org">Remy Maucherat
<author email="yoavs@apache.org">Yoav Shapira
<author email="arjaquith@mindspring.com">Andrew R. Jaquith
<title>The AJP Connector
</properties>
<body>
<section name="Introduction">
<p>The AJP Connector element represents a
<strong>Connector component that communicates with a web
connector via the <code>AJP protocol. This is used for cases
where you wish to invisibly integrate Tomcat 6 into an existing (or new)
Apache installation, and you want Apache to handle the static content
contained in the web application, and/or utilize Apache's SSL
processing.</p>
<p>This connector supports load balancing when used in conjunction with
the <code>jvmRoute attribute of the
<a href="engine.html">Engine.
<p>The native connectors supported with this Tomcat release are:
<ul>
<li>JK 1.2.x with any of the supported servers
<li>mod_proxy on Apache httpd 2.x (included by default in Apache HTTP Server 2.2),
with AJP enabled: see
<a href="http://httpd.apache.org/docs/2.2/mod/mod_proxy_ajp.html">the httpd docs
for details.</li>
</ul>
</p>
<p>Other native connectors supporting AJP may work, but are no longer supported.
</section>
<section name="Attributes">
<subsection name="Common Attributes">
<p>All implementations of Connector
support the following attributes:</p>
<attributes>
<attribute name="allowTrace" required="false">
<p>A boolean value which can be used to enable or disable the TRACE
HTTP method. If not specified, this attribute is set to false.</p>
</attribute>
<attribute name="emptySessionPath" required="false">
<p>If set to true, all paths for session cookies will be set
to <code>/. This can be useful for portlet specification implementations.
If not specified, this attribute is set to <code>false.
</attribute>
<attribute name="enableLookups" required="false">
<p>Set to true if you want calls to
<code>request.getRemoteHost() to perform DNS lookups in
order to return the actual host name of the remote client. Set
to <code>false to skip the DNS lookup and return the IP
address in String form instead (thereby improving performance).
By default, DNS lookups are enabled.</p>
</attribute>
<attribute name="maxPostSize" required="false">
<p>The maximum size in bytes of the POST which will be handled by
the container FORM URL parameter parsing. The feature can be disabled by
setting this attribute to a value less than or equal to 0.
If not specified, this attribute is set to 2097152 (2 megabytes).</p>
</attribute>
<attribute name="maxSavePostSize" required="false">
<p>The maximum size in bytes of the POST which will be saved/buffered by
the container during FORM or CLIENT-CERT authentication. For both types
of authentication, the POST will be saved/buffered before the user is
authenticated. For CLIENT-CERT authentication, the POST is buffered for
the duration of the SSL handshake and the buffer emptied when the request
is processed. For FORM authentication the POST is saved whilst the user
is re-directed to the login form and is retained until the user
successfully authenticates or the session associated with the
authentication request expires. The limit can be disabled by setting this
attribute to -1. Setting the attribute to zero will disable the saving of
POST data during authentication. If not specified, this attribute is set
to 4096 (4 kilobytes).</p>
</attribute>
<attribute name="protocol" required="false">
<p>This attribute value must be AJP/1.3 to use the AJP
handler.</p>
</attribute>
<attribute name="proxyName" required="false">
<p>If this Connector is being used in a proxy
configuration, configure this attribute to specify the server name
to be returned for calls to <code>request.getServerName().
See <a href="#Proxy Support">Proxy Support for more
information.</p>
</attribute>
<attribute name="proxyPort" required="false">
<p>If this Connector is being used in a proxy
configuration, configure this attribute to specify the server port
to be returned for calls to <code>request.getServerPort().
See <a href="#Proxy Support">Proxy Support for more
information.</p>
</attribute>
<attribute name="redirectPort" required="false">
<p>If this Connector is supporting non-SSL
requests, and a request is received for which a matching
<code><security-constraint> requires SSL transport,
Catalina will automatically redirect the request to the port
number specified here.</p>
</attribute>
<attribute name="request.registerRequests" required="false">
<p>This attribute controls request registration for JMX monitoring
of the Connector. It is enabled by default, but may be turned
it off to save a bit of memory.</p>
</attribute>
<attribute name="scheme" required="false">
<p>Set this attribute to the name of the protocol you wish to have
returned by calls to <code>request.getScheme(). For
example, you would set this attribute to "<code>https"
for an SSL Connector. The default value is "<code>http".
See <a href="#SSL Support">SSL Support for more information.
</attribute>
<attribute name="secure" required="false">
<p>Set this attribute to true if you wish to have
calls to <code>request.isSecure() to return true
for requests received by this Connector (you would want this on an
SSL Connector). The default value is <code>false.
</attribute>
<attribute name="URIEncoding" required="false">
<p>This specifies the character encoding used to decode the URI bytes,
after %xx decoding the URL. If not specified, ISO-8859-1 will be used.
</p>
</attribute>
<attribute name="useBodyEncodingForURI" required="false">
<p>This specifies if the encoding specified in contentType should be used
for URI query parameters, instead of using the URIEncoding. This
setting is present for compatibility with Tomcat 4.1.x, where the
encoding specified in the contentType, or explicitely set using
Request.setCharacterEncoding method was also used for the parameters from
the URL. The default value is <code>false.
</p>
</attribute>
<attribute name="useIPVHosts" required="false">
<p>Set this attribute to true to cause Tomcat to use
the ServerName passed by the native web server to determine the Host
to send the request to. The default value is <code>false.
</attribute>
<attribute name="xpoweredBy" required="false">
<p>Set this attribute to true to cause Tomcat to advertise
support for the Srevlet specification using the header recommended in the
specification. The default value is <code>false.
</attribute>
</attributes>
</subsection>
<subsection name="Standard Implementation">
<p>To use AJP, you
must specify the protocol attribute (see above).</p>
<p>This implementation supports the AJP 1.3 protocol.
<p>It supports the following additional attributes (in addition to the
common attributes listed above):</p>
<attributes>
<attribute name="address" required="false">
<p>For servers with more than one IP address, this attribute
specifies which address will be used for listening on the specified
port. By default, this port will be used on all IP addresses
associated with the server. A value of <code>127.0.0.1
indicates that the Connector will only listen on the loopback
interface.</p>
</attribute>
<attribute name="backlog" required="false">
<p>The maximum queue length for incoming connection requests when
all possible request processing threads are in use. Any requests
received when the queue is full will be refused. The default
value is 10.</p>
</attribute>
<attribute name="bufferSize" required="false">
<p>The size of the output buffer to use. If less than or equal to zero,
then output buffering is disabled. The default value is -1
(i.e. buffering disabled)</p>
</attribute>
<attribute name="connectionTimeout" required="false">
<p>The number of milliseconds this Connector will wait,
after accepting a connection, for the request URI line to be
presented. The default value is infinite (i.e. no timeout).</p>
</attribute>
<attribute name="executor" required="false">
<p>A reference to the name in an Executor element.
If this attribute is enabled, and the named executor exists, the connector will
use the executor, and all the other thread attributes will be ignored.</p>
</attribute>
<attribute name="keepAliveTimeout" required="false">
<p>The number of milliseconds this Connector will wait for
another AJP request before closing the connection.
The default value is to use the value that has been set for the
connectionTimeout attribute.</p>
</attribute>
<attribute name="maxThreads" required="false">
<p>The maximum number of request processing threads to be created
by this <strong>Connector, which therefore determines the
maximum number of simultaneous requests that can be handled. If
not specified, this attribute is set to 40. If an executor is associated
with this connector, this attribute is ignored as the connector will
execute tasks using the executor rather than an internal thread pool.</p>
</attribute>
<attribute name="port" required="true">
<p>The TCP port number on which this Connector
will create a server socket and await incoming connections. Your
operating system will allow only one server application to listen
to a particular port number on a particular IP address.</p>
</attribute>
<attribute name="tcpNoDelay" required="false">
<p>If set to true, the TCP_NO_DELAY option will be
set on the server socket, which improves performance under most
circumstances. This is set to <code>true by default.
</attribute>
<attribute name="tomcatAuthentication" required="false">
<p>If set to true, the authetication will be done in Tomcat.
Otherwise, the authenticated principal will be propagated from the native
webaserver and used for authorization in Tomcat.
The default value is <code>true.
</attribute>
</attributes>
</subsection>
</section>
<section name="Nested Components">
<p>None at this time.
</section>
</body>
</document>
Other Tomcat examples (source code examples)
Here is a short list of links related to this Tomcat ajp.xml source code file:
|
The search page
Other Tomcat source code examples at this package level
Click here to learn more about this project
