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