Gitiles
Code Review Sign In
source.supwisdom.com / UniIdentify / tomcat / 7189829bb2c240044551576d8e7a5404b9798f64 / . / tomcat-uid / webapps / docs / funcspecs / fs-admin-objects.html
blob: 1e6f78392b4db26fc1dcd7a3cd43fbbaa3726094 [file] [log] [blame]
Hongqing Liu71898292014-10-15 13:31:32 +0800[diff] [blame^]1<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Catalina Functional Specifications (6.0.41) - Administrative Apps - Administered Objects</title><meta name="author" content="Craig McClanahan"><style type="text/css" media="print">
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]2 .noPrint {display: none;}
3 td#mainBody {width: 100%;}
4 </style></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img src="../images/tomcat.gif" align="right" alt="
5 Catalina Functional Specifications
Hongqing Liu71898292014-10-15 13:31:32 +0800[diff] [blame^]6 " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 6.0</font></h1><font face="arial,helvetica,sanserif">Version 6.0.41, May 19 2014</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="../images/asf-logo.gif" align="right" alt="Apache Logo" border="0"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap="nowrap" class="noPrint"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li><li><a href="index.html">Functional Specs</a></li></ul><p><strong>Administrative Apps</strong></p><ul><li><a href="fs-admin-apps.html">Overall Requirements</a></li><li><a href="mbean-names.html">Tomcat MBean Names</a></li><li><a href="fs-admin-objects.html">Administered Objects</a></li><li><a href="fs-admin-opers.html">Supported Operations</a></li></ul><p><strong>Internal Servlets</strong></p><ul><li><a href="fs-default.html">Default Servlet</a></li><li><a href="fs-invoker.html">Invoker Servlet</a></li></ul><p><strong>Realm Implementations</strong></p><ul><li><a href="fs-jdbc-realm.html">JDBC Realm</a></li><li><a href="fs-jndi-realm.html">JNDI Realm</a></li><li><a href="fs-memory-realm.html">Memory Realm</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>Catalina Functional Specifications</h1><h2>Administrative Apps - Administered Objects</h2><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote>
Hongqing Liufd5ee812014-05-10 16:32:51 +0800[diff] [blame]7<ul><li><a href="#Administered_Objects_Overview">Administered Objects Overview</a></li><li><a href="#Access_Logger">Access Logger</a></li><li><a href="#Connector">Connector</a></li><li><a href="#Context">Context</a></li><li><a href="#Default_Context">Default Context</a></li><li><a href="#Default_Deployment_Descriptor">Default Deployment Descriptor</a></li><li><a href="#Engine">Engine</a></li><li><a href="#Environment_Entry">Environment Entry</a></li><li><a href="#Host">Host</a></li><li><a href="#JDBC_Resource">JDBC Resource</a></li><li><a href="#Loader">Loader</a></li><li><a href="#Manager">Manager</a></li><li><a href="#Realm">Realm</a></li><li><a href="#Request_Filter">Request Filter</a></li><li><a href="#Server">Server</a></li><li><a href="#Service">Service</a></li></ul>
8</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Administered Objects Overview"><!--()--></a><a name="Administered_Objects_Overview"><strong>Administered Objects Overview</strong></a></font></td></tr><tr><td><blockquote>
9
10<p>This document defines the <em>Administered Objects</em> that represent
11the internal architectural components of the Catalina servlet container.
12Associated with each is a set of <a href="fs-admin-opers.html">Supported
13Operations</a> that can be performed when the administrative application is
14"focused" on a particular configurable object.</p>
15
16<p>The following Administered Objects are defined:</p>
17<ul>
18<li><a href="#Access Logger">Access Logger</a></li>
19<li><a href="#Connector">Connector</a></li>
20<li><a href="#Context">Context</a></li>
21<li><a href="#Default Context">Default Context</a></li>
22<li><a href="#Default Deployment Descriptor">Default Deployment Descriptor</a></li>
23<li><a href="#Engine">Engine</a></li>
24<li><a href="#Environment Entry">Environment Entry</a></li>
25<li><a href="#Host">Host</a></li>
26<li><a href="#JDBC Resource">JDBC Resource</a></li>
27<li><a href="#Loader">Loader</a></li>
28<li><a href="#Manager">Manager</a></li>
29<li><a href="#Realm">Realm</a></li>
30<li><a href="#Request Filter">Request Filter</a></li>
31<li><a href="#Server">Server</a></li>
32<li><a href="#Service">Service</a></li>
33</ul>
34
35</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Access Logger"><!--()--></a><a name="Access_Logger"><strong>Access Logger</strong></a></font></td></tr><tr><td><blockquote>
36
37 <p>An <em>Access Logger</em> is an optional <code>Valve</code> that can
38 create request access logs in the same formats as those provided by
39 web servers. Such access logs are useful input to hit count and user
40 access tracking analysis programs. An Access Logger can be attached to
41 an <em>Engine</em>, a <em>Host</em>, a <em>Context</em>, or a <em>Default
42 Context</em>.</p>
43
44 <p>The standard component implementing an <em>Access Logger</em> is
45 <code>org.apache.catalina.valves.AccessLogValve</code>. It supports the
46 following configurable properties:</p>
47 <ul>
48 <li><code>debug</code> - Debugging detail level. [0]</li>
49 <li><code>directory</code> - Absolute or relative (to $CATALINA_BASE) path
50 of the directory into which access log files are created.
51 [logs].</li>
52 <li><code>pattern</code> - Pattern string defining the fields to be
53 included in the access log output, or "common" for the standard
54 access log pattern. See
55 <code>org.apache.catalina.valves.AccessLogValve</code> for more
56 information. [common]</li>
57 <li><code>prefix</code> - Prefix added to the beginning of each log file
58 name created by this access logger.</li>
59 <li><code>resolveHosts</code> - Should IP addresses be resolved to host
60 names in the log? [false]</li>
61 <li><code>suffix</code> - Suffix added to the end of each log file name
62 created by this access logger.</li>
63 </ul>
64
65</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Connector"><strong>Connector</strong></a></font></td></tr><tr><td><blockquote>
66
67 <p>A <em>Connector</em> is the representation of a communications endpoint
68 by which requests are received from (and responses returned to) a Tomcat
69 client. The administrative applications shall support those connectors
70 that are commonly utilized in Tomcat installations, as described in detail
71 below.</p>
72
73 <p>For standalone use, the standard connector supporting the HTTP/1.1
74 protocol is <code>org.apache.catalina.connectors.http.HttpConnector</code>.
75 It supports the following configurable properties:</p>
76 <ul>
77 <li><code>acceptCount</code> - The maximum queue length of incoming
78 connections that have not yet been accepted. [10]</li>
79 <li><code>address</code> - For servers with more than one IP address, the
80 address upon which this connector should listen. [All Addresses]</li>
81 <li><code>bufferSize</code> - Default input buffer size (in bytes) for
82 requests created by this Connector. [2048]</li>
83 <li><code>debug</code> - Debugging detail level. [0]</li>
84 <li><code>enableLookups</code> - Should we perform DNS lookups on remote
85 IP addresses when <code>request.getRemoteHost()</code> is called?
86 [false]</li>
87 <li><code>maxProcessors</code> - The maximum number of processor threads
88 supported by this connector. [20]</li>
89 <li><code>minProcessors</code> - The minimum number of processor threads
90 to be created at container startup. [5]</li>
91 <li><code>port</code> - TCP/IP port number on which this Connector should
92 listen for incoming requests. [8080]</li>
93 <li><code>proxyName</code> - Host name to be returned when an application
94 calls <code>request.getServerName()</code>. [Value of Host: header]</li>
95 <li><code>proxyPort</code> - Port number to be returned when an application
96 calls <code>request.getServerPort()</code>. [Same as <code>port</code>]
97 </li>
98 </ul>
99
100</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Context"><strong>Context</strong></a></font></td></tr><tr><td><blockquote>
101
102 <p>A <em>Context</em> is the representation of an individual web application,
103 which is associated with a corresponding <em>Host</em>. Note that the
104 administrable properties of a <em>Context</em> do <strong>not</strong>
105 include any settings from inside the web application deployment descriptor
106 for that application.</p>
107
108 <p>The standard component implementing a <em>Context</em> is
109 <code>org.apache.catalina.core.StandardContext</code>. It supports the
110 following configurable properties:</p>
111 <ul>
112 <li><code>cookies</code> - Should be use cookies for session identifier
113 communication? [true]</li>
114 <li><code>crossContext</code> - Should calls to
115 <code>ServletContext.getServletContext()</code> return the actual
116 context responsible for the specified path? [false]</li>
117 <li><code>debug</code> - Debugging detail level. [0]</li>
118 <li><code>docBase</code> - The absolute or relative (to the
119 <code>appBase</code> of our owning <em>Host</em>) pathname of a
120 directory containing an unpacked web application, or of a web
121 application archive (WAR) file.</li>
122 <li><code>override</code> - Should settings in this <em>Context</em>
123 override corresponding settings in the <em>Default Context</em>?
124 [false]</li>
125 <li><code>path</code> - Context path for this web application, or an empty
126 string for the root application of a <em>Host</em>. [Inferred from
127 directory or WAR file name]</li>
128 <li><code>reloadable</code> - Should Tomcat monitor classes in the
129 <code>/WEB-INF/classes</code> directory for changes, and reload the
130 application if they occur? [false]</li>
131 <li><code>useNaming</code> - Should Tomcat provide a JNDI naming context,
132 containing preconfigured entries and resources, corresponding to the
133 requirements of the Java2 Enterprise Edition specification? [true]</li>
134 <li><code>workDir</code> - Absolute pathname of a scratch directory that is
135 provided to this web application. [Automatically assigned relative to
136 $CATALINA_BASE/work]</li>
137 </ul>
138
139 <p>Each <em>Context</em> is owned by a parent <em>Host</em>, and is
140 associated with:</p>
141 <ul>
142 <li>An optional <em>Access Logger</em> that logs all requests processed
143 by this web application.</li>
144 <li>Zero or more <em>Environment Entries</em> representing environment
145 entries for the JNDI naming context associated with a web
146 application.</li>
147 <li>Zero or more <em>JDBC Resources</em> representing database connection
148 pools associated with a web application.</li>
149 <li>A <em>Loader</em> representing the web application class loader used
150 by this web application.</li>
151 <li>A <em>Manager</em> representing the session manager used by this
152 web application.</li>
153 <li>An optional <em>Realm</em> used to provide authentication and access
154 control information for this web application.</li>
155 <li>Zero or more <em>Request Filters</em> used to limit access to this
156 web application based on remote host name or IP address.</li>
157 </ul>
158
159</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Default Context"><!--()--></a><a name="Default_Context"><strong>Default Context</strong></a></font></td></tr><tr><td><blockquote>
160
161 <p>A <em>Default Context</em> represents a subset of the configurable
162 properties of a <em>Context</em>, and is used to set defaults for those
163 properties when web applications are automatically deployed. A <em>Default
164 Context</em> object can be associated with an <em>Engine</em> or a
165 <em>Host</em>. The following configurable properties are supported:</p>
166 <ul>
167 <li><code>cookies</code> - Should be use cookies for session identifier
168 communication? [true]</li>
169 <li><code>crossContext</code> - Should calls to
170 <code>ServletContext.getServletContext()</code> return the actual
171 context responsible for the specified path? [false]</li>
172 <li><code>reloadable</code> - Should Tomcat monitor classes in the
173 <code>/WEB-INF/classes</code> directory for changes, and reload the
174 application if they occur? [false]</li>
175 <li><code>useNaming</code> - Should Tomcat provide a JNDI naming context,
176 containing preconfigured entries and resources, corresponding to the
177 requirements of the Java2 Enterprise Edition specification? [true]</li>
178 </ul>
179
180 <p>Each <em>Default Context</em> is owned by a parent <em>Engine</em> or
181 <em>Host</em>, and is associated with:</p>
182 <ul>
183 <li>Zero or more <em>Environment Entries</em> representing environment
184 entries for the JNDI naming context associated with a web
185 application.</li>
186 <li>Zero or more <em>JDBC Resources</em> representing database connection
187 pools associated with a web application.</li>
188 <li>An optional <em>Loader</em> representing default configuration
189 properties for the Loader component of deployed web applications.</li>
190 <li>An optional <em>Manager</em> representing default configuration
191 properties for the Manager component of deployed web applications.</li>
192 </ul>
193
194</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Default Deployment Descriptor"><!--()--></a><a name="Default_Deployment_Descriptor"><strong>Default Deployment Descriptor</strong></a></font></td></tr><tr><td><blockquote>
195
196 <p>Default web application characteristics are configured in a special
197 deployment descriptor named <code>$CATALINA_BASE/conf/web.xml</code>. This
198 section describes the configurable components that may be stored there.</p>
199
200 <p><strong>FIXME</strong> - Complete the description of default servlets,
201 default mappings, default MIME types, and so on.</p>
202
203</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Engine"><strong>Engine</strong></a></font></td></tr><tr><td><blockquote>
204
205 <p>An <em>Engine</em> is the representation of the entire Catalina
206 servlet container, and processes all requests for all of the associated
207 virtual hosts and web applications.</p>
208
209 <p>The standard component implementing an <em>Engine</em> is
210 <code>org.apache.catalina.core.StandardEngine</code>. It supports the
211 following configurable properties:</p>
212 <ul>
213 <li><code>debug</code> - Debugging detail level. [0]</li>
214 <li><code>defaultHost</code> - Name of the <em>Host</em> to which requests
215 will be directed if the requested host is unknown. [localhost]</li>
216 <li><code>name</code> - Logical name of this engine. [Tomcat Stand-Alone]
217 </li>
218 </ul>
219
220 <p>Each <em>Engine</em> is owned by a parent <em>Service</em>, and is
221 associated with:</p>
222 <ul>
223 <li>An optional <em>Access Logger</em> that logs all requests processed
224 by the entire container.</li>
225 <li>A <em>Default Context</em>, representing default properties of a
226 <em>Context</em> for automatically deployed applications for all
227 associated <em>Hosts</em> (unless overridden by a subordinate
228 component).</li>
229 <li>One or more <em>Hosts</em> representing individual virtual hosts
230 supported by this container.</li>
231 <li>A <em>Realm</em> used to provide authentication and access control
232 information for all virtual hosts and web applications (unless
233 overridden by a subordinate component).</li>
234 <li>Zero or more <em>Request Filters</em> used to limit access to the
235 entire container based on remote host name or IP address.</li>
236 </ul>
237
238</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Environment Entry"><!--()--></a><a name="Environment_Entry"><strong>Environment Entry</strong></a></font></td></tr><tr><td><blockquote>
239
240 <p>An <em>Environment Entry</em> is the representation of a
241 <code>&lt;env-entry&gt;</code> element from a web application deployment
242 descriptor. It will cause the creation of a corresponding entry in the
243 JNDI naming context provided to the corresponding <em>Context</em>. The
244 following configurable properties are supported:</p>
245 <ul>
246 <li><code>description</code> - Description of this environment entry.</li>
247 <li><code>name</code> - Environment entry name (relative to the
248 <code>java:comp/env</code> context)</li>
249 <li><code>type</code> - Environment entry type (must be one of the fully
250 qualified Java classes listed in the servlet spec).</li>
251 <li><code>value</code> - Environment entry value (must be convertible from
252 String to the specified <code>type</code>.</li>
253 </ul>
254
255</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Host"><strong>Host</strong></a></font></td></tr><tr><td><blockquote>
256
257 <p>A <em>Host</em> is the representation of an individual virtual host,
258 which has a unique set of associated web applications.</p>
259
260 <p>The standard component implementing a <em>Host</em> is
261 <code>org.apache.catalina.core.StandardHost</code>. It supports the
262 following configurable properties:</p>
263 <ul>
264 <li><code>aliases</code> - Zero or more DNS names that are also associated
265 with this host (for example, a particular host might be named
266 <code>www.mycompany.com</code> with an alias <code>company.com</code>).
267 </li>
268 <li><code>appBase</code> - Absolute or relative (to $CATALINA_BASE) path
269 to a directory from which web applications will be automatically
270 deployed.</li>
271 <li><code>debug</code> - Debugging detail level. [0]</li>
272 <li><code>name</code> - DNS Name of the virtual host represented by this
273 object.</li>
274 <li><code>unpackWARs</code> - Should web application archive files
275 deployed by this virtual host be unpacked first? [true]</li>
276 </ul>
277
278 <p>Each <em>Host</em> is owned by a parent <em>Engine</em>, and is
279 associated with:</p>
280 <ul>
281 <li>An optional <em>Access Logger</em> that logs all requests processed
282 by this virtual host.</li>
283 <li>One or more <em>Contexts</em> representing the web applications
284 operating on this <em>Host</em>.</li>
285 <li>A <em>Default Context</em> representing default <em>Context</em>
286 properties for web applications that are automatically deployed
287 by this <em>Host</em>.</li>
288 <li>A optional <em>Realm</em> used to provide authentication and access
289 control information for all web applications associated with this
290 virtual host (unless overridden by a subordinate component).</li>
291 </ul>
292
293 <p><strong>FIXME</strong> - Should we support configuration of the
294 User Web Applications functionality?</p>
295
296</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="JDBC Resource"><!--()--></a><a name="JDBC_Resource"><strong>JDBC Resource</strong></a></font></td></tr><tr><td><blockquote>
297
298 <p>A <em>JDBC Resources</em> represents a database connection pool (i.e.
299 an implementation of <code>javax.sql.DataSource</code> that will be
300 configured and made available in the JNDI naming context associated with
301 a web application.</p>
302
303 <p><strong>FIXME</strong> - properties of this administered object</p>
304
305</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Loader"><strong>Loader</strong></a></font></td></tr><tr><td><blockquote>
306
307 <p>A <em>Loader</em> represents a web application class loader that will
308 be utilized to provide class loading services for a particular
309 <em>Context</em>.</p>
310
311 <p>The standard component implementing a <em>Loader</em> is
312 <code>org.apache.catalina.loader.StandardLoader</code>. It supports
313 the following configurable properties:</p>
314 <ul>
315 <li><code>checkInterval</code> - Number of seconds between checks for
316 modified classes, if automatic reloading is enabled. [15]</li>
317 <li><code>debug</code> - Debugging detail level. [0]</li>
318 <li><code>reloadable</code> - Should this class loader check for modified
319 classes and initiate automatic reloads? [Set automatically from the
320 <code>reloadable</code> property of the corresponding <em>Context</em>]
321 </li>
322 </ul>
323
324 <p>Each <em>Loader</em> is owned by a parent <em>Context</em>.</p>
325
326</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Manager"><strong>Manager</strong></a></font></td></tr><tr><td><blockquote>
327
328 <p>A <em>Manager</em> represents a session manager that will be associated
329 with a particular web application. <strong>FIXME</strong> - Add support
330 for advanced session managers and their associated Stores.</p>
331
332 <p>The standard component implementing a <em>Manager</em> is
333 <code>org.apache.catalina.session.StandardManager</code>. It supports
334 the following configurable properties:</p>
335 <ul>
336 <li><code>checkInterval</code> - Number of seconds between checks for
337 expired sessions. [60]</li>
338 <li><code>debug</code> - Debugging detail level. [0]</li>
339 <li><code>entropy</code> - String initialization parameter used to increase
340 the entropy (initial randomness) of the random number generator used to
341 create session identifiers. [Inferred from engine, host, and context]
342 </li>
343 <li><code>maxActiveSessions</code> - The maximum number of active sessions
344 that are allowed, or -1 for no limit. [-1]</li>
345 </ul>
346
347 <p>Each <em>Manager</em> is owned by a parent <em>Context</em>.</p>
348
349</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Realm"><strong>Realm</strong></a></font></td></tr><tr><td><blockquote>
350
351 <p>A <em>Realm</em> represents a "database" of information about authorized
352 users, their passwords, and the security roles assigned to them. This will
353 be used by the container in the implementation of container-managed security
354 in accordance with the Servlet Specification. Several alternative
355 implementations are supported.</p>
356
357 <p><code>org.apache.catalina.realm.MemoryRealm</code> initializes its user
358 information from a simple XML file at startup time. If changes are made
359 to the information in this file, the corresponding web applications using
360 it must be restarted for the changes to take effect. It supports the
361 following configurable properties:</p>
362 <ul>
363 <li><code>debug</code> - Debugging detail level. [0]</li>
364 <li><code>pathname</code> - Absolute or relative (to $CATALINA_BASE) path to
365 the XML file containing our user information. [conf/tomcat-users.xml]
366 </li>
367 </ul>
368
369 <p><code>org.apache.catalina.realm.JDBCRealm</code> uses a relational
370 database (accessed via JDBC APIs) to contain the user information. Changes
371 in the contents of this database take effect immediately; however, the roles
372 assigned to a particular user are calculated only when the user initially
373 logs on (and not per request). The following configurable properties
374 are supported:</p>
375 <ul>
376 <li><code>connectionName</code> - Database username to use when establishing
377 a JDBC connection.</li>
378 <li><code>connectionPassword</code> - Database password to use when
379 establishing a JDBC connection.</li>
380 <li><code>connectionURL</code> - Connection URL to use when establishing
381 a JDBC connection.</li>
382 <li><code>debug</code> - Debugging detail level. [0]</li>
383 <li><code>digest</code> - Name of the <code>MessageDigest</code> algorithm
384 used to encode passwords in the database, or a zero-length string for
385 no encoding. [Zero-length String]</li>
386 <li><code>driverName</code> - Fully qualified Java class name of the JDBC
387 driver to be utilized.</li>
388 <li><code>roleNameCol</code> - Name of the column, in the User Roles table,
389 which contains the role name.</li>
390 <li><code>userCredCol</code> - Name of the column, in the Users table,
391 which contains the password (encrypted or unencrypted).</li>
392 <li><code>userNameCol</code> - Name of the column, in both the Users and
393 User Roles tables, that contains the username.</li>
394 <li><code>userRoleTable</code> - Name of the User Roles table, which contains
395 one row per security role assigned to a particular user. This table must
396 contain the columns specified by the <code>userNameCol</code> and
397 <code>roleNameCol</code> properties.</li>
398 <li><code>userTable</code> - Name of the Users table, which contains one row
399 per authorized user. This table must contain the columns specified by
400 the <code>userNameCol</code> and <code>userCredCol</code> properties.
401 </li>
402 </ul>
403
404 <p><strong>FIXME</strong> - Should we provide mechanisms to edit the contents
405 of a "tomcat-users.xml" file through the admin applications?</p>
406
407 <p>Each <em>Realm</em> is owned by a parent <em>Engine</em>, <em>Host</em>,
408 or <em>Context</em>.</p>
409
410</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Request Filter"><!--()--></a><a name="Request_Filter"><strong>Request Filter</strong></a></font></td></tr><tr><td><blockquote>
411
412 <p><strong>FIXME</strong> - complete this entry</p>
413
414</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Server"><strong>Server</strong></a></font></td></tr><tr><td><blockquote>
415
416 <p><strong>FIXME</strong> - complete this entry</p>
417
418</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Service"><strong>Service</strong></a></font></td></tr><tr><td><blockquote>
419
420 <p><strong>FIXME</strong> - complete this entry</p>
421
422</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
423 Copyright &copy; 1999-2014, Apache Software Foundation
424 </em></font></div></td></tr></table></body></html>