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