Author: markt Date: Mon Oct 13 13:38:25 2014 New Revision: 1631390 URL: http://svn.apache.org/r1631390 Log: Fix some more of the Java 8 Javadoc errors in the org.apace.catalina package
Modified: tomcat/trunk/java/org/apache/catalina/WebResourceRoot.java tomcat/trunk/java/org/apache/catalina/connector/Connector.java tomcat/trunk/java/org/apache/catalina/core/ContainerBase.java tomcat/trunk/java/org/apache/catalina/filters/CorsFilter.java tomcat/trunk/java/org/apache/catalina/filters/ExpiresFilter.java tomcat/trunk/java/org/apache/catalina/filters/RemoteIpFilter.java tomcat/trunk/java/org/apache/catalina/ha/deploy/WarWatcher.java tomcat/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java Modified: tomcat/trunk/java/org/apache/catalina/WebResourceRoot.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/WebResourceRoot.java?rev=1631390&r1=1631389&r2=1631390&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/catalina/WebResourceRoot.java (original) +++ tomcat/trunk/java/org/apache/catalina/WebResourceRoot.java Mon Oct 13 13:38:25 2014 @@ -27,15 +27,15 @@ import java.util.Set; * a Resource, the ResourceSets are processed in the following order: * <ol> * <li>Pre - Resources defined by the <PreResource> element in the web - * application's context.xml. Resources will be searched in the - * order they were specified.</li> + * application's context.xml. Resources will be searched in the order + * they were specified.</li> * <li>Main - The main resources for the web application - i.e. the WAR or the * directory containing the expanded WAR</li> * <li>JARs - Resource JARs as defined by the Servlet specification. JARs will * be searched in the order they were added to the ResourceRoot.</li> * <li>Post - Resources defined by the <PostResource> element in the web - * application's context.xml. Resources will be searched in the - * order they were specified.</li> + * application's context.xml. Resources will be searched in the order + * they were specified.</li> * </ol> * The following conventions should be noted: * <ul> @@ -378,14 +378,15 @@ public interface WebResourceRoot extends * logged and then closed.</li> * </ul> * - * @param trackLockedFiles @true to enable it, @false to disable it + * @param trackLockedFiles {@code true} to enable it, {@code false} to + * disable it */ void setTrackLockedFiles(boolean trackLockedFiles); /** * Has the track locked files feature been enabled? * - * @return @true if it has been enabled, otherwise @false + * @return {@code true} if it has been enabled, otherwise {@code false} */ boolean getTrackLockedFiles(); Modified: tomcat/trunk/java/org/apache/catalina/connector/Connector.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/connector/Connector.java?rev=1631390&r1=1631389&r2=1631390&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/catalina/connector/Connector.java (original) +++ tomcat/trunk/java/org/apache/catalina/connector/Connector.java Mon Oct 13 13:38:25 2014 @@ -829,7 +829,7 @@ public class Connector extends Lifecycle * Enable the use of IP-based virtual hosting. * * @param useIPVHosts <code>true</code> if Hosts are identified by IP, - * <code>false/code> if Hosts are identified by name. + * <code>false</code> if Hosts are identified by name. */ public void setUseIPVHosts(boolean useIPVHosts) { this.useIPVHosts = useIPVHosts; Modified: tomcat/trunk/java/org/apache/catalina/core/ContainerBase.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/core/ContainerBase.java?rev=1631390&r1=1631389&r2=1631390&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/catalina/core/ContainerBase.java (original) +++ tomcat/trunk/java/org/apache/catalina/core/ContainerBase.java Mon Oct 13 13:38:25 2014 @@ -84,6 +84,7 @@ import org.apache.tomcat.util.res.String * following <code>ContainerEvent</code> events to listeners who register * themselves with <code>addContainerListener()</code>: * <table border=1> + * <caption>ContainerEvents fired by this implementation</caption> * <tr> * <th>Type</th> * <th>Data</th> Modified: tomcat/trunk/java/org/apache/catalina/filters/CorsFilter.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/filters/CorsFilter.java?rev=1631390&r1=1631389&r2=1631390&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/catalina/filters/CorsFilter.java (original) +++ tomcat/trunk/java/org/apache/catalina/filters/CorsFilter.java Mon Oct 13 13:38:25 2014 @@ -51,6 +51,7 @@ import org.apache.tomcat.util.res.String * <p> * By default, it also sets following request attributes, that help to * determine the nature of the request downstream. + * </p> * <ul> * <li><b>cors.isCorsRequest:</b> Flag to determine if the request is a CORS * request. Set to <code>true</code> if a CORS request; <code>false</code> @@ -70,7 +71,6 @@ import org.apache.tomcat.util.res.String * <li><b>cors.request.headers:</b> Request headers sent as * 'Access-Control-Request-Headers' header, for pre-flight request.</li> * </ul> - * </p> * * @see <a href="http://www.w3.org/TR/cors/">CORS specification</a> * Modified: tomcat/trunk/java/org/apache/catalina/filters/ExpiresFilter.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/filters/ExpiresFilter.java?rev=1631390&r1=1631389&r2=1631390&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/catalina/filters/ExpiresFilter.java (original) +++ tomcat/trunk/java/org/apache/catalina/filters/ExpiresFilter.java Mon Oct 13 13:38:25 2014 @@ -81,7 +81,7 @@ import org.apache.juli.logging.LogFactor * <tt>Expires</tt>' and ' <tt>Cache-Control: max-age=</tt>' * headers to images, css and javascript</h2> * - * <code><pre> + * <code> * <web-app ...> * ... * <filter> @@ -108,7 +108,7 @@ import org.apache.juli.logging.LogFactor * </filter-mapping> * ... * </web-app> - * </pre></code> + * </code> * * <h2>Configuration Parameters</h2> * @@ -147,7 +147,7 @@ import org.apache.juli.logging.LogFactor * <strong>Example:</strong> * </p> * - * <code><pre> + * <code> * <init-param> * <param-name>ExpiresByType text/html</param-name><param-value>access plus 1 month 15 days 2 hours</param-value> * </init-param> @@ -156,7 +156,7 @@ import org.apache.juli.logging.LogFactor * <!-- 2592000 seconds = 30 days --> * <param-name>ExpiresByType image/gif</param-name><param-value>A2592000</param-value> * </init-param> - * </pre></code> + * </code> * <p> * Note that this directive only has effect if <tt>ExpiresActive On</tt> has * been specified. It overrides, for the specified MIME type <i>only</i>, any @@ -185,11 +185,11 @@ import org.apache.juli.logging.LogFactor * Configuration sample : * </p> * - * <code><pre> + * <code> * <init-param> * <param-name>ExpiresExcludedResponseStatusCodes</param-name><param-value>302, 500, 503</param-value> * </init-param> - * </pre></code> + * </code> * * <h3>ExpiresDefault</h3> * <p> @@ -205,7 +205,7 @@ import org.apache.juli.logging.LogFactor * defined in a more readable syntax of the form: * </p> * - * <code><pre> + * <code> * <init-param> * <param-name>ExpiresDefault</param-name><param-value><base> [plus] {<num> <type>}*</param-value> * </init-param> @@ -213,19 +213,20 @@ import org.apache.juli.logging.LogFactor * <init-param> * <param-name>ExpiresByType type/encoding</param-name><param-value><base> [plus] {<num> <type>}*</param-value> * </init-param> - * </pre></code> + * </code> * <p> * where <tt><base></tt> is one of: + * </p> * <ul> * <li><tt>access</tt></li> * <li><tt>now</tt> (equivalent to '<tt>access</tt>')</li> * <li><tt>modification</tt></li> * </ul> - * </p> * <p> * The <tt>plus</tt> keyword is optional. <tt><num></tt> should be an * integer value (acceptable to <tt>Integer.parseInt()</tt>), and * <tt><type></tt> is one of: + * </p> * <ul> * <li><tt>years</tt></li> * <li><tt>months</tt></li> @@ -235,11 +236,12 @@ import org.apache.juli.logging.LogFactor * <li><tt>minutes</tt></li> * <li><tt>seconds</tt></li> * </ul> + * <p> * For example, any of the following directives can be used to make documents * expire 1 month after being accessed, by default: * </p> * - * <code><pre> + * <code> * <init-param> * <param-name>ExpiresDefault</param-name><param-value>access plus 1 month</param-value> * </init-param> @@ -251,13 +253,13 @@ import org.apache.juli.logging.LogFactor * <init-param> * <param-name>ExpiresDefault</param-name><param-value>access plus 30 days</param-value> * </init-param> - * </pre></code> + * </code> * <p> * The expiry time can be fine-tuned by adding several ' * <tt><num> <type></tt>' clauses: * </p> * - * <code><pre> + * <code> * <init-param> * <param-name>ExpiresByType text/html</param-name><param-value>access plus 1 month 15 days 2 hours</param-value> * </init-param> @@ -265,7 +267,7 @@ import org.apache.juli.logging.LogFactor * <init-param> * <param-name>ExpiresByType image/gif</param-name><param-value>modification plus 5 hours 3 minutes</param-value> * </init-param> - * </pre></code> + * </code> * <p> * Note that if you use a modification date based setting, the <tt>Expires</tt> * header will <strong>not</strong> be added to content that does not come from @@ -275,6 +277,7 @@ import org.apache.juli.logging.LogFactor * <h1>Expiration headers generation eligibility</h1> * <p> * A response is eligible to be enriched by <tt>ExpiresFilter</tt> if : + * </p> * <ol> * <li>no expiration header is defined (<tt>Expires</tt> header or the * <tt>max-age</tt> directive of the <tt>Cache-Control</tt> header),</li> @@ -284,18 +287,18 @@ import org.apache.juli.logging.LogFactor * defined the in <tt>ExpiresByType</tt> directives or the * <tt>ExpiresDefault</tt> directive is defined.</li> * </ol> - * </p> * <p> * Note : + * </p> * <ul> * <li>If <tt>Cache-Control</tt> header contains other directives than * <tt>max-age</tt>, they are concatenated with the <tt>max-age</tt> directive * that is added by the <tt>ExpiresFilter</tt>.</li> * </ul> - * </p> * <h1>Expiration configuration selection</h1> * <p> * The expiration configuration if elected according to the following algorithm: + * </p> * <ol> * <li><tt>ExpiresByType</tt> matching the exact content-type returned by * <tt>HttpServletResponse.getContentType()</tt> possibly including the charset @@ -309,7 +312,6 @@ import org.apache.juli.logging.LogFactor * '),</li> * <li><tt>ExpiresDefault</tt></li> * </ol> - * </p> * <h1>Implementation Details</h1><h2>When to write the expiration headers ?</h2> * <p> * The <tt>ExpiresFilter</tt> traps the 'on before write response @@ -349,6 +351,7 @@ import org.apache.juli.logging.LogFactor * </p> * <p> * Key methods to override for extension are : + * </p> * <ul> * <li> * {@link #isEligibleToExpirationHeaderGeneration(HttpServletRequest, XHttpServletResponse)} @@ -356,7 +359,6 @@ import org.apache.juli.logging.LogFactor * <li> * {@link #getExpirationDate(XHttpServletResponse)}</li> * </ul> - * </p> * <h1>Troubleshooting</h1> * <p> * To troubleshoot, enable logging on the @@ -366,14 +368,14 @@ import org.apache.juli.logging.LogFactor * Extract of logging.properties * </p> * - * <code><pre> + * <code> * org.apache.catalina.filters.ExpiresFilter.level = FINE - * </pre></code> + * </code> * <p> * Sample of initialization log message : * </p> * - * <code><pre> + * <code> * Mar 26, 2010 2:01:41 PM org.apache.catalina.filters.ExpiresFilter init * FINE: Filter initialized with configuration ExpiresFilter[ * excludedResponseStatusCode=[304], @@ -382,26 +384,25 @@ import org.apache.juli.logging.LogFactor * image=ExpiresConfiguration[startingPoint=ACCESS_TIME, duration=[10 MINUTE]], * text/css=ExpiresConfiguration[startingPoint=ACCESS_TIME, duration=[10 MINUTE]], * application/javascript=ExpiresConfiguration[startingPoint=ACCESS_TIME, duration=[10 MINUTE]]}] - * </pre></code> + * </code> * <p> * Sample of per-request log message where <tt>ExpiresFilter</tt> adds an * expiration date * </p> * - * <code><pre> + * <code> * Mar 26, 2010 2:09:47 PM org.apache.catalina.filters.ExpiresFilter onBeforeWriteResponseBody * FINE: Request "/tomcat.gif" with response status "200" content-type "image/gif", set expiration date 3/26/10 2:19 PM - * </pre></code> + * </code> * <p> * Sample of per-request log message where <tt>ExpiresFilter</tt> does not add * an expiration date * </p> * - * <code><pre> + * <code> * Mar 26, 2010 2:10:27 PM org.apache.catalina.filters.ExpiresFilter onBeforeWriteResponseBody * FINE: Request "/docs/config/manager.html" with response status "200" content-type "text/html", no expiration configured - * </pre></code> - * + * </code> */ public class ExpiresFilter extends FilterBase { Modified: tomcat/trunk/java/org/apache/catalina/filters/RemoteIpFilter.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/filters/RemoteIpFilter.java?rev=1631390&r1=1631389&r2=1631390&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/catalina/filters/RemoteIpFilter.java (original) +++ tomcat/trunk/java/org/apache/catalina/filters/RemoteIpFilter.java Mon Oct 13 13:38:25 2014 @@ -65,6 +65,7 @@ import org.apache.juli.logging.LogFactor * </p> * <p> * If the incoming <code>request.getRemoteAddr()</code> matches the servlet filter's list of internal proxies : + * </p> * <ul> * <li>Loop on the comma delimited list of IPs and hostnames passed by the preceding load balancer or proxy in the given request's Http * header named <code>$remoteIpHeader</code> (default value <code>x-forwarded-for</code>). Values are processed in right-to-left order.</li> @@ -80,10 +81,8 @@ import org.apache.juli.logging.LogFactor * <code>request.scheme = https</code> and <code>request.serverPort = 443</code>. Note that 443 can be overwritten with the * <code>$httpsServerPort</code> configuration parameter.</li> * </ul> - * </p> - * <p> - * <strong>Configuration parameters:</strong> * <table border="1"> + * <caption>Configuration parameters</caption> * <tr> * <th>XForwardedFilter property</th> * <th>Description</th> @@ -115,7 +114,6 @@ import org.apache.juli.logging.LogFactor * <br> * By default, 10/8, 192.168/16, 169.254/16, 127/8 and 172.16/12 are allowed.</td> * </tr> - * </tr> * <tr> * <td>proxiesHeader</td> * <td>Name of the http header created by this servlet filter to hold the list of proxies that have been processed in the incoming @@ -163,7 +161,6 @@ import org.apache.juli.logging.LogFactor * <td>443</td> * </tr> * </table> - * </p> * <p> * <p> * <strong>Regular expression vs. IP address blocks:</strong> <code>mod_remoteip</code> allows to use address blocks (e.g. @@ -172,14 +169,14 @@ import org.apache.juli.logging.LogFactor * href="http://apr.apache.org/docs/apr/1.3/group__apr__network__io.html#gb74d21b8898b7c40bf7fd07ad3eb993d">apr_ipsubnet_test</a>, we rely on * regular expressions. * </p> - * <hr/> + * <hr> * <p> * <strong>Sample with internal proxies</strong> * </p> * <p> * XForwardedFilter configuration: * </p> - * <code><pre> + * <code> * <filter> * <filter-name>RemoteIpFilter</filter-name> * <filter-class>org.apache.catalina.filters.RemoteIpFilter</filter-class> @@ -205,10 +202,9 @@ import org.apache.juli.logging.LogFactor * <filter-name>RemoteIpFilter</filter-name> * <url-pattern>/*</url-pattern> * <dispatcher>REQUEST</dispatcher> - * </filter-mapping></pre></code> - * <p> - * Request values: + * </filter-mapping></code> * <table border="1"> + * <caption>Request Values</caption> * <tr> * <th>property</th> * <th>Value Before RemoteIpFilter</th> @@ -252,15 +248,14 @@ import org.apache.juli.logging.LogFactor * </table> * Note : <code>x-forwarded-by</code> header is null because only internal proxies as been traversed by the request. * <code>x-forwarded-by</code> is null because all the proxies are trusted or internal. - * </p> - * <hr/> + * <hr> * <p> * <strong>Sample with trusted proxies</strong> * </p> * <p> * RemoteIpFilter configuration: * </p> - * <code><pre> + * <code> * <filter> * <filter-name>RemoteIpFilter</filter-name> * <filter-class>org.apache.catalina.filters.RemoteIpFilter</filter-class> @@ -286,10 +281,9 @@ import org.apache.juli.logging.LogFactor * <filter-name>RemoteIpFilter</filter-name> * <url-pattern>/*</url-pattern> * <dispatcher>REQUEST</dispatcher> - * </filter-mapping></pre></code> - * <p> - * Request values: + * </filter-mapping></code> * <table border="1"> + * <caption>Request Values</caption> * <tr> * <th>property</th> * <th>Value Before RemoteIpFilter</th> @@ -311,17 +305,18 @@ import org.apache.juli.logging.LogFactor * <td>proxy1, proxy2</td> * </tr> * </table> + * <p> * Note : <code>proxy1</code> and <code>proxy2</code> are both trusted proxies that come in <code>x-forwarded-for</code> header, they both * are migrated in <code>x-forwarded-by</code> header. <code>x-forwarded-by</code> is null because all the proxies are trusted or internal. * </p> - * <hr/> + * <hr> * <p> * <strong>Sample with internal and trusted proxies</strong> * </p> * <p> * RemoteIpFilter configuration: * </p> - * <code><pre> + * <code> * <filter> * <filter-name>RemoteIpFilter</filter-name> * <filter-class>org.apache.catalina.filters.RemoteIpFilter</filter-class> @@ -347,10 +342,9 @@ import org.apache.juli.logging.LogFactor * <filter-name>RemoteIpFilter</filter-name> * <url-pattern>/*</url-pattern> * <dispatcher>REQUEST</dispatcher> - * </filter-mapping></pre></code> - * <p> - * Request values: + * </filter-mapping></code> * <table border="1"> + * <caption>Request Values</caption> * <tr> * <th>property</th> * <th>Value Before RemoteIpFilter</th> @@ -372,18 +366,19 @@ import org.apache.juli.logging.LogFactor * <td>proxy1, proxy2</td> * </tr> * </table> + * <p> * Note : <code>proxy1</code> and <code>proxy2</code> are both trusted proxies that come in <code>x-forwarded-for</code> header, they both * are migrated in <code>x-forwarded-by</code> header. As <code>192.168.0.10</code> is an internal proxy, it does not appear in * <code>x-forwarded-by</code>. <code>x-forwarded-by</code> is null because all the proxies are trusted or internal. * </p> - * <hr/> + * <hr> * <p> * <strong>Sample with an untrusted proxy</strong> * </p> * <p> * RemoteIpFilter configuration: * </p> - * <code><pre> + * <code> * <filter> * <filter-name>RemoteIpFilter</filter-name> * <filter-class>org.apache.catalina.filters.RemoteIpFilter</filter-class> @@ -409,10 +404,9 @@ import org.apache.juli.logging.LogFactor * <filter-name>RemoteIpFilter</filter-name> * <url-pattern>/*</url-pattern> * <dispatcher>REQUEST</dispatcher> - * </filter-mapping></pre></code> - * <p> - * Request values: + * </filter-mapping></code> * <table border="1"> + * <caption>Request Values</caption> * <tr> * <th>property</th> * <th>Value Before RemoteIpFilter</th> @@ -434,12 +428,13 @@ import org.apache.juli.logging.LogFactor * <td>proxy1</td> * </tr> * </table> + * <p> * Note : <code>x-forwarded-by</code> holds the trusted proxy <code>proxy1</code>. <code>x-forwarded-by</code> holds * <code>140.211.11.130</code> because <code>untrusted-proxy</code> is not trusted and thus, we can not trust that * <code>untrusted-proxy</code> is the actual remote ip. <code>request.remoteAddr</code> is <code>untrusted-proxy</code> that is an IP * verified by <code>proxy1</code>. * </p> - * <hr/> + * <hr> */ public class RemoteIpFilter implements Filter { public static class XForwardedRequest extends HttpServletRequestWrapper { Modified: tomcat/trunk/java/org/apache/catalina/ha/deploy/WarWatcher.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/ha/deploy/WarWatcher.java?rev=1631390&r1=1631389&r2=1631390&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/catalina/ha/deploy/WarWatcher.java (original) +++ tomcat/trunk/java/org/apache/catalina/ha/deploy/WarWatcher.java Mon Oct 13 13:38:25 2014 @@ -14,7 +14,6 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - package org.apache.catalina.ha.deploy; import java.io.File; @@ -26,16 +25,13 @@ import org.apache.juli.logging.Log; import org.apache.juli.logging.LogFactory; /** - * <p> * The <b>WarWatcher </b> watches the deployDir for changes made to the - * directory (adding new WAR files->deploy or remove WAR files->undeploy) And - * notifies a listener of the changes made - * </p> + * directory (adding new WAR files->deploy or remove WAR files->undeploy) + * and notifies a listener of the changes made. * * @author Peter Rossbach * @version 1.1 */ - public class WarWatcher { /*--Static Variables----------------------------------------*/ Modified: tomcat/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java?rev=1631390&r1=1631389&r2=1631390&view=diff ============================================================================== --- tomcat/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java (original) +++ tomcat/trunk/java/org/apache/catalina/ha/tcp/SimpleTcpCluster.java Mon Oct 13 13:38:25 2014 @@ -128,7 +128,7 @@ public class SimpleTcpCluster extends Li protected final PropertyChangeSupport support = new PropertyChangeSupport(this); /** - * The context name <->manager association for distributed contexts. + * The context name <-> manager association for distributed contexts. */ protected final Map<String, ClusterManager> managers = new HashMap<>(); --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org