1 | <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference - The Valve Component</title><meta value="Craig R. McClanahan" name="author"><meta value="craigmcc@apache.org" name="email"></head><body vlink="#525D76" alink="#525D76" link="#525D76" text="#000000" bgcolor="#ffffff"><table cellspacing="0" width="100%" border="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img border="0" alt=" |
---|
2 | The Apache Tomcat Servlet/JSP Container |
---|
3 | " align="right" src="../images/tomcat.gif"></a></td><td><font face="arial,helvetica,sanserif"><h1>Apache Tomcat 6.0</h1></font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img border="0" alt="Apache Logo" align="right" src="../images/asf-logo.gif"></a></td></tr></table><table cellspacing="4" width="100%" border="0"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><tr><!--LEFT SIDE NAVIGATION--><td nowrap="true" valign="top" width="20%"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li><li><a href="index.html">Config Ref. Home</a></li></ul><p><strong>Top Level Elements</strong></p><ul><li><a href="server.html">Server</a></li><li><a href="service.html">Service</a></li></ul><p><strong>Executors</strong></p><ul><li><a href="executor.html">Executor</a></li></ul><p><strong>Connectors</strong></p><ul><li><a href="http.html">HTTP</a></li><li><a href="ajp.html">AJP</a></li></ul><p><strong>Containers</strong></p><ul><li><a href="context.html">Context</a></li><li><a href="engine.html">Engine</a></li><li><a href="host.html">Host</a></li><li><a href="cluster.html">Cluster</a></li></ul><p><strong>Nested Components</strong></p><ul><li><a href="globalresources.html">Global Resources</a></li><li><a href="loader.html">Loader</a></li><li><a href="manager.html">Manager</a></li><li><a href="realm.html">Realm</a></li><li><a href="resources.html">Resources</a></li><li><a href="valve.html">Valve</a></li></ul><p><strong>Cluster Elements</strong></p><ul><li><a href="cluster.html">Cluster</a></li><li><a href="cluster-manager.html">Manager</a></li><li><a href="cluster-channel.html">Channel</a></li><li><a href="cluster-membership.html">Channel/Membership</a></li><li><a href="cluster-sender.html">Channel/Sender</a></li><li><a href="cluster-receiver.html">Channel/Receiver</a></li><li><a href="cluster-interceptor.html">Channel/Interceptor</a></li><li><a href="cluster-valve.html">Valve</a></li><li><a href="cluster-deployer.html">Deployer</a></li><li><a href="cluster-listener.html">ClusterListener</a></li></ul><p><strong>Global Settings</strong></p><ul><li><a href="systemprops.html">System properties</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td align="left" valign="top" width="80%"><table cellspacing="4" width="100%" border="0"><tr><td valign="top" align="left"><h1>Apache Tomcat Configuration Reference</h1><h2>The Valve Component</h2></td><td nowrap="true" valign="top" align="right"><small><a href="printer/valve.html"><img alt="Printer Friendly Version" border="0" src="../images/printer.gif"><br>print-friendly<br>version |
---|
4 | </a></small></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> |
---|
5 | |
---|
6 | <p>A <strong>Valve</strong> element represents a component that will be |
---|
7 | inserted into the request processing pipeline for the associated |
---|
8 | Catalina container (<a href="engine.html">Engine</a>, |
---|
9 | <a href="host.html">Host</a>, or <a href="context.html">Context</a>). |
---|
10 | Individual Valves have distinct processing capabilities, and are |
---|
11 | described individually below.</p> |
---|
12 | |
---|
13 | <blockquote><em> |
---|
14 | <p>The description below uses the variable name $CATALINA_BASE to refer the |
---|
15 | base directory against which most relative paths are resolved. If you have |
---|
16 | not configured Tomcat 6 for multiple instances by setting a CATALINA_BASE |
---|
17 | directory, then $CATALINA_BASE will be set to the value of $CATALINA_HOME, |
---|
18 | the directory into which you have installed Tomcat 6.</p> |
---|
19 | </em></blockquote> |
---|
20 | |
---|
21 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Access Log Valve"><strong>Access Log Valve</strong></a></font></td></tr><tr><td><blockquote> |
---|
22 | |
---|
23 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> |
---|
24 | |
---|
25 | <p>The <strong>Access Log Valve</strong> creates log files in the same |
---|
26 | format as those created by standard web servers. These logs can later |
---|
27 | be analyzed by standard log analysis tools to track page hit counts, |
---|
28 | user session activity, and so on. The files produces by this <code>Valve</code> |
---|
29 | are rolled over nightly at midnight. This <code>Valve</code> |
---|
30 | may be associated with any Catalina container (<code>Context</code>, |
---|
31 | <code>Host</code>, or <code>Engine</code>), and |
---|
32 | will record ALL requests processed by that container.</p> |
---|
33 | |
---|
34 | </blockquote></td></tr></table> |
---|
35 | |
---|
36 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> |
---|
37 | |
---|
38 | <p>The <strong>Access Log Valve</strong> supports the following |
---|
39 | configuration attributes:</p> |
---|
40 | |
---|
41 | <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><strong><code>className</code></strong></td><td valign="center" align="left"> |
---|
42 | <p>Java class name of the implementation to use. This MUST be set to |
---|
43 | <strong>org.apache.catalina.valves.AccessLogValve</strong> to use the |
---|
44 | default access log valve.</p> |
---|
45 | </td></tr><tr><td valign="center" align="left"><code>directory</code></td><td valign="center" align="left"> |
---|
46 | <p>Absolute or relative pathname of a directory in which log files |
---|
47 | created by this valve will be placed. If a relative path is |
---|
48 | specified, it is interpreted as relative to $CATALINA_BASE. If |
---|
49 | no directory attribute is specified, the default value is "logs" |
---|
50 | (relative to $CATALINA_BASE).</p> |
---|
51 | </td></tr><tr><td valign="center" align="left"><code>pattern</code></td><td valign="center" align="left"> |
---|
52 | <p>A formatting layout identifying the various information fields |
---|
53 | from the request and response to be logged, or the word |
---|
54 | <code>common</code> or <code>combined</code> to select a |
---|
55 | standard format. See below for more information on configuring |
---|
56 | this attribute. Note that the optimized access does only support |
---|
57 | <code>common</code> and <code>combined</code> as the value for this |
---|
58 | attribute.</p> |
---|
59 | </td></tr><tr><td valign="center" align="left"><code>prefix</code></td><td valign="center" align="left"> |
---|
60 | <p>The prefix added to the start of each log file's name. If not |
---|
61 | specified, the default value is "access_log.". To specify no prefix, |
---|
62 | use a zero-length string.</p> |
---|
63 | </td></tr><tr><td valign="center" align="left"><code>resolveHosts</code></td><td valign="center" align="left"> |
---|
64 | <p>Set to <code>true</code> to convert the IP address of the remote |
---|
65 | host into the corresponding host name via a DNS lookup. Set to |
---|
66 | <code>false</code> to skip this lookup, and report the remote IP |
---|
67 | address instead.</p> |
---|
68 | </td></tr><tr><td valign="center" align="left"><code>suffix</code></td><td valign="center" align="left"> |
---|
69 | <p>The suffix added to the end of each log file's name. If not |
---|
70 | specified, the default value is "". To specify no suffix, |
---|
71 | use a zero-length string.</p> |
---|
72 | </td></tr><tr><td valign="center" align="left"><code>rotatable</code></td><td valign="center" align="left"> |
---|
73 | <p>Deafult true. Flag to determine if log rotation should occur. |
---|
74 | If set to false, then this file is never rotated and |
---|
75 | <tt>fileDateFormat</tt> is ignored. Use with caution! |
---|
76 | </p> |
---|
77 | </td></tr><tr><td valign="center" align="left"><code>condition</code></td><td valign="center" align="left"> |
---|
78 | <p>Turns on conditional logging. If set, requests will be |
---|
79 | logged only if <tt>ServletRequest.getAttribute()</tt> is |
---|
80 | null. For example, if this value is set to |
---|
81 | <tt>junk</tt>, then a particular request will only be logged |
---|
82 | if <tt>ServletRequest.getAttribute("junk") == null</tt>. |
---|
83 | The use of Filters is an easy way to set/unset the attribute |
---|
84 | in the ServletRequest on many different requests. |
---|
85 | </p> |
---|
86 | </td></tr><tr><td valign="center" align="left"><code>fileDateFormat</code></td><td valign="center" align="left"> |
---|
87 | <p>Allows a customized date format in the access log file name. |
---|
88 | The date format also decides how often the file is rotated. |
---|
89 | If you wish to rotate every hour, then set this value |
---|
90 | to: <tt>yyyy-MM-dd.HH</tt> |
---|
91 | </p> |
---|
92 | </td></tr><tr><td valign="center" align="left"><code>buffered</code></td><td valign="center" align="left"> |
---|
93 | <p>Deafult true. Flag to determine if logging will be buffered. |
---|
94 | If set to false, then access logging will be written after each |
---|
95 | request. |
---|
96 | </p> |
---|
97 | </td></tr></table> |
---|
98 | |
---|
99 | <p>Values for the <code>pattern</code> attribute are made up of literal |
---|
100 | text strings, combined with pattern identifiers prefixed by the "%" |
---|
101 | character to cause replacement by the corresponding variable value from |
---|
102 | the current request and response. The following pattern codes are |
---|
103 | supported:</p> |
---|
104 | <ul> |
---|
105 | <li><b>%a</b> - Remote IP address</li> |
---|
106 | <li><b>%A</b> - Local IP address</li> |
---|
107 | <li><b>%b</b> - Bytes sent, excluding HTTP headers, or '-' if zero</li> |
---|
108 | <li><b>%B</b> - Bytes sent, excluding HTTP headers</li> |
---|
109 | <li><b>%h</b> - Remote host name (or IP address if |
---|
110 | <code>resolveHosts</code> is false)</li> |
---|
111 | <li><b>%H</b> - Request protocol</li> |
---|
112 | <li><b>%l</b> - Remote logical username from identd (always returns |
---|
113 | '-')</li> |
---|
114 | <li><b>%m</b> - Request method (GET, POST, etc.)</li> |
---|
115 | <li><b>%p</b> - Local port on which this request was received</li> |
---|
116 | <li><b>%q</b> - Query string (prepended with a '?' if it exists)</li> |
---|
117 | <li><b>%r</b> - First line of the request (method and request URI)</li> |
---|
118 | <li><b>%s</b> - HTTP status code of the response</li> |
---|
119 | <li><b>%S</b> - User session ID</li> |
---|
120 | <li><b>%t</b> - Date and time, in Common Log Format</li> |
---|
121 | <li><b>%u</b> - Remote user that was authenticated (if any), else '-'</li> |
---|
122 | <li><b>%U</b> - Requested URL path</li> |
---|
123 | <li><b>%v</b> - Local server name</li> |
---|
124 | <li><b>%D</b> - Time taken to process the request, in millis</li> |
---|
125 | <li><b>%T</b> - Time taken to process the request, in seconds</li> |
---|
126 | <li><b>%I</b> - current request thread name (can compare later with stacktraces)</li> |
---|
127 | </ul> |
---|
128 | |
---|
129 | <p> |
---|
130 | There is also support to write information from the cookie, incoming |
---|
131 | header, the Session or something else in the ServletRequest. |
---|
132 | It is modeled after the apache syntax: |
---|
133 | <ul> |
---|
134 | <li><b><code>%{xxx}i</code></b> for incoming headers</li> |
---|
135 | <li><b><code>%{xxx}o</code></b> for outgoing response headers</li> |
---|
136 | <li><b><code>%{xxx}c</code></b> for a specific cookie</li> |
---|
137 | <li><b><code>%{xxx}r</code></b> xxx is an attribute in the ServletRequest</li> |
---|
138 | <li><b><code>%{xxx}s</code></b> xxx is an attribute in the HttpSession</li> |
---|
139 | </ul> |
---|
140 | </p> |
---|
141 | |
---|
142 | |
---|
143 | <p>The shorthand pattern name <code>common</code> (which is also the |
---|
144 | default) corresponds to <strong>'%h %l %u %t "%r" %s %b'</strong>.</p> |
---|
145 | |
---|
146 | <p>The shorthand pattern name <code>combined</code> appends the |
---|
147 | values of the <code>Referer</code> and <code>User-Agent</code> headers, |
---|
148 | each in double quotes, to the <code>common</code> pattern |
---|
149 | described in the previous paragraph.</p> |
---|
150 | |
---|
151 | </blockquote></td></tr></table> |
---|
152 | |
---|
153 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Remote Address Filter"><strong>Remote Address Filter</strong></a></font></td></tr><tr><td><blockquote> |
---|
154 | |
---|
155 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> |
---|
156 | |
---|
157 | <p>The <strong>Remote Address Filter</strong> allows you to compare the |
---|
158 | IP address of the client that submitted this request against one or more |
---|
159 | <em>regular expressions</em>, and either allow the request to continue |
---|
160 | or refuse to process the request from this client. A Remote Address |
---|
161 | Filter can be associated with any Catalina container |
---|
162 | (<a href="engine.html">Engine</a>, <a href="host.html">Host</a>, or |
---|
163 | <a href="context.html">Context</a>), and must accept any request |
---|
164 | presented to this container for processing before it will be passed on.</p> |
---|
165 | |
---|
166 | <p>The syntax for <em>regular expressions</em> is different than that for |
---|
167 | 'standard' wildcard matching. Tomcat uses the <code>java.util.regex</code> |
---|
168 | package. Please consult the Java documentation for details of the |
---|
169 | expressions supported.</p> |
---|
170 | |
---|
171 | </blockquote></td></tr></table> |
---|
172 | |
---|
173 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> |
---|
174 | |
---|
175 | <p>The <strong>Remote Address Filter</strong> supports the following |
---|
176 | configuration attributes:</p> |
---|
177 | |
---|
178 | <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><strong><code>className</code></strong></td><td valign="center" align="left"> |
---|
179 | <p>Java class name of the implementation to use. This MUST be set to |
---|
180 | <strong>org.apache.catalina.valves.RemoteAddrValve</strong>.</p> |
---|
181 | </td></tr><tr><td valign="center" align="left"><code>allow</code></td><td valign="center" align="left"> |
---|
182 | <p>A comma-separated list of <em>regular expression</em> patterns |
---|
183 | that the remote client's IP address is compared to. If this attribute |
---|
184 | is specified, the remote address MUST match for this request to be |
---|
185 | accepted. If this attribute is not specified, all requests will be |
---|
186 | accepted UNLESS the remote address matches a <code>deny</code> |
---|
187 | pattern.</p> |
---|
188 | </td></tr><tr><td valign="center" align="left"><code>deny</code></td><td valign="center" align="left"> |
---|
189 | <p>A comma-separated list of <em>regular expression</em> patterns |
---|
190 | that the remote client's IP address is compared to. If this attribute |
---|
191 | is specified, the remote address MUST NOT match for this request to be |
---|
192 | accepted. If this attribute is not specified, request acceptance is |
---|
193 | governed solely by the <code>accept</code> attribute.</p> |
---|
194 | </td></tr></table> |
---|
195 | |
---|
196 | </blockquote></td></tr></table> |
---|
197 | |
---|
198 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Remote Host Filter"><strong>Remote Host Filter</strong></a></font></td></tr><tr><td><blockquote> |
---|
199 | |
---|
200 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> |
---|
201 | |
---|
202 | <p>The <strong>Remote Host Filter</strong> allows you to compare the |
---|
203 | hostname of the client that submitted this request against one or more |
---|
204 | <em>regular expressions</em>, and either allow the request to continue |
---|
205 | or refuse to process the request from this client. A Remote Host |
---|
206 | Filter can be associated with any Catalina container |
---|
207 | (<a href="engine.html">Engine</a>, <a href="host.html">Host</a>, or |
---|
208 | <a href="context.html">Context</a>), and must accept any request |
---|
209 | presented to this container for processing before it will be passed on.</p> |
---|
210 | |
---|
211 | <p>The syntax for <em>regular expressions</em> is different than that for |
---|
212 | 'standard' wildcard matching. Tomcat uses the <code>java.util.regex</code> |
---|
213 | package. Please consult the Java documentation for details of the |
---|
214 | expressions supported.</p> |
---|
215 | |
---|
216 | </blockquote></td></tr></table> |
---|
217 | |
---|
218 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> |
---|
219 | |
---|
220 | <p>The <strong>Remote Host Filter</strong> supports the following |
---|
221 | configuration attributes:</p> |
---|
222 | |
---|
223 | <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><strong><code>className</code></strong></td><td valign="center" align="left"> |
---|
224 | <p>Java class name of the implementation to use. This MUST be set to |
---|
225 | <strong>org.apache.catalina.valves.RemoteHostValve</strong>.</p> |
---|
226 | </td></tr><tr><td valign="center" align="left"><code>allow</code></td><td valign="center" align="left"> |
---|
227 | <p>A comma-separated list of <em>regular expression</em> patterns |
---|
228 | that the remote client's hostname is compared to. If this attribute |
---|
229 | is specified, the remote hostname MUST match for this request to be |
---|
230 | accepted. If this attribute is not specified, all requests will be |
---|
231 | accepted UNLESS the remote hostname matches a <code>deny</code> |
---|
232 | pattern.</p> |
---|
233 | </td></tr><tr><td valign="center" align="left"><code>deny</code></td><td valign="center" align="left"> |
---|
234 | <p>A comma-separated list of <em>regular expression</em> patterns |
---|
235 | that the remote client's hostname is compared to. If this attribute |
---|
236 | is specified, the remote hostname MUST NOT match for this request to be |
---|
237 | accepted. If this attribute is not specified, request acceptance is |
---|
238 | governed solely by the <code>accept</code> attribute.</p> |
---|
239 | </td></tr></table> |
---|
240 | |
---|
241 | </blockquote></td></tr></table> |
---|
242 | |
---|
243 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Request Dumper Valve"><strong>Request Dumper Valve</strong></a></font></td></tr><tr><td><blockquote> |
---|
244 | |
---|
245 | |
---|
246 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> |
---|
247 | |
---|
248 | <p>The <em>Request Dumper Valve</em> is a useful tool in debugging |
---|
249 | interactions with a client application (or browser) that is sending |
---|
250 | HTTP requests to your Tomcat-based server. When configured, it causes |
---|
251 | details about each request processed by its associated <code>Engine</code>, |
---|
252 | <code>Host</code>, or <code>Context</code> to be logged according to |
---|
253 | the logging configuration for that container.</p> |
---|
254 | |
---|
255 | <p><strong>WARNING: Using this valve has side-effects.</strong> The |
---|
256 | output from this valve includes any parameters included with the request. |
---|
257 | The parameters will be decoded using the default platform encoding. Any |
---|
258 | subsequent calls to <code>request.setCharacterEncoding()</code> within |
---|
259 | the web application will have no effect.</p> |
---|
260 | |
---|
261 | </blockquote></td></tr></table> |
---|
262 | |
---|
263 | |
---|
264 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> |
---|
265 | |
---|
266 | <p>The <strong>Request Dumper Valve</strong> supports the following |
---|
267 | configuration attributes:</p> |
---|
268 | |
---|
269 | <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><strong><code>className</code></strong></td><td valign="center" align="left"> |
---|
270 | <p>Java class name of the implementation to use. This MUST be set to |
---|
271 | <strong>org.apache.catalina.valves.RequestDumperValve</strong>.</p> |
---|
272 | </td></tr></table> |
---|
273 | |
---|
274 | </blockquote></td></tr></table> |
---|
275 | |
---|
276 | |
---|
277 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Single Sign On Valve"><strong>Single Sign On Valve</strong></a></font></td></tr><tr><td><blockquote> |
---|
278 | |
---|
279 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> |
---|
280 | |
---|
281 | <p>The <em>Single Sign On Vale</em> is utilized when you wish to give users |
---|
282 | the ability to sign on to any one of the web applications associated with |
---|
283 | your virtual host, and then have their identity recognized by all other |
---|
284 | web applications on the same virtual host.</p> |
---|
285 | |
---|
286 | <p>See the <a href="host.html#Single Sign On">Single Sign On</a> special |
---|
287 | feature on the <strong>Host</strong> element for more information.</p> |
---|
288 | |
---|
289 | </blockquote></td></tr></table> |
---|
290 | |
---|
291 | |
---|
292 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> |
---|
293 | |
---|
294 | <p>The <strong>Single Sign On</strong> Valve supports the following |
---|
295 | configuration attributes:</p> |
---|
296 | |
---|
297 | <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><strong><code>className</code></strong></td><td valign="center" align="left"> |
---|
298 | <p>Java class name of the implementation to use. This MUST be set to |
---|
299 | <strong>org.apache.catalina.authenticator.SingleSignOn</strong>.</p> |
---|
300 | </td></tr><tr><td valign="center" align="left"><code>requireReauthentication</code></td><td valign="center" align="left"> |
---|
301 | <p>Default false. Flag to determine whether each request needs to be |
---|
302 | reauthenticated to the security <strong>Realm</strong>. If "true", this |
---|
303 | Valve uses cached security credentials (username and password) to |
---|
304 | reauthenticate to the <strong>Realm</strong> each request associated |
---|
305 | with an SSO session. If "false", the Valve can itself authenticate |
---|
306 | requests based on the presence of a valid SSO cookie, without |
---|
307 | rechecking with the <strong>Realm</strong>.</p> |
---|
308 | </td></tr><tr><td valign="center" align="left"><code>cookieDomain</code></td><td valign="center" align="left"> |
---|
309 | <p>Sets the host domain to be used for sso cookies.</p> |
---|
310 | </td></tr></table> |
---|
311 | |
---|
312 | </blockquote></td></tr></table> |
---|
313 | |
---|
314 | |
---|
315 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Form Authenticator Valve"><strong>Form Authenticator Valve</strong></a></font></td></tr><tr><td><blockquote> |
---|
316 | |
---|
317 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> |
---|
318 | |
---|
319 | <p>The <strong>Form Authenticator Valve</strong> is automatically added to |
---|
320 | any <a href="context.html">Context</a> that is configured to use FORM |
---|
321 | authentication.</p> |
---|
322 | |
---|
323 | <p>If any non-default settings are required, the valve may be configured |
---|
324 | within <a href="context.html">Context</a> element with the required |
---|
325 | values.</p> |
---|
326 | |
---|
327 | </blockquote></td></tr></table> |
---|
328 | |
---|
329 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> |
---|
330 | |
---|
331 | <p>The <strong>Form Authenticator Valve</strong> supports the following |
---|
332 | configuration attributes:</p> |
---|
333 | |
---|
334 | <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><strong><code>className</code></strong></td><td valign="center" align="left"> |
---|
335 | <p>Java class name of the implementation to use. This MUST be set to |
---|
336 | <strong>org.apache.catalina.authenticator.FormAuthenticator</strong>.</p> |
---|
337 | </td></tr><tr><td valign="center" align="left"><code>characterEncoding</code></td><td valign="center" align="left"> |
---|
338 | <p>Character encoding to use to read the username and password parameters |
---|
339 | from the request. If not set, the encoding of the request body will be |
---|
340 | used.</p> |
---|
341 | </td></tr></table> |
---|
342 | |
---|
343 | </blockquote></td></tr></table> |
---|
344 | |
---|
345 | </blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font size="-1" color="#525D76"><em> |
---|
346 | Copyright © 1999-2008, Apache Software Foundation |
---|
347 | </em></font></div></td></tr></table></body></html> |
---|