You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by kk...@apache.org on 2011/11/10 05:15:34 UTC
svn commit: r1200134 - in /tomcat/tc7.0.x/trunk/webapps/docs: logging.xml
manager-howto.xml maven-jars.xml mbeans-descriptor-howto.xml monitoring.xml
proxy-howto.xml realm-howto.xml
Author: kkolinko
Date: Thu Nov 10 04:15:34 2011
New Revision: 1200134
URL: http://svn.apache.org/viewvc?rev=1200134&view=rev
Log:
Merging r1187809 - Trailing whitespace removal from /webapps
/webapps/docs, 8
Modified:
tomcat/tc7.0.x/trunk/webapps/docs/logging.xml
tomcat/tc7.0.x/trunk/webapps/docs/manager-howto.xml
tomcat/tc7.0.x/trunk/webapps/docs/maven-jars.xml
tomcat/tc7.0.x/trunk/webapps/docs/mbeans-descriptor-howto.xml
tomcat/tc7.0.x/trunk/webapps/docs/monitoring.xml
tomcat/tc7.0.x/trunk/webapps/docs/proxy-howto.xml
tomcat/tc7.0.x/trunk/webapps/docs/realm-howto.xml
Modified: tomcat/tc7.0.x/trunk/webapps/docs/logging.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/logging.xml?rev=1200134&r1=1200133&r2=1200134&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/logging.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/logging.xml Thu Nov 10 04:15:34 2011
@@ -343,7 +343,7 @@ org.apache.catalina.core.ContainerBase.[
#org.apache.catalina.util.LifecycleBase.level = FINE
</source>
</p>
-
+
<p>
Example logging.properties for the servlet-examples web application to be
placed in WEB-INF/classes inside the web application:
@@ -420,7 +420,7 @@ java.util.logging.ConsoleHandler.formatt
</p>
<ol>
- <li>Create a file called <code>log4j.properties</code> with the
+ <li>Create a file called <code>log4j.properties</code> with the
following content and save it into <code>$CATALINA_BASE/lib</code></li>
</ol>
<source>
@@ -473,7 +473,7 @@ log4j.logger.org.apache.catalina.core.Co
INFO, HOST-MANAGER
</source>
<ol start="2">
- <li><a href="http://logging.apache.org/log4j">Download Log4J</a>
+ <li><a href="http://logging.apache.org/log4j">Download Log4J</a>
(v1.2 or later).</li>
<li><p>Download or build <code>tomcat-juli.jar</code> and
@@ -529,10 +529,10 @@ log4j.logger.org.apache.catalina.core.Co
</p>
<p>
- You can (and should) be more picky about which packages to include
+ You can (and should) be more picky about which packages to include
in the logging. Tomcat defines loggers by Engine and Host names.
For example, for a more detailed Catalina localhost log, add this to the
- end of the log4j.properties above. Note that there are known issues with
+ end of the log4j.properties above. Note that there are known issues with
using this naming convention (with square brackets) in log4j XML based
configuration files, so we recommend you use a properties file as
described until a future version of log4j allows this convention.
@@ -550,12 +550,12 @@ log4j.logger.org.apache.catalina.session
</p>
<p>
- Your web applications should certainly use their own log4j configuration.
+ Your web applications should certainly use their own log4j configuration.
This is valid <i>with</i> the above configuration. You would place a
similar log4j.properties file in your web application's WEB-INF/classes
directory, and log4jx.y.z.jar into WEB-INF/lib. Then specify your package
level logging. This is a basic setup of log4j which does *not* require
- Commons-Logging, and you should consult the
+ Commons-Logging, and you should consult the
<a href="http://logging.apache.org/log4j/docs/documentation.html">log4j
documentation</a> for more options. This page is intended only as a
bootstrapping guide.
Modified: tomcat/tc7.0.x/trunk/webapps/docs/manager-howto.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/manager-howto.xml?rev=1200134&r1=1200133&r2=1200134&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/manager-howto.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/manager-howto.xml Thu Nov 10 04:15:34 2011
@@ -172,7 +172,7 @@ an example of restricting access to the
<p>The HTML interface is protected against CSRF but the text and JMX interfaces
are not. To maintain the CSRF protection:</p>
-
+
<ul>
<li>users with the <code>manager-gui</code> role should not be granted either the
<code>manager-script</code> or <code>manager-jmx</code> roles.</li>
@@ -258,8 +258,8 @@ name or the war file name without the .w
application can later be undeployed (and the corresponding application directory
removed) by use of the <code>/undeploy</code> command.</p>
-<p>The .WAR file may include Tomcat specific deployment configuration, by
-including a Context configuration XML file in
+<p>The .WAR file may include Tomcat specific deployment configuration, by
+including a Context configuration XML file in
<code>/META-INF/context.xml</code>.</p>
<p>URL parameters include:</p>
@@ -759,13 +759,13 @@ error message. Possible causes for prob
http://localhost:8080/manager/text/undeploy?path=/examples
</source>
-<p><strong><font color="red">WARNING</font> - This command will delete any web
-application artifacts that exist within <code>appBase</code> directory
+<p><strong><font color="red">WARNING</font> - This command will delete any web
+application artifacts that exist within <code>appBase</code> directory
(typically "webapps") for this virtual host</strong>.
-This will delete the the application .WAR, if present,
-the application directory resulting either from a deploy in unpacked form
+This will delete the the application .WAR, if present,
+the application directory resulting either from a deploy in unpacked form
or from .WAR expansion as well as the XML Context definition from
-<code>$CATALINA_BASE/conf/[enginename]/[hostname]/</code> directory.
+<code>$CATALINA_BASE/conf/[enginename]/[hostname]/</code> directory.
If you simply want to take an application
out of service, you should use the <code>/stop</code> command instead.</p>
@@ -845,29 +845,29 @@ has been reloaded several times, it may
<p>If the command does not succeed, the response will start with
<code>FAIL</code> and include an error message.</p>
-
+
</subsection>
<subsection name="Server Status">
<p>From this link , you can view information about the server.</p>
-<p>First, you have the server and JVM version number, JVM provider, OS name
+<p>First, you have the server and JVM version number, JVM provider, OS name
and number followed by the architecture type.</p>
-<p>Second, there is several information about the memory usage of the JVM
+<p>Second, there is several information about the memory usage of the JVM
(available, total and max memory).</p>
-<p>Then, there is information about the Tomcat AJP and HTTP connectors.
+<p>Then, there is information about the Tomcat AJP and HTTP connectors.
The same information is available for both of them :
</p>
<ul>
- <li><p>Threads information : Max threads, min and max spare threads,
+ <li><p>Threads information : Max threads, min and max spare threads,
current thread count and current thread busy.</p></li>
- <li><p>Request information : Max processing time and processing time,
+ <li><p>Request information : Max processing time and processing time,
request and error count, bytes received and sent.</p></li>
- <li><p>A table showing Stage, Time, Bytes Sent, Bytes Receive, Client,
- VHost and Request. All existing threads are listed in the table.
+ <li><p>A table showing Stage, Time, Bytes Sent, Bytes Receive, Client,
+ VHost and Request. All existing threads are listed in the table.
Here is the list of the possible thread stages :</p>
<ul>
<li><p><em>"Parse and Prepare Request"</em> : The request headers are
@@ -993,8 +993,8 @@ property, and specify it from the comman
<subsection name="Tasks output capture">
<p>Using <em>Ant</em> version <strong>1.6.2</strong> or later,
-the Catalina tasks offer the option to capture their output in
-properties or external files. They support directly the following subset of the
+the Catalina tasks offer the option to capture their output in
+properties or external files. They support directly the following subset of the
<code><redirector></code> type attributes:
</p>
@@ -1091,10 +1091,10 @@ any wrong or missing command attribute w
<p>They also support the embedded <code><redirector></code> element
in which you can specify
-its full set of attributes, but <code>input</code>, <code>inputstring</code> and
+its full set of attributes, but <code>input</code>, <code>inputstring</code> and
<code>inputencoding</code> that, even if accepted, are not used because they have
no meaning in this context.
-Refer to <a href="http://ant.apache.org">ant manual</a> for details on
+Refer to <a href="http://ant.apache.org">ant manual</a> for details on
<code><redirector></code> element attributes.
</p>
@@ -1125,17 +1125,17 @@ can be used:
path="${mgr.context.path}"
war="${mgr.war.file}"/>
</target>
-
+
<target name="context.status">
<property name="running" value="${mgr.context.path}:running"/>
<property name="stopped" value="${mgr.context.path}:stopped"/>
-
+
<list url="${mgr.url}"
outputproperty="ctx.status"
username="${mgr.username}"
password="${mgr.password}">
</list>
-
+
<condition property="context.running">
<contains string="${ctx.status}" substring="${running}"/>
</condition>
Modified: tomcat/tc7.0.x/trunk/webapps/docs/maven-jars.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/maven-jars.xml?rev=1200134&r1=1200133&r2=1200134&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/maven-jars.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/maven-jars.xml Thu Nov 10 04:15:34 2011
@@ -35,10 +35,10 @@
<section name="Using Tomcat libraries With Maven">
<subsection name="Tomcat Snapshots">
- Tomcat snapshots are located in the
+ Tomcat snapshots are located in the
<a href="http://people.apache.org/repo/m2-snapshot-repository/org/apache/tomcat/">Apache Snapshot Repository</a>.
The official URL is <source>http://people.apache.org/repo/m2-snapshot-repository/org/apache/tomcat/</source>
- Snapshots are done periodically, not on a regular basis, but when changes happen and the Tomcat team deems a new snapshot might
+ Snapshots are done periodically, not on a regular basis, but when changes happen and the Tomcat team deems a new snapshot might
useful.
</subsection>
<subsection name="Tomcat Releases">
Modified: tomcat/tc7.0.x/trunk/webapps/docs/mbeans-descriptor-howto.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/mbeans-descriptor-howto.xml?rev=1200134&r1=1200133&r2=1200134&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/mbeans-descriptor-howto.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/mbeans-descriptor-howto.xml Thu Nov 10 04:15:34 2011
@@ -35,20 +35,20 @@
<section name="Introduction">
-<p>Tomcat uses JMX MBeans as the technology for implementing
+<p>Tomcat uses JMX MBeans as the technology for implementing
manageability of Tomcat.</p>
-<p>The descriptions of JMX MBeans for Catalina are in the mbeans-descriptor.xml
+<p>The descriptions of JMX MBeans for Catalina are in the mbeans-descriptor.xml
file in each package.</p>
-<p>You will need to add MBean descriptions for your custom components
+<p>You will need to add MBean descriptions for your custom components
in order to avoid a "ManagedBean is not found" exception.</p>
</section>
<section name="Adding MBean descriptions">
-<p>You may also add MBean descriptions for custom components in
+<p>You may also add MBean descriptions for custom components in
a mbeans-descriptor.xml file, located in the same package as the class files
it describes.</p>
Modified: tomcat/tc7.0.x/trunk/webapps/docs/monitoring.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/monitoring.xml?rev=1200134&r1=1200133&r2=1200134&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/monitoring.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/monitoring.xml Thu Nov 10 04:15:34 2011
@@ -38,8 +38,8 @@
<p>Monitoring is a key aspect of system administration. Looking inside a
running server, obtaining some statistics or reconfiguring some aspects of
- an application are all daily administration tasks.</p>
-
+ an application are all daily administration tasks.</p>
+
</section>
<section name="Enabling JMX Remote">
@@ -89,20 +89,20 @@ controlRole tomcat
<section name="Manage Tomcat with JMX remote Ant Tasks">
<p>To simplify JMX usage with Ant 1.6.x, a set of tasks is provided that may
- be used with antlib.</p>
+ be used with antlib.</p>
<p><b>antlib</b>Copy your catalina-ant.jar from $CATALINA_HOME/lib to $ANT_HOME/lib.</p>
<p>The following example shows the JMX Accessor usage:</p>
<table border="1">
<tr><td><p><pre>
-<project name="Catalina Ant JMX"
- xmlns:jmx="antlib:org.apache.catalina.ant.jmx"
+<project name="Catalina Ant JMX"
+ xmlns:jmx="antlib:org.apache.catalina.ant.jmx"
default="state"
basedir=".">
<property name="jmx.server.name" value="localhost" />
<property name="jmx.server.port" value="9012" />
<property name="cluster.server.address" value="192.168.1.75" />
<property name="cluster.server.port" value="9025" />
-
+
<target name="state" description="Show JMX Cluster state">
<jmx:open
host="${jmx.server.name}"
@@ -110,23 +110,23 @@ controlRole tomcat
username="controlRole"
password="tomcat"/>
<jmx:get
- name="Catalina:type=IDataSender,host=localhost,senderAddress=${cluster.server.address},senderPort=${cluster.server.port}"
+ name="Catalina:type=IDataSender,host=localhost,senderAddress=${cluster.server.address},senderPort=${cluster.server.port}"
attribute="connected"
resultproperty="IDataSender.backup.connected"
echo="false"
/>
<jmx:get
- name="Catalina:type=ClusterSender,host=localhost"
+ name="Catalina:type=ClusterSender,host=localhost"
attribute="senderObjectNames"
resultproperty="senderObjectNames"
echo="false"
/>
<!-- get current maxActiveSession from ClusterTest application
- echo it to Ant output and store at
+ echo it to Ant output and store at
property <em>clustertest.maxActiveSessions.orginal</em>
-->
<jmx:get
- name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
+ name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
attribute="maxActiveSessions"
resultproperty="clustertest.maxActiveSessions.orginal"
echo="true"
@@ -134,7 +134,7 @@ controlRole tomcat
<!-- set maxActiveSession to 100
-->
<jmx:set
- name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
+ name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
attribute="maxActiveSessions"
value="100"
type="int"
@@ -143,7 +143,7 @@ controlRole tomcat
access all session ids directly with Ant property sessions.[0..n].
-->
<jmx:invoke
- name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
+ name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
operation="listSessionIds"
resultproperty="sessions"
echo="false"
@@ -152,19 +152,19 @@ controlRole tomcat
<!-- Access session attribute <em>Hello</em> from first session.
-->
<jmx:invoke
- name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
+ name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
operation="getSessionAttribute"
resultproperty="Hello"
echo="false"
>
<arg value="${sessions.0}"/>
<arg value="Hello"/>
- </jmx:invoke>
+ </jmx:invoke>
<!-- Query for all application manager.of the server from all hosts
and bind all attributes from all found manager MBeans.
-->
<jmx:query
- name="Catalina:type=Manager,*"
+ name="Catalina:type=Manager,*"
resultproperty="manager"
echo="true"
attributebinding="true"
@@ -182,22 +182,22 @@ controlRole tomcat
manager.ClusterTest.0.activeSessions: ${manager.ClusterTest.0.activeSessions}
manager.ClusterTest.0.counterSend_EVT_SESSION_EXPIRED: ${manager.ClusterTest.0.counterSend_EVT_SESSION_EXPIRED}
manager.ClusterTest.0.counterSend_EVT_GET_ALL_SESSIONS: ${manager.ClusterTest.0.counterSend_EVT_GET_ALL_SESSIONS}
- </echo>
+ </echo>
</target>
-
+
</project>
</pre></p>
</td></tr>
</table>
- <p><b>import:</b> Import the JMX Accessor Project with
+ <p><b>import:</b> Import the JMX Accessor Project with
<em><import file="${CATALINA.HOME}/bin/catalina-tasks.xml" /></em> and
reference the tasks with <em>jmxOpen</em>, <em>jmxSet</em>, <em>jmxGet</em>,
<em>jmxQuery</em>, <em>jmxInvoke</em>,<em>jmxEquals</em> and <em>jmxCondition</em>. </p>
</section>
-<!-- Open #########################################################################
+<!-- Open #########################################################################
-->
<section name="JMXAccessorOpenTask - JMX open connection task">
@@ -227,7 +227,7 @@ List of Attributes<br/>
<tr>
<td>port</td>
- <td>Set the remote connection port
+ <td>Set the remote connection port
</td>
<td><code>8050</code></td>
</tr>
@@ -260,7 +260,7 @@ List of Attributes<br/>
</td>
<td><code>false</code></td>
</tr>
-
+
<tr>
<td>if</td>
<td>Only execute if a property of the given name <b>exists</b> in the current project.
@@ -285,42 +285,42 @@ Example to open a new JMX connection<br/
port="${jmx.server.port}"
/>
</source>
-</p>
+</p>
<p>
-Example to open a JMX connection from URL, with authorization and
+Example to open a JMX connection from URL, with authorization and
store at other reference <br/>
<source>
<jmx:open
url="service:jmx:rmi:///jndi/rmi://localhost:9024/jmxrmi"
ref="jmx.server.9024"
username="controlRole"
- password="tomcat"
+ password="tomcat"
/>
</source>
-</p>
+</p>
<p>
-Example to open a JMX connection from URL, with authorization and
-store at other reference, but only when property <em>jmx.if</em> exists and
+Example to open a JMX connection from URL, with authorization and
+store at other reference, but only when property <em>jmx.if</em> exists and
<em>jmx.unless</em> not exists<br/>
<source>
<jmx:open
url="service:jmx:rmi:///jndi/rmi://localhost:9024/jmxrmi"
ref="jmx.server.9024"
username="controlRole"
- password="tomcat"
- if="jmx.if"
- unless="jmx.unless"
+ password="tomcat"
+ if="jmx.if"
+ unless="jmx.unless"
/>
</source>
-</p>
-<p><b>Note</b>: All properties from <em>jmxOpen</em> task also exists at all
-other tasks and conditions.
+</p>
+<p><b>Note</b>: All properties from <em>jmxOpen</em> task also exists at all
+other tasks and conditions.
</p>
</section>
-<!-- Get #########################################################################
+<!-- Get #########################################################################
-->
<section name="JMXAccessorGetTask: get attribute value Ant task">
@@ -371,7 +371,7 @@ List of Attributes<br/>
<tr>
<td>delimiter</td>
- <td>Split result with delimiter (java.util.StringTokenizier)
+ <td>Split result with delimiter (java.util.StringTokenizier)
and use resultproperty as prefix to store tokens.
</td>
<td></td>
@@ -379,8 +379,8 @@ List of Attributes<br/>
<tr>
<td>separatearrayresults</td>
- <td>When return value is an array, save result as property list
- (<em>$resultproperty.[0..N]</em> and <em>$resultproperty.length</em>)
+ <td>When return value is an array, save result as property list
+ (<em>$resultproperty.[0..N]</em> and <em>$resultproperty.length</em>)
</td>
<td><code>true</code></td>
</tr>
@@ -391,17 +391,17 @@ List of Attributes<br/>
Example to get remote MBean attribute from default JMX connection <br/>
<source>
<jmx:get
- name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
+ name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
attribute="maxActiveSessions"
resultproperty="servlets-examples.maxActiveSessions"
/>
</source>
-</p>
+</p>
<p>
Example to get and result array and split it at separate properties<br/>
<source>
<jmx:get
- name="Catalina:type=ClusterSender,host=localhost"
+ name="Catalina:type=ClusterSender,host=localhost"
attribute="senderObjectNames"
resultproperty="senderObjectNames"
/>
@@ -411,7 +411,7 @@ Access the senderObjectNames properties
${senderObjectNames.length} give the number of returned sender list.
${senderObjectNames.[0..N]} found all sender object names
</source>
-</p>
+</p>
<p>
Example to get IDataSender attribute connected only when cluster is configured.
@@ -422,16 +422,16 @@ Example to get IDataSender attribute con
resultproperty="cluster"
/>
<jmx:get
- name="Catalina:type=IDataSender,host=${tomcat.application.host},senderAddress=${cluster.backup.address},senderPort=${cluster.backup.port}"
+ name="Catalina:type=IDataSender,host=${tomcat.application.host},senderAddress=${cluster.backup.address},senderPort=${cluster.backup.port}"
attribute="connected"
resultproperty="datasender.connected"
if="cluster.0.name" />
</source>
-</p>
+</p>
</section>
-<!-- Set #########################################################################
+<!-- Set #########################################################################
-->
<section name="JMXAccessorSetTask: set attribute value Ant task">
@@ -461,7 +461,7 @@ List of Attributes<br/>
<tr>
<td>value</td>
- <td>value that set to attribute
+ <td>value that set to attribute
</td>
<td></td>
</tr>
@@ -493,17 +493,17 @@ List of Attributes<br/>
Example to set remote MBean attribute value<br/>
<source>
<jmx:set
- name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
+ name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
attribute="maxActiveSessions"
value="500"
type="int"
/>
</source>
-</p>
+</p>
</section>
-<!-- Invoke #########################################################################
+<!-- Invoke #########################################################################
-->
<section name="JMXAccessorInvokeTask: invoke MBean operation Ant task">
@@ -526,7 +526,7 @@ List of Attributes<br/>
<tr>
<td>operation</td>
- <td>Existing MBean operation (see Tomcat
+ <td>Existing MBean operation (see Tomcat
<a href="funcspecs/fs-admin-opers.html">funcspecs/fs-admin-opers.html</a>).
</td>
<td></td>
@@ -555,7 +555,7 @@ List of Attributes<br/>
<tr>
<td>delimiter</td>
- <td>Split result with delimiter (java.util.StringTokenizier)
+ <td>Split result with delimiter (java.util.StringTokenizier)
and use resultproperty as prefix to store tokens.
</td>
<td></td>
@@ -563,8 +563,8 @@ List of Attributes<br/>
<tr>
<td>separatearrayresults</td>
- <td>When return value is an array, save result as property list
- (<em>$resultproperty.[0..N]</em> and <em>$resultproperty.length</em>)
+ <td>When return value is an array, save result as property list
+ (<em>$resultproperty.[0..N]</em> and <em>$resultproperty.length</em>)
</td>
<td><code>true</code></td>
</tr>
@@ -575,30 +575,30 @@ List of Attributes<br/>
stop an application <br/>
<source>
<jmx:invoke
- name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
+ name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
operation="stop"/>
</source>
Now you can find the sessionid at <em>${sessions.[0..N}</em> properties and access the count
with ${sessions.length} property.
-</p>
+</p>
<p>
Example to get all sessionids <br/>
<source>
<jmx:invoke
- name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
+ name="Catalina:type=Manager,context=/servlets-examples,host=localhost"
operation="listSessionIds"
resultproperty="sessions"
- delimiter=" "
+ delimiter=" "
/>
</source>
Now you can find the sessionid at <em>${sessions.[0..N}</em> properties and access the count
with ${sessions.length} property.
-</p>
+</p>
<p>
Example to get remote MBean session attribute from session ${sessionid.0}<br/>
<source>
<jmx:invoke
- name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
+ name="Catalina:type=Manager,context=/ClusterTest,host=localhost"
operation="getSessionAttribute"
resultproperty="hello">
<arg value="${sessionid.0}"/>
@@ -610,7 +610,7 @@ Example to get remote MBean session attr
Example to create a new access logger valve at vhost <em>localhost</em>
<source>
<jmx:invoke
- name="Catalina:type=MBeanFactory"
+ name="Catalina:type=MBeanFactory"
operation="createAccessLoggerValve"
resultproperty="accessLoggerObjectName"
>
@@ -619,11 +619,11 @@ Example to create a new access logger va
</source>
Now you can find new MBean with name stored at <em>${accessLoggerObjectName}</em>
property.
-</p>
+</p>
</section>
-<!-- Query #########################################################################
+<!-- Query #########################################################################
-->
<section name="JMXAccessorQueryTask: query MBean Ant task">
@@ -674,7 +674,7 @@ List of Attributes<br/>
<tr>
<td>delimiter</td>
- <td>Split result with delimiter (java.util.StringTokenizier)
+ <td>Split result with delimiter (java.util.StringTokenizier)
and use resultproperty as prefix to store tokens.
</td>
<td></td>
@@ -682,8 +682,8 @@ List of Attributes<br/>
<tr>
<td>separatearrayresults</td>
- <td>When return value is an array, save result as property list
- (<em>$resultproperty.[0..N]</em> and <em>$resultproperty.length</em>)
+ <td>When return value is an array, save result as property list
+ (<em>$resultproperty.[0..N]</em> and <em>$resultproperty.length</em>)
</td>
<td><code>true</code></td>
</tr>
@@ -694,29 +694,29 @@ List of Attributes<br/>
Get all Manager ObjectNames from all services and Hosts <br/>
<source>
<jmx:query
- name="Catalina:type=Manager,*
+ name="Catalina:type=Manager,*
resultproperty="manager" />
</source>
-Now you can find the Session Manager at <em>${manager.[0..N].name}</em>
+Now you can find the Session Manager at <em>${manager.[0..N].name}</em>
properties and access the result object counter with ${manager.length} property.
-</p>
+</p>
<p>
Example to get the Manager from <em>servlet-examples</em> application an bind all MBean properties<br/>
<source>
<jmx:query
- name="Catalina:type=Manager,context=/servlet-examples,host=localhost*"
+ name="Catalina:type=Manager,context=/servlet-examples,host=localhost*"
attributebinding="true"
resultproperty="manager.servletExamples" />
</source>
Now you can find the manager at <em>${manager.servletExamples.0.name}</em> property
and can access all properties from this manager with <em>${manager.servletExamples.0.[manager attribute names]</em>}.
The result object counter from MBeans is stored ad ${manager.length} property.
-</p>
+</p>
<p>
Example to get all MBeans from a server and store inside an external XML property file<br/>
<source>
-<project name="jmx.query"
+<project name="jmx.query"
xmlns:jmx="antlib:org.apache.catalina.ant.jmx"
default="query-all" basedir=".">
<property name="jmx.host" value="localhost"/>
@@ -726,23 +726,23 @@ Example to get all MBeans from a server
<target name="query-all" description="Query all MBeans of a server">
<!-- Configure connection -->
-<jmx:open
+<jmx:open
host="${jmx.host}"
port="${jmx.port}"
ref="jmx.server"
username="${jmx.username}"
password="${jmx.password}"/>
<!-- Query MBean list -->
-<jmx:query
+<jmx:query
name="*:*"
resultproperty="mbeans"
attributebinding="false"/>
-
+
<echoproperties
destfile="mbeans.properties"
prefix="mbeans."
format="xml"/>
-
+
<!-- Print results -->
<echo
message="Number of MBeans in server ${jmx.host}:${jmx.port} is ${mbeans.length}"/>
@@ -750,11 +750,11 @@ Example to get all MBeans from a server
</project>
</source>
Now you can find all MBeans inside the file <em>mbeans.properties</em>.
-</p>
+</p>
</section>
-<!-- Create #########################################################################
+<!-- Create #########################################################################
-->
<section name="JMXAccessorCreateTask: remote create MBean Ant task">
@@ -786,7 +786,7 @@ List of Attributes<br/>
<td>classLoader</td>
<td>ObjectName of server or web application classloader <br/>
( <em>Catalina:type=ServerClassLoader,name=[server,common,shared]</em> or<br/>
- <em>Catalina:type=WebappClassLoader,context=/myapps,host=localhost</em>)
+ <em>Catalina:type=WebappClassLoader,context=/myapps,host=localhost</em>)
</td>
<td></td>
</tr>
@@ -814,11 +814,11 @@ Example to create remote MBean<br/>
ref="${jmx.reference}"
name="Catalina:type=MBeanFactory"
className="org.apache.commons.modeler.BaseModelMBean"
- classLoader="Catalina:type=ServerClassLoader,name=server">
+ classLoader="Catalina:type=ServerClassLoader,name=server">
<Arg value="org.apache.catalina.mbeans.MBeanFactory" />
- </jmx:create>
+ </jmx:create>
</source>
-</p>
+</p>
<p>
<b>Warning</b>: Many Tomcat MBeans can't be linked to their parent once<br/>
created. The Valve, Cluster and Realm MBeans are not automatically<br/>
@@ -828,7 +828,7 @@ Example to create remote MBean<br/>
</section>
-<!-- Unregister #########################################################################
+<!-- Unregister #########################################################################
-->
<section name="JMXAccessorUnregisterTask: remote unregister MBean Ant task">
@@ -869,10 +869,10 @@ List of Attributes<br/>
Example to unregister remote MBean<br/>
<source>
<jmx:unregister
- name="Catalina:type=MBeanFactory"
+ name="Catalina:type=MBeanFactory"
/>
</source>
-</p>
+</p>
<p>
<b>Warning</b>: A lot of Tomcat MBeans can't be unregister.<br/>
The MBeans are not unlinked from their parent. Use <em>MBeanFacrory</em><br/>
@@ -881,7 +881,7 @@ Example to unregister remote MBean<br/>
</section>
-<!-- condition #########################################################################
+<!-- condition #########################################################################
-->
<section name="JMXAccessorCondition: express condition">
@@ -911,7 +911,7 @@ List of Attributes<br/>
<tr>
<td>port</td>
- <td>Set the remote connection port
+ <td>Set the remote connection port
</td>
<td><code>8050</code></td>
</tr>
@@ -982,7 +982,7 @@ List of Attributes<br/>
<tr>
<td>operation</td>
- <td> express one
+ <td> express one
<ul>
<li>== equals</li>
<li>!= not equals</li>
@@ -990,7 +990,7 @@ List of Attributes<br/>
<li>>= greater than or equals (&gt;=)</li>
<li>< lesser than (&lt;)</li>
<li><= lesser than or equals (&lt;=)</li>
- </ul>
+ </ul>
</td>
<td><code>==</code></td>
</tr>
@@ -1006,8 +1006,8 @@ Wait for server connection and that clus
<socket server="${server.name}" port="${server.port}"/>
<http url="${url}"/>
<jmx:condition
- operation="=="
- host="localhost"
+ operation="=="
+ host="localhost"
port="9014"
username="controlRole"
password="tomcat"
@@ -1021,11 +1021,11 @@ Wait for server connection and that clus
<echo message="Server ${url} alive" />
</target>
</source>
-</p>
+</p>
</section>
-<!-- Equals #########################################################################
+<!-- Equals #########################################################################
-->
<section name="JMXAccessorEqualsCondition: equals MBean Ant condition">
@@ -1055,7 +1055,7 @@ List of Attributes<br/>
<tr>
<td>port</td>
- <td>Set the remote connection port
+ <td>Set the remote connection port
</td>
<td><code>8050</code></td>
</tr>
@@ -1107,8 +1107,8 @@ Wait for server connection and that clus
<and>
<socket server="${server.name}" port="${server.port}"/>
<http url="${url}"/>
- <jmx:equals
- host="localhost"
+ <jmx:equals
+ host="localhost"
port="9014"
username="controlRole"
password="tomcat"
@@ -1122,7 +1122,7 @@ Wait for server connection and that clus
<echo message="Server ${url} alive" />
</target>
</source>
-</p>
+</p>
</section>
Modified: tomcat/tc7.0.x/trunk/webapps/docs/proxy-howto.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/proxy-howto.xml?rev=1200134&r1=1200133&r2=1200134&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/proxy-howto.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/proxy-howto.xml Thu Nov 10 04:15:34 2011
@@ -137,7 +137,7 @@ ProxyPassReverse /myapp http://localho
<p>When requests are proxied in this manner, <strong>all</strong> requests
for the configured web applications will be processed by Tomcat (including
requests for static content). You can improve performance by using the
-<code>mod_jk</code> web connector instead of <code>mod_proxy</code>.
+<code>mod_jk</code> web connector instead of <code>mod_proxy</code>.
<code>mod_jk</code> can be configured so that the web server serves static
content that is not processed by filters or security constraints defined
within the web application's deployment descriptor
Modified: tomcat/tc7.0.x/trunk/webapps/docs/realm-howto.xml
URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/realm-howto.xml?rev=1200134&r1=1200133&r2=1200134&view=diff
==============================================================================
--- tomcat/tc7.0.x/trunk/webapps/docs/realm-howto.xml (original)
+++ tomcat/tc7.0.x/trunk/webapps/docs/realm-howto.xml Thu Nov 10 04:15:34 2011
@@ -128,7 +128,7 @@ configuration file, that looks something
... other attributes for this implementation .../>
</source>
-<p>The <code><Realm></code> element can be nested inside any one of
+<p>The <code><Realm></code> element can be nested inside any one of
of the following <code>Container</code> elements. The location of the
Realm element has a direct impact on the "scope" of that Realm
(i.e. which web applications will share the same authentication information):
@@ -204,7 +204,7 @@ techniques are supported:</p>
<p>If using digested passwords with DIGEST authentication, the cleartext used
to generate the digest is different. In the examples above
- <code>{cleartext-password}</code> must be replaced with
+ <code>{cleartext-password}</code> must be replaced with
<code>{username}:{realm}:{cleartext-password}</code>. For example, in a
development environment this might take the form
<code>testUser:Authentication required:testPassword</code>. The value for
@@ -402,7 +402,7 @@ as your database structure conforms to t
<li>Password to be recognized by Tomcat when the user logs in.
This value may in cleartext or digested - see below for more
information.</li>
- </ul></li>
+ </ul></li>
<li>There must be a table, referenced below as the <em>user roles</em> table,
that contains one row for every valid role that is assigned to a
particular user. It is legal for a user to have zero, one, or more than
@@ -417,9 +417,9 @@ as your database structure conforms to t
</ul>
<h3>Quick Start</h3>
-
+
<p>To set up Tomcat to use DataSourceRealm, you will need to follow these steps:</p>
-<ol>
+<ol>
<li>If you have not yet done so, create tables and columns in your database
that conform to the requirements described above.</li>
<li>Configure a database username and password for use by Tomcat, that has
@@ -1038,10 +1038,10 @@ integration with the CMA as implemented
you will need to follow these steps:</p>
<ol>
<li>Write your own LoginModule, User and Role classes based
-on JAAS (see
+on JAAS (see
<a href="http://download.oracle.com/javase/1.4.2/docs/guide/security/jaas/tutorials/GeneralAcnOnly.html">the
-JAAS Authentication Tutorial</a> and
-<a href="http://download.oracle.com/javase/1.4.2/docs/guide/security/jaas/JAASLMDevGuide.html">the JAAS Login Module
+JAAS Authentication Tutorial</a> and
+<a href="http://download.oracle.com/javase/1.4.2/docs/guide/security/jaas/JAASLMDevGuide.html">the JAAS Login Module
Developer's Guide</a>) to be managed by the JAAS Login
Context (<code>javax.security.auth.login.LoginContext</code>)
When developing your LoginModule, note that JAASRealm's built-in <code>CallbackHandler</code>
@@ -1068,7 +1068,7 @@ the resources you want to protect</li>
</ol>
<h3>Realm Element Attributes</h3>
<p>To configure JAASRealm as for step 6 above, you create
-a <code><Realm></code> element and nest it in your
+a <code><Realm></code> element and nest it in your
<code>$CATALINA_BASE/conf/server.xml</code>
file within your <code><Engine></code> node. The attributes for the
JAASRealm are defined in the <a href="config/realm.html">Realm</a>
@@ -1079,25 +1079,25 @@ configuration documentation.</p>
<p>Here is an example of how your server.xml snippet should look.</p>
<source>
-<Realm className="org.apache.catalina.realm.JAASRealm"
- appName="MyFooRealm"
- userClassNames="org.foobar.realm.FooUser"
+<Realm className="org.apache.catalina.realm.JAASRealm"
+ appName="MyFooRealm"
+ userClassNames="org.foobar.realm.FooUser"
roleClassNames="org.foobar.realm.FooRole"/>
</source>
-<p>It is the responsibility of your login module to create and save User and
-Role objects representing Principals for the user
-(<code>javax.security.auth.Subject</code>). If your login module doesn't
-create a user object but also doesn't throw a login exception, then the
-Tomcat CMA will break and you will be left at the
-http://localhost:8080/myapp/j_security_check URI or at some other
+<p>It is the responsibility of your login module to create and save User and
+Role objects representing Principals for the user
+(<code>javax.security.auth.Subject</code>). If your login module doesn't
+create a user object but also doesn't throw a login exception, then the
+Tomcat CMA will break and you will be left at the
+http://localhost:8080/myapp/j_security_check URI or at some other
unspecified location.</p>
<p>The flexibility of the JAAS approach is two-fold: </p>
<ul>
<li>you can carry out whatever processing you require behind
the scenes in your own login module.</li>
- <li>you can plug in a completely different LoginModule by changing the configuration
+ <li>you can plug in a completely different LoginModule by changing the configuration
and restarting the server, without any code changes to your application.</li>
</ul>
@@ -1118,7 +1118,7 @@ and restarting the server, without any c
<li>As with other <code>Realm</code> implementations, digested passwords
are supported if the <code><Realm></code> element in <code>server.xml</code>
contains a <code>digest</code> attribute; JAASRealm's <code>CallbackHandler</code>
- will digest the password prior to passing it back to the <code>LoginModule</code></li>
+ will digest the password prior to passing it back to the <code>LoginModule</code></li>
</ul>
</subsection>
@@ -1149,7 +1149,7 @@ and restarting the server, without any c
file within your <code><Engine></code> or <code><Host></code>.
You can also nest inside a <code><Context></code> node in a
<code>context.xml</code> file.</p>
-
+
<h3>Example</h3>
<p>Here is an example of how your server.xml snippet should look to use a
@@ -1176,10 +1176,10 @@ UserDatabase Realm and a DataSource Real
<code>Realm</code> interface that extends the CombinedRealm to provide lock
out functionality to provide a user lock out mechanism if there are too many
failed authentication attempts in a given period of time.</p>
-
+
<p>To ensure correct operation, there is a reasonable degree of
synchronisation in this Realm.</p>
-
+
<p>This Realm does not require modification to the underlying Realms or the
associated user storage mecahisms. It achieves this by recording all failed
logins, including those for users that do not exist. To prevent a DOS by
@@ -1201,7 +1201,7 @@ UserDatabase Realm and a DataSource Real
<code>context.xml</code> file. The attributes for the
LockOutRealm are defined in the <a href="config/realm.html">Realm</a>
configuration documentation.</p>
-
+
<h3>Example</h3>
<p>Here is an example of how your server.xml snippet should look to add lock out
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org