craigmcc 02/04/08 11:02:07
Modified: webapps/tomcat-docs manager-howto.xml
Log:
Update the Manager HOW-TO docs for the new "/roles" command.
Revision Changes Path
1.13 +55 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/manager-howto.xml
Index: manager-howto.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/manager-howto.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- manager-howto.xml 14 Mar 2002 22:20:18 -0000 1.12
+++ manager-howto.xml 8 Apr 2002 18:02:07 -0000 1.13
@@ -39,6 +39,7 @@
<li>List the available global JNDI resources, for use in deployment
tools that are preparing <code><ResourceLink></code> elements
nested in a <code><Context></code> deployment description.</li>
+<li>List the available security roles defined in the user database.</li>
<li>Remove an installed web application.</li>
<li>Start a stopped application (thus making it available again).</li>
<li>Stop an existing application (so that it becomes unavailable), but
@@ -487,6 +488,60 @@
</subsection>
+
+
+<subsection name="List Available Security Roles">
+
+<source>
+http://localhost:8080/manager/roles
+</source>
+
+<p>List the security role names (and corresponding descriptions) that are
+available in the <code>org.apache.catalina.UserDatabase</code> resource that
+is linked to the <code>users</code> resource reference in the web.xml file
+for the Manager web application. This would typically be used, for example,
+by a deployment tool that wanted to create
+<code><security-role-ref></code> elements to map security role names
+used in a web application to the role names actually defined within the
+container.</p>
+
+<p>By default, the <code>users</code> resource reference is pointed at the
+global <code>UserDatabase</code> resource. If you choose to utilize a
+different user database per virtual host, you should modify the
+<code><ResourceLink></code> element in the default
+<code>manager.xml</code> context configuration file to point at the global
+user database resource for this virtual host.</p>
+
+<p>When this command is executed, the first line of the response will be:</p>
+<pre>
+ OK - Listed security roles
+</pre>
+<p>followed by one line for each security role. Each line is composed of
+fields delimited by colon characters (":") as follows:</p>
+<ul>
+<li><em>Security Role Name</em> - A security role name that is known to Tomcat
+ in the user database.</li>
+<li><em>Description</em> - Description of this security role (useful in
+ creating user interfaces for selecting roles.</li>
+</ul>
+
+<p>If an error occurs, the response will start with <code>FAIL</code> and
+include an error message. Possible causes for problems include:</p>
+<ul>
+<li><em>Cannot resolve user database reference</em> - A JNDI error prevented
+ the successful lookup of the <code>org.apache.catalina.UserDatabase</code>
+ resource. Check the Tomcat log files for a stack trace associated with
+ this error.</li>
+<li><em>No user database is available</em> - You have not configured a resource
+ reference for the <code>users</code> resource that points at an
+ appropriate user database instance. Check your <code>manager.xml</code>
+ file and ensure that you have created an appropriate
+ <code><ResourceLink></code> or
+ <code><ResourceParams></code> element for this resource.</li>
+</ul>
+
+</subsection>
+
<subsection name="Session Statistics">
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
