You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by ma...@apache.org on 2019/07/09 15:00:52 UTC
[tomcat] branch 7.0.x updated (15d7f85 -> 978963b)
This is an automated email from the ASF dual-hosted git repository.
markt pushed a change to branch 7.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git.
from 15d7f85 Back-port NPE fix
new b5beb7b Javadoc updates to align with 8.5.x
new c260e6a Align Javadoc with 8.5.x
new 978963b Align docs with 8.5.x including fixes to a copy/paste error
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../apache/catalina/filters/RemoteIpFilter.java | 75 +++++++++++++---------
java/org/apache/catalina/valves/RemoteIpValve.java | 62 ++++++++++--------
webapps/docs/config/filter.xml | 4 +-
webapps/docs/config/valve.xml | 22 +++----
4 files changed, 90 insertions(+), 73 deletions(-)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
[tomcat] 02/03: Align Javadoc with 8.5.x
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 7.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit c260e6add354909d13a874d62c8532affc778eb5
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Tue Jul 9 15:57:27 2019 +0100
Align Javadoc with 8.5.x
---
java/org/apache/catalina/valves/RemoteIpValve.java | 62 ++++++++++++----------
1 file changed, 34 insertions(+), 28 deletions(-)
diff --git a/java/org/apache/catalina/valves/RemoteIpValve.java b/java/org/apache/catalina/valves/RemoteIpValve.java
index 5b9e921..24e0065 100644
--- a/java/org/apache/catalina/valves/RemoteIpValve.java
+++ b/java/org/apache/catalina/valves/RemoteIpValve.java
@@ -49,6 +49,7 @@ import org.apache.tomcat.util.http.MimeHeaders;
* <p>
* If the incoming <code>request.getRemoteAddr()</code> matches the valve's list
* of internal or trusted 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>
@@ -64,10 +65,8 @@ import org.apache.tomcat.util.http.MimeHeaders;
* <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>RemoteIpValve property</th>
* <th>Description</th>
@@ -145,8 +144,6 @@ import org.apache.tomcat.util.http.MimeHeaders;
* <td>443</td>
* </tr>
* </table>
- * </p>
- * <p>
* <p>
* This Valve may be attached to any Container, depending on the granularity of the filtering you wish to perform.
* </p>
@@ -158,24 +155,23 @@ import org.apache.tomcat.util.http.MimeHeaders;
* <code>RemoteIpValve</code> uses regular expression to configure <code>internalProxies</code> and <code>trustedProxies</code> in the same
* fashion as {@link RequestFilterValve} does.
* </p>
- * <hr/>
+ * <hr>
* <p>
* <strong>Sample with internal proxies</strong>
* </p>
* <p>
* RemoteIpValve configuration:
* </p>
- * <code><pre>
+ * <code>
* <Valve
* className="org.apache.catalina.valves.RemoteIpValve"
* internalProxies="192\.168\.0\.10|192\.168\.0\.11"
* remoteIpHeader="x-forwarded-for"
* proxiesHeader="x-forwarded-by"
* protocolHeader="x-forwarded-proto"
- * /></pre></code>
- * <p>
- * Request values:
+ * /></code>
* <table border="1">
+ * <caption>Request Values</caption>
* <tr>
* <th>property</th>
* <th>Value Before RemoteIpValve</th>
@@ -217,27 +213,27 @@ import org.apache.tomcat.util.http.MimeHeaders;
* <td>443</td>
* </tr>
* </table>
+ * <p>
* 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>
* RemoteIpValve configuration:
* </p>
- * <code><pre>
+ * <code>
* <Valve
* className="org.apache.catalina.valves.RemoteIpValve"
* internalProxies="192\.168\.0\.10|192\.168\.0\.11"
* remoteIpHeader="x-forwarded-for"
* proxiesHeader="x-forwarded-by"
* trustedProxies="proxy1|proxy2"
- * /></pre></code>
- * <p>
- * Request values:
+ * /></code>
* <table border="1">
+ * <caption>Request Values</caption>
* <tr>
* <th>property</th>
* <th>Value Before RemoteIpValve</th>
@@ -259,27 +255,27 @@ import org.apache.tomcat.util.http.MimeHeaders;
* <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>
* RemoteIpValve configuration:
* </p>
- * <code><pre>
+ * <code>
* <Valve
* className="org.apache.catalina.valves.RemoteIpValve"
* internalProxies="192\.168\.0\.10|192\.168\.0\.11"
* remoteIpHeader="x-forwarded-for"
* proxiesHeader="x-forwarded-by"
* trustedProxies="proxy1|proxy2"
- * /></pre></code>
- * <p>
- * Request values:
+ * /></code>
* <table border="1">
+ * <caption>Request Values</caption>
* <tr>
* <th>property</th>
* <th>Value Before RemoteIpValve</th>
@@ -301,28 +297,28 @@ import org.apache.tomcat.util.http.MimeHeaders;
* <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>
* RemoteIpValve configuration:
* </p>
- * <code><pre>
+ * <code>
* <Valve
* className="org.apache.catalina.valves.RemoteIpValve"
* internalProxies="192\.168\.0\.10|192\.168\.0\.11"
* remoteIpHeader="x-forwarded-for"
* proxiesHeader="x-forwarded-by"
* trustedProxies="proxy1|proxy2"
- * /></pre></code>
- * <p>
- * Request values:
+ * /></code>
* <table border="1">
+ * <caption>Request Values</caption>
* <tr>
* <th>property</th>
* <th>Value Before RemoteIpValve</th>
@@ -344,8 +340,9 @@ import org.apache.tomcat.util.http.MimeHeaders;
* <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>140.211.11.130</code> because <code>untrusted-proxy</code> is not trusted and thus, we cannot 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>
@@ -369,7 +366,7 @@ public class RemoteIpValve extends ValveBase {
/**
* Convert a given comma delimited String into an array of String
- *
+ * @param commaDelimitedStrings The string to convert
* @return array of String (non <code>null</code>)
*/
protected static String[] commaDelimitedListToStringArray(String commaDelimitedStrings) {
@@ -379,6 +376,8 @@ public class RemoteIpValve extends ValveBase {
/**
* Convert an array of strings in a comma delimited string
+ * @param stringList The string list to convert
+ * @return The concatenated string
*/
protected static String listToCommaDelimitedString(List<String> stringList) {
if (stringList == null) {
@@ -758,6 +757,7 @@ public class RemoteIpValve extends ValveBase {
* <p>
* Default value : 80
* </p>
+ * @param httpServerPort The server port
*/
public void setHttpServerPort(int httpServerPort) {
this.httpServerPort = httpServerPort;
@@ -770,6 +770,7 @@ public class RemoteIpValve extends ValveBase {
* <p>
* Default value : 443
* </p>
+ * @param httpsServerPort The server port
*/
public void setHttpsServerPort(int httpsServerPort) {
this.httpsServerPort = httpsServerPort;
@@ -782,6 +783,7 @@ public class RemoteIpValve extends ValveBase {
* <p>
* Default value : 10\.\d{1,3}\.\d{1,3}\.\d{1,3}|192\.168\.\d{1,3}\.\d{1,3}|169\.254.\d{1,3}.\d{1,3}|127\.\d{1,3}\.\d{1,3}\.\d{1,3}|0:0:0:0:0:0:0:1
* </p>
+ * @param internalProxies The proxy regular expression
*/
public void setInternalProxies(String internalProxies) {
if (internalProxies == null || internalProxies.length() == 0) {
@@ -799,6 +801,7 @@ public class RemoteIpValve extends ValveBase {
* <p>
* Default value : <code>null</code>
* </p>
+ * @param protocolHeader The header name
*/
public void setProtocolHeader(String protocolHeader) {
this.protocolHeader = protocolHeader;
@@ -811,6 +814,7 @@ public class RemoteIpValve extends ValveBase {
* <p>
* Default value : <code>https</code>
* </p>
+ * @param protocolHeaderHttpsValue The header name
*/
public void setProtocolHeaderHttpsValue(String protocolHeaderHttpsValue) {
this.protocolHeaderHttpsValue = protocolHeaderHttpsValue;
@@ -831,6 +835,7 @@ public class RemoteIpValve extends ValveBase {
* <p>
* Default value : <code>X-Forwarded-By</code>
* </p>
+ * @param proxiesHeader The header name
*/
public void setProxiesHeader(String proxiesHeader) {
this.proxiesHeader = proxiesHeader;
@@ -847,7 +852,7 @@ public class RemoteIpValve extends ValveBase {
* Default value : <code>X-Forwarded-For</code>
* </p>
*
- * @param remoteIpHeader
+ * @param remoteIpHeader The header name
*/
public void setRemoteIpHeader(String remoteIpHeader) {
this.remoteIpHeader = remoteIpHeader;
@@ -884,6 +889,7 @@ public class RemoteIpValve extends ValveBase {
* <p>
* Default value : empty list, no external proxy is trusted.
* </p>
+ * @param trustedProxies The regular expression
*/
public void setTrustedProxies(String trustedProxies) {
if (trustedProxies == null || trustedProxies.length() == 0) {
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
[tomcat] 01/03: Javadoc updates to align with 8.5.x
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 7.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit b5beb7be415e7ea0ea03b007f5d94c42dbe80c01
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Tue Jul 9 15:55:22 2019 +0100
Javadoc updates to align with 8.5.x
---
.../apache/catalina/filters/RemoteIpFilter.java | 75 +++++++++++++---------
1 file changed, 43 insertions(+), 32 deletions(-)
diff --git a/java/org/apache/catalina/filters/RemoteIpFilter.java b/java/org/apache/catalina/filters/RemoteIpFilter.java
index d52bba9..1bc5b9f 100644
--- a/java/org/apache/catalina/filters/RemoteIpFilter.java
+++ b/java/org/apache/catalina/filters/RemoteIpFilter.java
@@ -67,6 +67,7 @@ import org.apache.juli.logging.LogFactory;
* <p>
* If the incoming <code>request.getRemoteAddr()</code> matches the servlet
* filter's list of internal or trusted 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>
@@ -82,10 +83,8 @@ import org.apache.juli.logging.LogFactory;
* <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>
@@ -164,8 +163,6 @@ import org.apache.juli.logging.LogFactory;
* <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.
* <code>192.168/16</code>) to configure <code>RemoteIPInternalProxy</code> and <code>RemoteIPTrustedProxy</code> ; as the JVM doesn't have a
@@ -173,14 +170,14 @@ import org.apache.juli.logging.LogFactory;
* href="https://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>
@@ -206,10 +203,9 @@ import org.apache.juli.logging.LogFactory;
* <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>
@@ -253,15 +249,14 @@ import org.apache.juli.logging.LogFactory;
* </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>
@@ -287,10 +282,9 @@ import org.apache.juli.logging.LogFactory;
* <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>
@@ -312,17 +306,18 @@ import org.apache.juli.logging.LogFactory;
* <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>
@@ -348,10 +343,9 @@ import org.apache.juli.logging.LogFactory;
* <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>
@@ -373,18 +367,19 @@ import org.apache.juli.logging.LogFactory;
* <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>
@@ -410,10 +405,9 @@ import org.apache.juli.logging.LogFactory;
* <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>
@@ -435,14 +429,16 @@ import org.apache.juli.logging.LogFactory;
* <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>140.211.11.130</code> because <code>untrusted-proxy</code> is not trusted and thus, we cannot 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 {
static final ThreadLocal<SimpleDateFormat[]> threadLocalDateFormats = new ThreadLocal<SimpleDateFormat[]>() {
@@ -677,6 +673,7 @@ public class RemoteIpFilter implements Filter {
/**
* Convert a given comma delimited list of regular expressions into an array of String
*
+ * @param commaDelimitedStrings The string to split
* @return array of patterns (non <code>null</code>)
*/
protected static String[] commaDelimitedListToStringArray(String commaDelimitedStrings) {
@@ -685,7 +682,10 @@ public class RemoteIpFilter implements Filter {
}
/**
- * Convert an array of strings in a comma delimited string
+ * Convert a list of strings in a comma delimited string.
+ *
+ * @param stringList List of strings
+ * @return concatenated string
*/
protected static String listToCommaDelimitedString(List<String> stringList) {
if (stringList == null) {
@@ -916,6 +916,7 @@ public class RemoteIpFilter implements Filter {
/**
* Wrap the incoming <code>request</code> in a {@link XForwardedRequest} if the http header <code>x-forwarded-for</code> is not empty.
+ * {@inheritDoc}
*/
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
@@ -1026,12 +1027,13 @@ public class RemoteIpFilter implements Filter {
* <p>
* If <code>true</code>, the return values for both {@link
* ServletRequest#getLocalPort()} and {@link ServletRequest#getServerPort()}
- * wil be modified by this Filter rather than just
+ * will be modified by this Filter rather than just
* {@link ServletRequest#getServerPort()}.
* </p>
* <p>
* Default value : <code>false</code>
* </p>
+ * @param changeLocalPort The new flag value
*/
public void setChangeLocalPort(boolean changeLocalPort) {
this.changeLocalPort = changeLocalPort;
@@ -1045,6 +1047,7 @@ public class RemoteIpFilter implements Filter {
* <p>
* Default value : 80
* </p>
+ * @param httpServerPort The server port to use
*/
public void setHttpServerPort(int httpServerPort) {
this.httpServerPort = httpServerPort;
@@ -1057,6 +1060,7 @@ public class RemoteIpFilter implements Filter {
* <p>
* Default value : 443
* </p>
+ * @param httpsServerPort The server port to use
*/
public void setHttpsServerPort(int httpsServerPort) {
this.httpsServerPort = httpsServerPort;
@@ -1069,6 +1073,7 @@ public class RemoteIpFilter implements Filter {
* <p>
* Default value : 10\.\d{1,3}\.\d{1,3}\.\d{1,3}|192\.168\.\d{1,3}\.\d{1,3}|169\.254.\d{1,3}.\d{1,3}|127\.\d{1,3}\.\d{1,3}\.\d{1,3}|0:0:0:0:0:0:0:1
* </p>
+ * @param internalProxies The regexp
*/
public void setInternalProxies(String internalProxies) {
if (internalProxies == null || internalProxies.length() == 0) {
@@ -1080,13 +1085,14 @@ public class RemoteIpFilter implements Filter {
/**
* <p>
- * Header that holds the incoming port, usally named
+ * Header that holds the incoming port, usually named
* <code>X-Forwarded-Port</code>. If <code>null</code>,
* {@link #httpServerPort} or {@link #httpsServerPort} will be used.
* </p>
* <p>
* Default value : <code>null</code>
* </p>
+ * @param portHeader The header name
*/
public void setPortHeader(String portHeader) {
this.portHeader = portHeader;
@@ -1094,12 +1100,13 @@ public class RemoteIpFilter implements Filter {
/**
* <p>
- * Header that holds the incoming protocol, usally named <code>X-Forwarded-Proto</code>. If <code>null</code>, request.scheme and
+ * Header that holds the incoming protocol, usually named <code>X-Forwarded-Proto</code>. If <code>null</code>, request.scheme and
* request.secure will not be modified.
* </p>
* <p>
* Default value : <code>null</code>
* </p>
+ * @param protocolHeader The header name
*/
public void setProtocolHeader(String protocolHeader) {
this.protocolHeader = protocolHeader;
@@ -1112,6 +1119,7 @@ public class RemoteIpFilter implements Filter {
* <p>
* Default value : <code>https</code>
* </p>
+ * @param protocolHeaderHttpsValue The header value
*/
public void setProtocolHeaderHttpsValue(String protocolHeaderHttpsValue) {
this.protocolHeaderHttpsValue = protocolHeaderHttpsValue;
@@ -1132,6 +1140,7 @@ public class RemoteIpFilter implements Filter {
* <p>
* Default value : <code>X-Forwarded-By</code>
* </p>
+ * @param proxiesHeader The header name
*/
public void setProxiesHeader(String proxiesHeader) {
this.proxiesHeader = proxiesHeader;
@@ -1147,6 +1156,7 @@ public class RemoteIpFilter implements Filter {
* <p>
* Default value : <code>X-Forwarded-For</code>
* </p>
+ * @param remoteIpHeader The header name
*/
public void setRemoteIpHeader(String remoteIpHeader) {
this.remoteIpHeader = remoteIpHeader;
@@ -1183,6 +1193,7 @@ public class RemoteIpFilter implements Filter {
* <p>
* Default value : empty list, no external proxy is trusted.
* </p>
+ * @param trustedProxies The trusted proxies regexp
*/
public void setTrustedProxies(String trustedProxies) {
if (trustedProxies == null || trustedProxies.length() == 0) {
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
[tomcat] 03/03: Align docs with 8.5.x including fixes to a
copy/paste error
Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 7.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 978963b70fa975122f9dafaafd1bd0905de9fb5d
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Tue Jul 9 16:00:03 2019 +0100
Align docs with 8.5.x including fixes to a copy/paste error
---
webapps/docs/config/filter.xml | 4 ++--
webapps/docs/config/valve.xml | 22 +++++++++++-----------
2 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/webapps/docs/config/filter.xml b/webapps/docs/config/filter.xml
index 30c8c9b..6d3334f 100644
--- a/webapps/docs/config/filter.xml
+++ b/webapps/docs/config/filter.xml
@@ -923,7 +923,7 @@ FINE: Request "/docs/config/manager.html" with response status "200"
</attribute>
<attribute name="antiClickJackingOption" required="false">
- <p>What value should be used for the ant click-jacking header? Must be
+ <p>What value should be used for the anticlick-jacking header? Must be
one of <code>DENY</code>, <code>SAMEORIGIN</code>,
<code>ALLOW-FROM </code> (case-insensitive). If not specified, the
default value of <code>DENY</code> will be used.</p>
@@ -1537,7 +1537,7 @@ FINE: Request "/docs/config/manager.html" with response status "200"
<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 not trusted and thus, we cannot 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>.
diff --git a/webapps/docs/config/valve.xml b/webapps/docs/config/valve.xml
index 31069d9..702a464 100644
--- a/webapps/docs/config/valve.xml
+++ b/webapps/docs/config/valve.xml
@@ -325,7 +325,7 @@
<li><b><code>msec</code></b> - number of milliseconds since the epoch</li>
<li><b><code>msec_frac</code></b> - millisecond fraction</li>
</ul>
- <p>These formats can not be mixed with SimpleDateFormat formats in the same format
+ <p>These formats cannot be mixed with SimpleDateFormat formats in the same format
token.</p>
<p>Furthermore one can define whether to log the timestamp for the request start
@@ -473,15 +473,15 @@
<section name="Access Control">
-<subsection name="Remote Address Filter">
+<subsection name="Remote Address Valve">
<subsection name="Introduction">
- <p>The <strong>Remote Address Filter</strong> allows you to compare the
+ <p>The <strong>Remote Address Valve</strong> allows you to compare the
IP address of the client that submitted this request against one or more
<em>regular expressions</em>, and either allow the request to continue
or refuse to process the request from this client. A Remote Address
- Filter can be associated with any Catalina container
+ Valve can be associated with any Catalina container
(<a href="engine.html">Engine</a>, <a href="host.html">Host</a>, or
<a href="context.html">Context</a>), and must accept any request
presented to this container for processing before it will be passed on.</p>
@@ -507,13 +507,13 @@
will be <code>0:0:0:0:0:0:0:1</code> instead of the more widely used
<code>::1</code>. Consult your access logs for the actual value.</p>
- <p>See also: <a href="#Remote_Host_Filter">Remote Host Filter</a>,
+ <p>See also: <a href="#Remote_Host_Valve">Remote Host Valve</a>,
<a href="#Remote_IP_Valve">Remote IP Valve</a>.</p>
</subsection>
<subsection name="Attributes">
- <p>The <strong>Remote Address Filter</strong> supports the following
+ <p>The <strong>Remote Address Valve</strong> supports the following
configuration attributes:</p>
<attributes>
@@ -602,15 +602,15 @@
</subsection>
-<subsection name="Remote Host Filter">
+<subsection name="Remote Host Valve">
<subsection name="Introduction">
- <p>The <strong>Remote Host Filter</strong> allows you to compare the
+ <p>The <strong>Remote Host Valve</strong> allows you to compare the
hostname of the client that submitted this request against one or more
<em>regular expressions</em>, and either allow the request to continue
or refuse to process the request from this client. A Remote Host
- Filter can be associated with any Catalina container
+ Valve can be associated with any Catalina container
(<a href="engine.html">Engine</a>, <a href="host.html">Host</a>, or
<a href="context.html">Context</a>), and must accept any request
presented to this container for processing before it will be passed on.</p>
@@ -633,13 +633,13 @@
to return proper host names, you have to enable "DNS lookups" feature on
a <strong>Connector</strong>.</p>
- <p>See also: <a href="#Remote_Address_Filter">Remote Address Filter</a>,
+ <p>See also: <a href="#Remote_Address_Valve">Remote Address Valve</a>,
<a href="http.html">HTTP Connector</a> configuration.</p>
</subsection>
<subsection name="Attributes">
- <p>The <strong>Remote Host Filter</strong> supports the following
+ <p>The <strong>Remote Host Valve</strong> supports the following
configuration attributes:</p>
<attributes>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org