blob: b0fbeb853fc5b659dc88b64079643807c26aa40f [file] [log] [blame]
刘洪青6266f992017-05-15 21:21:03 +08001<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Catalina Functional Specifications (7.0.77) - Administrative Apps - Supported Operations</title><meta name="author" content="Craig McClanahan"><style type="text/css" media="print">
2 .noPrint {display: none;}
3 td#mainBody {width: 100%;}
4</style><style type="text/css">
5code {background-color:rgb(224,255,255);padding:0 0.1em;}
6code.attributeName, code.propertyName {background-color:transparent;}
7
8
9table {
10 border-collapse: collapse;
11 text-align: left;
12}
13table *:not(table) {
14 /* Prevent border-collapsing for table child elements like <div> */
15 border-collapse: separate;
16}
17
18th {
19 text-align: left;
20}
21
22
23div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code {
24 background-color: transparent;
25}
26div.codeBox {
27 overflow: auto;
28 margin: 1em 0;
29}
30div.codeBox pre {
31 margin: 0;
32 padding: 4px;
33 border: 1px solid #999;
34 border-radius: 5px;
35 background-color: #eff8ff;
36 display: table; /* To prevent <pre>s from taking the complete available width. */
37 /*
38 When it is officially supported, use the following CSS instead of display: table
39 to prevent big <pre>s from exceeding the browser window:
40 max-width: available;
41 width: min-content;
42 */
43}
44
45div.codeBox pre.wrap {
46 white-space: pre-wrap;
47}
48
49
50table.defaultTable tr, table.detail-table tr {
51 border: 1px solid #CCC;
52}
53
54table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) {
55 background-color: #FAFBFF;
56}
57
58table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) {
59 background-color: #EEEFFF;
60}
61
62table.defaultTable th, table.detail-table th {
63 background-color: #88b;
64 color: #fff;
65}
66
67table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td {
68 padding: 5px 8px;
69}
70
71
72p.notice {
73 border: 1px solid rgb(255, 0, 0);
74 background-color: rgb(238, 238, 238);
75 color: rgb(0, 51, 102);
76 padding: 0.5em;
77 margin: 1em 2em 1em 1em;
78}
79</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="
Hongqing Liufd5ee812014-05-10 16:32:51 +080080 Catalina Functional Specifications
刘洪青6266f992017-05-15 21:21:03 +080081 " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 7</font></h1><font face="arial,helvetica,sanserif">Version 7.0.77, Mar 28 2017</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="../images/asf-logo.svg" align="right" alt="Apache Logo" border="0" style="width: 266px;height: 83px;"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" 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><li><a href="http://wiki.apache.org/tomcat/FAQ">FAQ</a></li><li><a href="#comments_section">User Comments</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></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>Administrative Apps - Supported Operations</h1><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 +080082<ul><li><a href="#Supported_Operations_Overview">Supported Operations 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="#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>
83</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Supported Operations Overview"><!--()--></a><a name="Supported_Operations_Overview"><strong>Supported Operations Overview</strong></a></font></td></tr><tr><td><blockquote>
84
85<p>This document defines the <em>Supported Operations</em> that may
86be performed against the <a href="fs-admin-objects.html">Administered
刘洪青6266f992017-05-15 21:21:03 +080087Objects</a> that are supported by Tomcat administrative applications.
Hongqing Liufd5ee812014-05-10 16:32:51 +080088Not all operations are required to be available through every administrative
89application that is implemented. However, if a given operation is available,
90it should operate consistently with the descriptions found here.</p>
91
92<p>Supported Operations are described for the following Administered
93Objects:</p>
94<ul>
95<li><a href="#Access Logger">Access Logger</a></li>
96<li><a href="#Connector">Connector</a></li>
97<li><a href="#Context">Context</a></li>
98<li><a href="#Default Context">Default Context</a></li>
99<li><a href="#Engine">Engine</a></li>
100<li><a href="#Environment Entry">Environment Entry</a></li>
101<li><a href="#Host">Host</a></li>
102<li><a href="#JDBC Resource">JDBC Resource</a></li>
103<li><a href="#Loader">Loader</a></li>
104<li><a href="#Manager">Manager</a></li>
105<li><a href="#Realm">Realm</a></li>
106<li><a href="#Request Filter">Request Filter</a></li>
107<li><a href="#Server">Server</a></li>
108<li><a href="#Service">Service</a></li>
109</ul>
110
111</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>
112
113 <p>From the perspective of a particular <em>Access Logger</em>, it shall
114 be possible to perform the following administrative operations:</p>
115 <ul>
116 <li>Navigate to the owning <em>Engine</em>, <em>Host</em>, or
117 <em>Context</em>.</li>
118 <li>Edit the configurable properties of this object.</li>
119 </ul>
120
121</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>
122
123 <p>From the perspective of a particular <em>Connector</em>, it shall be
124 possible to perform the following administrative operations:</p>
125 <ul>
126 <li>Navigate to the owning <em>Service</em>.</li>
127 <li>Edit the configurable properties of this object.</li>
128 </ul>
129
130</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>
131
132 <p>From the perspective of a particular <em>Context</em>, it shall be
133 possible to perform the following administrative operations:</p>
134 <ul>
135 <li>Navigate to the owning <em>Host</em>.</li>
136 <li>Edit the configurable properties of this object.</li>
137 <li>Create and configure a new <em>Access Logger</em> associated
138 with this object.</li>
139 <li>Edit the configurable properties of the associated <em>Access
140 Logger</em>.</li>
141 <li>Remove the associated <em>Access Logger</em>.</li>
142 <li>Create and configure a new <em>Environment Entry</em> associated
143 with this object.</li>
144 <li>Select and edit the configurable properties of an associated
145 <em>Environment Entry</em>.</li>
146 <li>Remove an associated <em>Environment Entry</em>.</li>
147 <li>Create and configure a new <em>JDBC Resource</em> associated
148 with this object.</li>
149 <li>Select and edit the configurable properties of an associated
150 <em>JDBC Resource</em>.</li>
151 <li>Remove an associated <em>JDBC Resource</em>.</li>
152 <li>Create and configure a new <em>Loader</em> associated with
153 this object.</li>
154 <li>Edit the configurable properties of the associated <em>Loader</em>.</li>
155 <li>Remove the associated <em>Loader</em>.</li>
156 <li>Create and configure a new <em>Manager</em> associated with
157 this object.</li>
158 <li>Edit the configurable properties of the associated <em>Manager</em>.</li>
159 <li>Remove the associated <em>Manager</em>.</li>
160 <li>Create and configure a new <em>Realm</em> associated with
161 this object.</li>
162 <li>Edit the configurable properties of the associated <em>Realm</em>.</li>
163 <li>Remove the associated <em>Realm</em>.</li>
164 <li>Create and configure a new <em>Request Filter</em> associated with
165 this object.</li>
166 <li>Select and edit the configurable properties of an
167 associated <em>Request Filter</em></li>
168 <li>Remove an associated <em>Request Filter</em>.</li>
169 </ul>
170
171</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>
172
173 <p>From the perspective of a particular <em>Default Context</em>, it shall
174 be possible to perform the following administrative operations:</p>
175 <ul>
176 <li>Navigate to the owning <em>Engine</em> or <em>Host</em>.</li>
177 <li>Edit the configurable properties of this object.</li>
178 <li>Create and configure a new <em>Environment Entry</em> associated
179 with this object.</li>
180 <li>Select and edit the configurable properties of an associated
181 <em>Environment Entry</em>.</li>
182 <li>Remove an associated <em>Environment Entry</em>.</li>
183 <li>Create and configure a new <em>JDBC Resource</em> associated
184 with this object.</li>
185 <li>Select and edit the configurable properties of an associated
186 <em>JDBC Resource</em>.</li>
187 <li>Remove an associated <em>JDBC Resource</em>.</li>
188 </ul>
189
190</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>
191
192 <p>From the perspective of a particular <em>Engine</em>, it shall be
193 possible to perform the following administrative operations:</p>
194 <ul>
195 <li>Navigate to the owning <em>Service</em>.</li>
196 <li>Edit the configurable properties of this object.</li>
197 <li>Create and configure a new <em>Access Logger</em> associated
198 with this object.</li>
199 <li>Edit the configurable properties of the associated <em>Access
200 Logger</em>.</li>
201 <li>Remove the associated <em>Access Logger</em>.</li>
202 <li>Create and configure a new <em>Default Context</em> associated
203 with this object.</li>
204 <li>Edit the configurable properties of the associated <em>Default
205 Context</em>.</li>
206 <li>Remove the associated <em>Default Context</em>.</li>
207 <li>Create and configure a new <em>Host</em> associated with
208 this object.</li>
209 <li>Select and edit the configurable properties of an
210 associated <em>Host</em>.</li>
211 <li>Remove an associated <em>Host</em>.</li>
212 <li>Create and configure a new <em>Realm</em> associated with
213 this object.</li>
214 <li>Edit the configurable properties of the associated <em>Realm</em>.</li>
215 <li>Remove the associated <em>Realm</em>.</li>
216 <li>Create and configure a new <em>Request Filter</em> associated with
217 this object.</li>
218 <li>Select and edit the configurable properties of an
219 associated <em>Request Filter</em></li>
220 <li>Remove an associated <em>Request Filter</em>.</li>
221 </ul>
222
223</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>
224
225 <p>From the perspective of a particular <em>Environment Entry</em>, it shall
226 be possible to perform the following administrative operations:</p>
227 <ul>
228 <li>Navigate to the owning <em>Context</em> or <em>Default Context</em>.</li>
229 <li>Edit the configurable properties of this object.</li>
230 </ul>
231
232</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>
233
234 <p>From the perspective of a particular <em>Host</em>, it shall be
235 possible to perform the following administrative operations:</p>
236 <ul>
237 <li>Navigate to the owning <em>Engine</em>.</li>
238 <li>Edit the configurable properties of this object.</li>
239 <li>Create and configure a new <em>Access Logger</em> associated
240 with this object.</li>
241 <li>Edit the configurable properties of the associated <em>Access
242 Logger</em>.</li>
243 <li>Remove the associated <em>Access Logger</em>.</li>
244 <li>Create and configure a new <em>Context</em> associated with
245 this object.</li>
246 <li>Select and edit the configurable properties of an associated
247 <em>Context</em>.</li>
248 <li>Remove an associated <em>Context</em>.</li>
249 <li>Create and configure a new <em>Default Context</em> associated
250 with this object.</li>
251 <li>Edit the configurable properties of the associated <em>Default
252 Context</em>.</li>
253 <li>Remove the associated <em>Default Context</em>.</li>
254 <li>Create and configure a new <em>Realm</em> associated with
255 this object.</li>
256 <li>Edit the configurable properties of the associated <em>Realm</em>.</li>
257 <li>Remove the associated <em>Realm</em>.</li>
258 <li>Create and configure a new <em>Request Filter</em> associated with
259 this object.</li>
260 <li>Select and edit the configurable properties of an
261 associated <em>Request Filter</em></li>
262 <li>Remove an associated <em>Request Filter</em>.</li>
263 </ul>
264
265</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>
266
267 <p>From the perspective of a particular <em>JDBC Resource</em>, it shall
268 be possible to perform the following administrative operations:</p>
269 <ul>
270 <li>Navigate to the owning <em>Context</em> or <em>Default Context</em>.</li>
271 <li>Edit the configurable properties of this object.</li>
272 </ul>
273
274</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>
275
276 <p>From the perspective of a particular <em>Loader</em>, it shall
277 be possible to perform the following administrative operations:</p>
278 <ul>
279 <li>Navigate to the owning <em>Context</em>.</li>
280 <li>Edit the configurable properties of this object.</li>
281 </ul>
282
283</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>
284
285 <p>From the perspective of a particular <em>Manager</em>, it shall
286 be possible to perform the following administrative operations:</p>
287 <ul>
288 <li>Navigate to the owning <em>Context</em>.</li>
289 <li>Edit the configurable properties of this object.</li>
290 </ul>
291
292</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>
293
294 <p>From the perspective of a particular <em>Realm</em>, it shall
295 be possible to perform the following administrative operations:</p>
296 <ul>
297 <li>Navigate to the owning <em>Engine</em>, <em>Host</em>, or
298 <em>Context</em>.</li>
299 <li>Edit the configurable properties of this object.</li>
300 </ul>
301
302</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>
303
304 <p>From the perspective of a particular <em>Request Filter</em>, it shall
305 be possible to perform the following administrative operations:</p>
306 <ul>
307 <li>Navigate to the owning <em>Engine</em>, <em>Host</em>, or
308 <em>Context</em>.</li>
309 <li>Edit the configurable properties of this object.</li>
310 </ul>
311
312</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>
313
314 <p>From the perspective of the overall <em>Server</em>, it shall be
315 possible to perform the following administrative operations:</p>
316 <ul>
317 <li>Edit the configurable properties of this object.</li>
318 <li>Create and configure a new <em>Service</em> associated with
319 this object.</li>
320 <li>Select and edit the configurable properties of an associated
321 <em>Service</em>.</li>
322 </ul>
323
324</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>
325
326 <p>From the perspective of a particular <em>Service</em>, it shall be
327 possible to perform the following administrative operations:</p>
328 <ul>
329 <li>Navigate to the owning <em>Server</em>.</li>
330 <li>Edit the configurable properties of this object.</li>
331 <li>Create and configure a new <em>Connector</em> associated with
332 this object.</li>
333 <li>Select and edit the configurable properties of an associated
334 <em>Connector</em>.</li>
335 <li>Remove an associated <em>Connector</em>.</li>
336 <li>Create and configure a new <em>Engine</em> associated with
337 this object.</li>
338 <li>Edit the configurable properties of the associated <em>Engine</em>.</li>
339 <li>Remove the associated <em>Engine</em>.</li>
340 </ul>
341
刘洪青6266f992017-05-15 21:21:03 +0800342</blockquote></td></tr></table></td></tr><tr class="noPrint"><td width="20%" valign="top" nowrap class="noPrint"></td><td width="80%" valign="top" align="left"><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="comments_section" id="comments_section"><strong>Comments</strong></a></font></td></tr><tr><td><blockquote><p class="notice"><strong>Notice: </strong>This comments section collects your suggestions
343 on improving documentation for Apache Tomcat.<br><br>
344 If you have trouble and need help, read
345 <a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page
346 and ask your question on the tomcat-users
347 <a href="http://tomcat.apache.org/lists.html">mailing list</a>.
348 Do not ask such questions here. This is not a Q&amp;A section.<br><br>
349 The Apache Comments System is explained <a href="../comments.html">here</a>.
350 Comments may be removed by our moderators if they are either
351 implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
352 var comments_shortname = 'tomcat';
353 var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/funcspecs/fs-admin-opers.html';
354 (function(w, d) {
355 if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {
356 d.write('<div id="comments_thread"><\/div>');
357 var s = d.createElement('script');
358 s.type = 'text/javascript';
359 s.async = true;
360 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
361 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
362 }
363 else {
364 d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>');
365 }
366 })(window, document);
367 //--><!]]></script></blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
368 Copyright &copy; 1999-2017, Apache Software Foundation
Hongqing Liufd5ee812014-05-10 16:32:51 +0800369 </em></font></div></td></tr></table></body></html>