8:56 a.m.
Author: remy.maucherat(a)jboss.com
Date: 2008-03-18 09:56:10 -0400 (Tue, 18 Mar 2008)
New Revision: 528
Modified:
trunk/webapps/docs/index.xml
trunk/webapps/docs/manager-howto.xml
trunk/webapps/docs/ssl-howto.xml
trunk/webapps/docs/tomcat-docs.xsl
Log:
- Some style fixes.
Modified: trunk/webapps/docs/index.xml
===================================================================
--- trunk/webapps/docs/index.xml 2008-03-18 02:33:16 UTC (rev 527)
+++ trunk/webapps/docs/index.xml 2008-03-18 13:56:10 UTC (rev 528)
@@ -42,6 +42,8 @@
brief, high level, overview of JBoss Web.</li>
<li><a
href="setup.html"><strong>Setup</strong></a> - How to
install and run
JBoss Web on a variety of platforms.</li>
+<li><a href="sysprops.html"><strong>System
Properties</strong></a> - System
+ properties used for JBoss Web configuration.</li>
<li><a href="appdev/index.html"><strong>First web
application</strong></a>
- An introduction to the concepts of a <em>web application</em> as
defined
in the <a
href="http://java.sun.com/products/servlet/download.html">Se...
@@ -80,10 +82,14 @@
Installing and
configuring SSL support so that your JBoss Web will serve requests using
the <code>https</code> protocol.</li>
+<li><a href="php.html"><strong>PHP</strong></a>
-
+ Using PHPs with JBoss Web.</li>
<li><a
href="ssi-howto.html"><strong>SSI</strong></a> -
Using Server Side Includes in JBoss Web.</li>
<li><a
href="cgi-howto.html"><strong>CGI</strong></a> -
Using CGIs with JBoss Web.</li>
+<li><a href="rewrite.html"><strong>URL
Rewriting</strong></a> -
+ Using rewriting features in JBoss Web.</li>
<li><a href="proxy-howto.html"><strong>Proxy
Support</strong></a> -
Configuring JBoss Web to run behind a proxy server (or a web server
functioning as a proxy server).</li>
Modified: trunk/webapps/docs/manager-howto.xml
===================================================================
--- trunk/webapps/docs/manager-howto.xml 2008-03-18 02:33:16 UTC (rev 527)
+++ trunk/webapps/docs/manager-howto.xml 2008-03-18 13:56:10 UTC (rev 528)
@@ -916,8 +916,7 @@
<code><taskdef></code> element. Therefore, your
<code>build.xml</code>
file might look something like this:</p>
-<table border="1">
-<tr><td><pre>
+<source>
<project name="My Application" default="compile"
basedir=".">
<!-- Configure the directory into which the web application is built -->
@@ -965,8 +964,7 @@
</target>
</project>
-</pre></td></tr>
-</table>
+</source>
<p>Now, you can execute commands like <code>ant deploy</code> to deploy
the
application to a running instance of JBoss Web, or <code>ant reload</code>
to
@@ -988,97 +986,70 @@
<code><redirector></code> type attributes:
</p>
-<table border="1" cellpadding="2" cellspacing="0">
-<tbody>
-<tr>
-<td valign="top"><b>Attribute</b></td>
-<td valign="top"><b>Description</b></td>
-<td align="center"
valign="top"><b>Required</b></td>
-</tr>
-<tr>
-<td valign="top">output</td>
-<td valign="top">Name of a file to which to write the output. If
+ <attributes>
+
+ <attribute name="output" required="false">
+ <p>Name of a file to which to write the output. If
the error stream is not also redirected to a file or property, it will
-appear in this output.</td>
-<td align="center" valign="top">No</td>
-</tr>
-<tr>
-<td valign="top">error</td>
-<td valign="top">The file to which the standard error of the
-command should be redirected.</td>
-<td align="center" valign="top">No</td>
-</tr>
-<tr>
-<td valign="top">logError</td>
-<td valign="top">This attribute is used when you wish to see
+appear in this output.</p>
+ </attribute>
+
+ <attribute name="error" required="false">
+ <p>The file to which the standard error of the
+command should be redirected.</p>
+ </attribute>
+
+ <attribute name="logError" required="false">
+ <p>This attribute is used when you wish to see
error output in Ant's log and you are redirecting output to a
file/property. The error output will not be included in the output
file/property. If you redirect error with the <i>error</i> or
<i>errorProperty</i>
-attributes, this will have no effect.</td>
-<td align="center" valign="top">No</td>
-</tr>
-<tr>
-<td valign="top">append</td>
-<td valign="top">Whether output and error files should be
-appended to or overwritten. Defaults to <code>false</code>.</td>
-<td align="center" valign="top">No</td>
-</tr>
-<tr>
-<td valign="top">createemptyfiles</td>
-<td valign="top">Whether output and error files should be created
-even when empty. Defaults to <code>true</code>.</td>
-<td align="center" valign="top">No</td>
-</tr>
-<tr>
-<td valign="top">outputproperty</td>
-<td valign="top">The name of a property in which the output of
+attributes, this will have no effect.</p>
+ </attribute>
+
+ <attribute name="append" required="false">
+ <p>Whether output and error files should be
+appended to or overwritten. Defaults to <code>false</code>.
+ </p>
+ </attribute>
+
+ <attribute name="createemptyfiles" required="false">
+ <p>Whether output and error files should be created
+even when empty. Defaults to <code>true</code>.</p>
+ </attribute>
+
+ <attribute name="outputproperty" required="false">
+ <p>The name of a property in which the output of
the command should be stored. Unless the error stream is redirected to
-a separate file or stream, this property will include the error output.</td>
-<td align="center" valign="top">No</td>
-</tr>
-<tr>
-<td valign="top">errorproperty</td>
-<td valign="top">The name of a property in which the standard
-error of the command should be stored.</td>
-<td align="center" valign="top">No</td>
-</tr>
-</tbody>
-</table>
+a separate file or stream, this property will include the error output.</p>
+ </attribute>
-<p>A couple of additional attributes can also be specified:
-</p>
-<table border="1" cellpadding="2" cellspacing="0">
-<tbody>
-<tr>
-<td valign="top"><b>Attribute</b></td>
-<td valign="top"><b>Description</b></td>
-<td align="center"
valign="top"><b>Required</b></td>
-</tr>
-<tr>
-<td valign="top">alwaysLog</td>
-<td valign="top">This attribute is used when you wish to see the
+ <attribute name="errorproperty" required="false">
+ <p>The name of a property in which the standard
+error of the command should be stored.</p>
+ </attribute>
+
+ <attribute name="alwaysLog" required="false">
+ <p>This attribute is used when you wish to see the
output you are capturing, appearing also in the Ant's log. It must not be
used unless you are capturing task output.
Defaults to <code>false</code>.
<em>This attribute will be supported directly by
<code><redirector></code>
-in Ant 1.6.3</em></td>
-<td align="center" valign="top">No</td>
-</tr>
-<tr>
-<td valign="top">failonerror</td>
-<td valign="top">This attribute is used when you wish to avoid that
+in Ant 1.6.3</em></p>
+ </attribute>
+
+ <attribute name="failonerror" required="false">
+ <p>This attribute is used when you wish to avoid that
any manager command processing error terminates the ant execution. Defaults to
<code>true</code>.
It must be set to <code>false</code>, if you want to capture error output,
otherwise execution will terminate before anything can be captured.
<br></br>
This attribute acts only on manager command execution,
-any wrong or missing command attribute will still cause Ant execution termination.
-</td>
-<td align="center" valign="top">No</td>
-</tr>
-</tbody>
-</table>
+any wrong or missing command attribute will still cause Ant execution
termination.</p>
+ </attribute>
+ </attributes>
+
<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
@@ -1093,8 +1064,7 @@
can be used:
</p>
-<table border="1">
-<tr><td><pre>
+<source>
<target name="manager.deploy"
depends="context.status"
if="context.notInstalled">
@@ -1158,8 +1128,7 @@
</or>
</condition>
</target>
-</pre></td></tr>
-</table>
+</source>
<p><strong>WARNING:</strong> even if it doesn't make many sense,
and is always a bad idea,
calling a Catalina task more than once,
@@ -1241,8 +1210,7 @@
shown. For example, lets say we wish to turn up debugging on the fly for the
<code>ErrorReportValve</code>. The following will set debugging to 10.
<source>
-http://localhost:8080/manager/jmxproxy/
-?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost&att=debug&val=10
+http://localhost:8080/manager/jmxproxy/?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost&att=debug&val=10
</source>
and my result is (YMMV):
<source>
@@ -1252,8 +1220,7 @@
Here is what I see if I pass in a bad value. Here is the URL I used,
I try set debugging equal to 'cowbell':
<source>
-http://localhost:8080/manager/jmxproxy/
-?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost&att=debug&val=cowbell
+http://localhost:8080/manager/jmxproxy/?set=Catalina%3Atype%3DValve%2Cname%3DErrorReportValve%2Chost%3Dlocalhost&att=debug&val=cowbell
</source>
When I try that, my result is
<source>
Modified: trunk/webapps/docs/ssl-howto.xml
===================================================================
--- trunk/webapps/docs/ssl-howto.xml 2008-03-18 02:33:16 UTC (rev 527)
+++ trunk/webapps/docs/ssl-howto.xml 2008-03-18 13:56:10 UTC (rev 528)
@@ -394,93 +394,74 @@
You may need to add or change the following attribute
values, depending on how you configured your keystore earlier:</p>
-<table border="1">
- <tr>
- <th>Attribute</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><code>clientAuth</code></td>
- <td>Set this value to <code>true</code> if you want JBoss Web to
require
- all SSL clients to present a client Certificate in order to use
- this socket. Set this value to <code>want</code> if you want JBoss
Web
- to request a client Certificate, but not fail if one isn't presented.
- </td>
- </tr>
- <tr><td><code>SSLEnabled</code></td>
- <td>
- Use this attribute to enable SSL traffic on a connector.
- To turn on SSL handshake/encryption/decryption on a connector
- set this value to <code>true</code>.
- The default value is <code>false</code>.
- When turning this value <code>true</code> you will want to set the
- <code>scheme</code> and the <code>secure</code> attributes
as well
- to pass the correct <code>request.getScheme()</code> and
- <code>request.isSecure()</code> values to the servlets
- </td>
- </tr>
- <tr>
- <td><code>keystoreFile</code></td>
- <td>Add this attribute if the keystore file you created is not in
- the default place that JBoss Web expects (a file named
- <code>.keystore</code> in the user home directory under
- which JBoss Web is running). You can specify an absolute pathname,
- or a relative pathname that is resolved against the
- <code>$CATALINA_BASE</code> environment variable.</td>
- </tr>
- <tr>
- <td><code>keystorePass</code></td>
- <td>Add this element if you used a different keystore (and Certificate)
- password than the one JBoss Web expects
(<code>changeit</code>).</td>
- </tr>
- <tr>
- <td><code>keystoreType</code></td>
- <td>Add this element if using a keystore type other than
- <code>JKS</code>.</td>
- </tr>
- <tr>
- <td><code>sslProtocol</code></td>
- <td>The encryption/decryption protocol to be used on this socket.
- It is not recommended to change this value if you are using Sun's
- JVM. It is reported that IBM's 1.4.1 implementation
- of the TLS protocol is not compatible with some popular browsers.
- In this case, use the value <code>SSL</code>.</td>
- </tr>
- <tr>
- <td><code>ciphers</code></td>
- <td>The comma separated list of encryption ciphers that this socket is
- allowed to use. By default, any available cipher is allowed.</td>
- </tr>
- <tr>
- <td><code>algorithm</code></td>
- <td>The <code>X509</code> algorithm to use. This defaults to the
Sun
- implementation (<code>SunX509</code>). For IBM JVMs you should use
- the value <code>IbmX509</code>. For other vendors, consult the JVM
- documentation for the correct value.
- </td>
- </tr>
- <tr>
- <td><code>truststoreFile</code></td>
- <td>The TrustStore file to use to validate client certificates.</td>
- </tr>
- <tr>
- <td><code>truststorePass</code></td>
- <td>The password to access the TrustStore. This defaults to the value
- of <code>keystorePass</code>.</td>
- </tr>
- <tr>
- <td><code>truststoreType</code></td>
- <td>Add this element if your are using a different format for the
- TrustStore then you are using for the KeyStore.</td>
- </tr>
- <tr>
- <td><code>keyAlias</code></td>
- <td>Add this element if your have more than one key in the KeyStore.
- If the element is not present the first key read in the KeyStore
- will be used.</td>
- </tr>
-</table>
+ <attributes>
+ <attribute name="algorithm" required="false">
+ <p>The certificate encoding algorithm to be used. This defaults to the Sun
+ implementation (<code>SunX509</code>). For IBM JVMs you should use the
+ value <code>IbmX509</code>. For other vendors, consult the JVM
+ documentation for the correct value.</p>
+ </attribute>
+
+ <attribute name="clientAuth" required="false">
+ <p>Set to <code>true</code> if you want the SSL stack to require
a
+ valid certificate chain from the client before accepting a connection.
+ Set to <code>want</code> if you want the SSL stack to request a client
+ Certificate, but not fail if one isn't presented. A
<code>false</code>
+ value (which is the default) will not require a certificate chain
+ unless the client requests a resource protected by a security
+ constraint that uses <code>CLIENT-CERT</code>
authentication.</p>
+ </attribute>
+
+ <attribute name="keystoreFile" required="false">
+ <p>The pathname of the keystore file where you have stored the
+ server certificate to be loaded. By default, the pathname is
+ the file "<code>.keystore</code>" in the operating system
home
+ directory of the user that is running JBoss Web.</p>
+ </attribute>
+
+ <attribute name="keystorePass" required="false">
+ <p>The password used to access the server certificate from the
+ specified keystore file. The default value is
"<code>changeit</code>".
+ </p>
+ </attribute>
+
+ <attribute name="keystoreType" required="false">
+ <p>The type of keystore file to be used for the server certificate.
+ If not specified, the default value is
"<code>JKS</code>".</p>
+ </attribute>
+
+ <attribute name="sslProtocol" required="false">
+ <p>The version of the SSL protocol to use. If not specified,
+ the default is "<code>TLS</code>".</p>
+ </attribute>
+
+ <attribute name="ciphers" required="false">
+ <p>A comma seperated list of the encryption ciphers that may be used.
+ If not specified, then any available cipher may be used.</p>
+ </attribute>
+
+ <attribute name="keyAlias" required="false">
+ <p>The alias used to for the server certificate in the keystore. If not
+ specified the first key read in the keystore will be used.</p>
+ </attribute>
+
+ <attribute name="truststoreFile" required="false">
+ <p>The TrustStore file to use to validate client certificates.</p>
+ </attribute>
+
+ <attribute name="truststorePass" required="false">
+ <p>The password to access the TrustStore. This defaults to the value
+ of <code>keystorePass</code>.</p>
+ </attribute>
+
+ <attribute name="truststoreType" required="false">
+ <p>Add this element if your are using a different format for the
+ TrustStore then you are using for the KeyStore.</p>
+ </attribute>
+
+ </attributes>
+
<p>After completing these configuration changes, you must restart JBoss Web as
you normally do, and you should be in business. You should be able to access
any web application supported by JBoss Web via SSL. For example, try:</p>
Modified: trunk/webapps/docs/tomcat-docs.xsl
===================================================================
--- trunk/webapps/docs/tomcat-docs.xsl 2008-03-18 02:33:16 UTC (rev 527)
+++ trunk/webapps/docs/tomcat-docs.xsl 2008-03-18 13:56:10 UTC (rev 528)
@@ -199,7 +199,7 @@
</tr>
<xsl:for-each select="attribute">
- <tr class="evenRow">
+ <tr class="oddRow">
<td class="first">
<xsl:if test="@required = 'true'">
<strong><code><xsl:value-of
select="@name"/></code></strong>
@@ -226,7 +226,7 @@
</tr>
<xsl:for-each select="property">
- <tr class="evenRow">
+ <tr class="oddRow">
<td class="first"><code><xsl:value-of
select="@name"/></code></td>
<td><xsl:apply-templates/></td>
</tr>