1 | <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Catalina Functional Specifications - Administrative Apps - Supported Operations</title><meta value="Craig 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 | Catalina Functional Specifications |
---|
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">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 align="left" valign="top" width="80%"><table cellspacing="4" width="100%" border="0"><tr><td valign="top" align="left"><h1>Catalina Functional Specifications</h1><h2>Administrative Apps - Supported Operations</h2></td><td nowrap="true" valign="top" align="right"><small><a href="printer/fs-admin-opers.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="Supported Operations Overview"><strong>Supported Operations Overview</strong></a></font></td></tr><tr><td><blockquote> |
---|
5 | |
---|
6 | <p>This document defines the <em>Supported Operations</em> that may |
---|
7 | be performed against the <a href="fs-admin-objects.html">Administered |
---|
8 | Objects</a> that are supported by Tomcat 6 administrative applications. |
---|
9 | Not all operations are required to be available through every administrative |
---|
10 | application that is implemented. However, if a given operation is available, |
---|
11 | it should operate consistently with the descriptions found here.</p> |
---|
12 | |
---|
13 | <p>Supported Operations are described for the following Administered |
---|
14 | Objects:</p> |
---|
15 | <ul> |
---|
16 | <li><a href="#Access Logger">Access Logger</a></li> |
---|
17 | <li><a href="#Connector">Connector</a></li> |
---|
18 | <li><a href="#Context">Context</a></li> |
---|
19 | <li><a href="#Default Context">Default Context</a></li> |
---|
20 | <li><a href="#Engine">Engine</a></li> |
---|
21 | <li><a href="#Environment Entry">Environment Entry</a></li> |
---|
22 | <li><a href="#Host">Host</a></li> |
---|
23 | <li><a href="#JDBC Resource">JDBC Resource</a></li> |
---|
24 | <li><a href="#Loader">Loader</a></li> |
---|
25 | <li><a href="#Manager">Manager</a></li> |
---|
26 | <li><a href="#Realm">Realm</a></li> |
---|
27 | <li><a href="#Request Filter">Request Filter</a></li> |
---|
28 | <li><a href="#Server">Server</a></li> |
---|
29 | <li><a href="#Service">Service</a></li> |
---|
30 | </ul> |
---|
31 | |
---|
32 | </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 Logger"><strong>Access Logger</strong></a></font></td></tr><tr><td><blockquote> |
---|
33 | |
---|
34 | <p>From the perspective of a particular <em>Access Logger</em>, it shall |
---|
35 | be possible to perform the following administrative operations:</p> |
---|
36 | <ul> |
---|
37 | <li>Navigate to the owning <em>Engine</em>, <em>Host</em>, or |
---|
38 | <em>Context</em>.</li> |
---|
39 | <li>Edit the configurable properties of this object.</li> |
---|
40 | </ul> |
---|
41 | |
---|
42 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Connector"><strong>Connector</strong></a></font></td></tr><tr><td><blockquote> |
---|
43 | |
---|
44 | <p>From the perspective of a particular <em>Connector</em>, it shall be |
---|
45 | possible to perform the following administrative operations:</p> |
---|
46 | <ul> |
---|
47 | <li>Navigate to the owning <em>Service</em>.</li> |
---|
48 | <li>Edit the configurable properties of this object.</li> |
---|
49 | </ul> |
---|
50 | |
---|
51 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Context"><strong>Context</strong></a></font></td></tr><tr><td><blockquote> |
---|
52 | |
---|
53 | <p>From the perspective of a particular <em>Context</em>, it shall be |
---|
54 | possible to perform the following administrative operations:</p> |
---|
55 | <ul> |
---|
56 | <li>Navigate to the owning <em>Host</em>.</li> |
---|
57 | <li>Edit the configurable properties of this object.</li> |
---|
58 | <li>Create and configure a new <em>Access Logger</em> associated |
---|
59 | with this object.</li> |
---|
60 | <li>Edit the configurable properties of the associated <em>Access |
---|
61 | Logger</em>.</li> |
---|
62 | <li>Remove the associated <em>Access Logger</em>.</li> |
---|
63 | <li>Create and configure a new <em>Environment Entry</em> associated |
---|
64 | with this object.</li> |
---|
65 | <li>Select and edit the configurable properties of an associated |
---|
66 | <em>Environment Entry</em>.</li> |
---|
67 | <li>Remove an associated <em>Environment Entry</em>.</li> |
---|
68 | <li>Create and configure a new <em>JDBC Resource</em> associated |
---|
69 | with this object.</li> |
---|
70 | <li>Select and edit the configurable properties of an associated |
---|
71 | <em>JDBC Resource</em>.</li> |
---|
72 | <li>Remove an associated <em>JDBC Resource</em>.</li> |
---|
73 | <li>Create and configure a new <em>Loader</em> associated with |
---|
74 | this object.</li> |
---|
75 | <li>Edit the configurable properties of the associated <em>Loader</em>.</li> |
---|
76 | <li>Remove the associated <em>Loader</em>.</li> |
---|
77 | <li>Create and configure a new <em>Manager</em> associated with |
---|
78 | this object.</li> |
---|
79 | <li>Edit the configurable properties of the associated <em>Manager</em>.</li> |
---|
80 | <li>Remove the associated <em>Manager</em>.</li> |
---|
81 | <li>Create and configure a new <em>Realm</em> associated with |
---|
82 | this object.</li> |
---|
83 | <li>Edit the configurable properties of the associated <em>Realm</em>.</li> |
---|
84 | <li>Remove the associated <em>Realm</em>.</li> |
---|
85 | <li>Create and configure a new <em>Request Filter</em> associated with |
---|
86 | this object.</li> |
---|
87 | <li>Select and edit the configurable properties of an |
---|
88 | associated <em>Request Filter</em></li> |
---|
89 | <li>Remove an associated <em>Request Filter</em>.</li> |
---|
90 | </ul> |
---|
91 | |
---|
92 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Default Context"><strong>Default Context</strong></a></font></td></tr><tr><td><blockquote> |
---|
93 | |
---|
94 | <p>From the perspective of a particular <em>Default Context</em>, it shall |
---|
95 | be possible to perform the following administrative operations:</p> |
---|
96 | <ul> |
---|
97 | <li>Navigate to the owning <em>Engine</em> or <em>Host</em>.</li> |
---|
98 | <li>Edit the configurable properties of this object.</li> |
---|
99 | <li>Create and configure a new <em>Environment Entry</em> associated |
---|
100 | with this object.</li> |
---|
101 | <li>Select and edit the configurable properties of an associated |
---|
102 | <em>Environment Entry</em>.</li> |
---|
103 | <li>Remove an associated <em>Environment Entry</em>.</li> |
---|
104 | <li>Create and configure a new <em>JDBC Resource</em> associated |
---|
105 | with this object.</li> |
---|
106 | <li>Select and edit the configurable properties of an associated |
---|
107 | <em>JDBC Resource</em>.</li> |
---|
108 | <li>Remove an associated <em>JDBC Resource</em>.</li> |
---|
109 | </ul> |
---|
110 | |
---|
111 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Engine"><strong>Engine</strong></a></font></td></tr><tr><td><blockquote> |
---|
112 | |
---|
113 | <p>From the perspective of a particular <em>Engine</em>, it shall be |
---|
114 | possible to perform the following administrative operations:</p> |
---|
115 | <ul> |
---|
116 | <li>Navigate to the owning <em>Service</em>.</li> |
---|
117 | <li>Edit the configurable properties of this object.</li> |
---|
118 | <li>Create and configure a new <em>Access Logger</em> associated |
---|
119 | with this object.</li> |
---|
120 | <li>Edit the configurable properties of the associated <em>Access |
---|
121 | Logger</em>.</li> |
---|
122 | <li>Remove the associated <em>Access Logger</em>.</li> |
---|
123 | <li>Create and configure a new <em>Default Context</em> associated |
---|
124 | with this object.</li> |
---|
125 | <li>Edit the configurable properties of the associated <em>Default |
---|
126 | Context</em>.</li> |
---|
127 | <li>Remove the associated <em>Default Context</em>.</li> |
---|
128 | <li>Create and configure a new <em>Host</em> associated with |
---|
129 | this object.</li> |
---|
130 | <li>Select and edit the configurable properties of an |
---|
131 | associated <em>Host</em>.</li> |
---|
132 | <li>Remove an associated <em>Host</em>.</li> |
---|
133 | <li>Create and configure a new <em>Realm</em> associated with |
---|
134 | this object.</li> |
---|
135 | <li>Edit the configurable properties of the associated <em>Realm</em>.</li> |
---|
136 | <li>Remove the associated <em>Realm</em>.</li> |
---|
137 | <li>Create and configure a new <em>Request Filter</em> associated with |
---|
138 | this object.</li> |
---|
139 | <li>Select and edit the configurable properties of an |
---|
140 | associated <em>Request Filter</em></li> |
---|
141 | <li>Remove an associated <em>Request Filter</em>.</li> |
---|
142 | </ul> |
---|
143 | |
---|
144 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Environment Entry"><strong>Environment Entry</strong></a></font></td></tr><tr><td><blockquote> |
---|
145 | |
---|
146 | <p>From the perspective of a particular <em>Environment Entry</em>, it shall |
---|
147 | be possible to perform the following administrative operations:</p> |
---|
148 | <ul> |
---|
149 | <li>Navigate to the owning <em>Context</em> or <em>Default Context</em>.</li> |
---|
150 | <li>Edit the configurable properties of this object.</li> |
---|
151 | </ul> |
---|
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="Host"><strong>Host</strong></a></font></td></tr><tr><td><blockquote> |
---|
154 | |
---|
155 | <p>From the perspective of a particular <em>Host</em>, it shall be |
---|
156 | possible to perform the following administrative operations:</p> |
---|
157 | <ul> |
---|
158 | <li>Navigate to the owning <em>Engine</em>.</li> |
---|
159 | <li>Edit the configurable properties of this object.</li> |
---|
160 | <li>Create and configure a new <em>Access Logger</em> associated |
---|
161 | with this object.</li> |
---|
162 | <li>Edit the configurable properties of the associated <em>Access |
---|
163 | Logger</em>.</li> |
---|
164 | <li>Remove the associated <em>Access Logger</em>.</li> |
---|
165 | <li>Create and configure a new <em>Context</em> associated with |
---|
166 | this object.</li> |
---|
167 | <li>Select and edit the configurable properties of an associated |
---|
168 | <em>Context</em>.</li> |
---|
169 | <li>Remove an associated <em>Context</em>.</li> |
---|
170 | <li>Create and configure a new <em>Default Context</em> associated |
---|
171 | with this object.</li> |
---|
172 | <li>Edit the configurable properties of the associated <em>Default |
---|
173 | Context</em>.</li> |
---|
174 | <li>Remove the associated <em>Default Context</em>.</li> |
---|
175 | <li>Create and configure a new <em>Realm</em> associated with |
---|
176 | this object.</li> |
---|
177 | <li>Edit the configurable properties of the associated <em>Realm</em>.</li> |
---|
178 | <li>Remove the associated <em>Realm</em>.</li> |
---|
179 | <li>Create and configure a new <em>Request Filter</em> associated with |
---|
180 | this object.</li> |
---|
181 | <li>Select and edit the configurable properties of an |
---|
182 | associated <em>Request Filter</em></li> |
---|
183 | <li>Remove an associated <em>Request Filter</em>.</li> |
---|
184 | </ul> |
---|
185 | |
---|
186 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="JDBC Resource"><strong>JDBC Resource</strong></a></font></td></tr><tr><td><blockquote> |
---|
187 | |
---|
188 | <p>From the perspective of a particular <em>JDBC Resource</em>, it shall |
---|
189 | be possible to perform the following administrative operations:</p> |
---|
190 | <ul> |
---|
191 | <li>Navigate to the owning <em>Context</em> or <em>Default Context</em>.</li> |
---|
192 | <li>Edit the configurable properties of this object.</li> |
---|
193 | </ul> |
---|
194 | |
---|
195 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Loader"><strong>Loader</strong></a></font></td></tr><tr><td><blockquote> |
---|
196 | |
---|
197 | <p>From the perspective of a particular <em>Loader</em>, it shall |
---|
198 | be possible to perform the following administrative operations:</p> |
---|
199 | <ul> |
---|
200 | <li>Navigate to the owning <em>Context</em>.</li> |
---|
201 | <li>Edit the configurable properties of this object.</li> |
---|
202 | </ul> |
---|
203 | |
---|
204 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Manager"><strong>Manager</strong></a></font></td></tr><tr><td><blockquote> |
---|
205 | |
---|
206 | <p>From the perspective of a particular <em>Manager</em>, it shall |
---|
207 | be possible to perform the following administrative operations:</p> |
---|
208 | <ul> |
---|
209 | <li>Navigate to the owning <em>Context</em>.</li> |
---|
210 | <li>Edit the configurable properties of this object.</li> |
---|
211 | </ul> |
---|
212 | |
---|
213 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Realm"><strong>Realm</strong></a></font></td></tr><tr><td><blockquote> |
---|
214 | |
---|
215 | <p>From the perspective of a particular <em>Realm</em>, it shall |
---|
216 | be possible to perform the following administrative operations:</p> |
---|
217 | <ul> |
---|
218 | <li>Navigate to the owning <em>Engine</em>, <em>Host</em>, or |
---|
219 | <em>Context</em>.</li> |
---|
220 | <li>Edit the configurable properties of this object.</li> |
---|
221 | </ul> |
---|
222 | |
---|
223 | </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 Filter"><strong>Request Filter</strong></a></font></td></tr><tr><td><blockquote> |
---|
224 | |
---|
225 | <p>From the perspective of a particular <em>Request Filter</em>, it shall |
---|
226 | be possible to perform the following administrative operations:</p> |
---|
227 | <ul> |
---|
228 | <li>Navigate to the owning <em>Engine</em>, <em>Host</em>, or |
---|
229 | <em>Context</em>.</li> |
---|
230 | <li>Edit the configurable properties of this object.</li> |
---|
231 | </ul> |
---|
232 | |
---|
233 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Server"><strong>Server</strong></a></font></td></tr><tr><td><blockquote> |
---|
234 | |
---|
235 | <p>From the perspective of the overall <em>Server</em>, it shall be |
---|
236 | possible to perform the following administrative operations:</p> |
---|
237 | <ul> |
---|
238 | <li>Edit the configurable properties of this object.</li> |
---|
239 | <li>Create and configure a new <em>Service</em> associated with |
---|
240 | this object.</li> |
---|
241 | <li>Select and edit the configurable properties of an associated |
---|
242 | <em>Service</em>.</li> |
---|
243 | </ul> |
---|
244 | |
---|
245 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Service"><strong>Service</strong></a></font></td></tr><tr><td><blockquote> |
---|
246 | |
---|
247 | <p>From the perspective of a particular <em>Service</em>, it shall be |
---|
248 | possible to perform the following administrative operations:</p> |
---|
249 | <ul> |
---|
250 | <li>Navigate to the owning <em>Server</em>.</li> |
---|
251 | <li>Edit the configurable properties of this object.</li> |
---|
252 | <li>Create and configure a new <em>Connector</em> associated with |
---|
253 | this object.</li> |
---|
254 | <li>Select and edit the configurable properties of an associated |
---|
255 | <em>Connector</em>.</li> |
---|
256 | <li>Remove an associated <em>Connector</em>.</li> |
---|
257 | <li>Create and configure a new <em>Engine</em> associated with |
---|
258 | this object.</li> |
---|
259 | <li>Edit the configurable properties of the associated <em>Engine</em>.</li> |
---|
260 | <li>Remove the associated <em>Engine</em>.</li> |
---|
261 | </ul> |
---|
262 | |
---|
263 | </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> |
---|
264 | Copyright © 1999-2008, Apache Software Foundation |
---|
265 | </em></font></div></td></tr></table></body></html> |
---|