You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hc.apache.org by ol...@apache.org on 2013/01/16 16:54:45 UTC
svn commit: r1434000 - in /httpcomponents/httpclient/trunk:
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/
httpclient/src/main/java/org/apache/http/conn/
httpclient/src/main/java/org/apache/http/conn/socket/
httpclient/src/main/java/...
Author: olegk
Date: Wed Jan 16 15:54:44 2013
New Revision: 1434000
URL: http://svn.apache.org/viewvc?rev=1434000&view=rev
Log:
Fixed javadocs
Modified:
httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheConfig.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectTimeoutException.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/socket/ConnectionSocketFactory.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ssl/SSLSocketFactory.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/BasicAuthCache.java
httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/ProxyClient.java
Modified: httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheConfig.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheConfig.java?rev=1434000&r1=1433999&r2=1434000&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheConfig.java (original)
+++ httpcomponents/httpclient/trunk/httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheConfig.java Wed Jan 16 15:54:44 2013
@@ -75,12 +75,12 @@ import org.apache.http.util.Args;
* <a href="http://tools.ietf.org/html/rfc5861">RFC5861</a>, which allows
* certain cache entry revalidations to happen in the background. You may
* want to tweak the settings for the {@link
- * CacheConfig#setAsynchronousWorkersCore() minimum} and {@link
- * CacheConfig#setAsynchronousWorkersMax() maximum} number of background
+ * CacheConfig#getAsynchronousWorkersCore() minimum} and {@link
+ * CacheConfig#getAsynchronousWorkersMax() maximum} number of background
* worker threads, as well as the {@link
- * CacheConfig#setAsynchronousWorkerIdleLifetimeSecs() maximum time they
+ * CacheConfig#getAsynchronousWorkerIdleLifetimeSecs() maximum time they
* can be idle before being reclaimed}. You can also control the {@link
- * CacheConfig#setRevalidationQueueSize() size of the queue} used for
+ * CacheConfig#getRevalidationQueueSize() size of the queue} used for
* revalidations when there aren't enough workers to keep up with demand.</b>
*/
public class CacheConfig implements Cloneable {
@@ -571,7 +571,7 @@ public class CacheConfig implements Clon
* either the request or origin response will override this, as will
* the heuristic {@code Last-Modified} freshness calculation if it is
* available.
- * @param heuristicDefaultLifetimeSecs is the number of seconds to
+ * @param heuristicDefaultLifetime is the number of seconds to
* consider a cache-eligible response fresh in the absence of other
* information. Set this to {@code 0} to disable this style of
* heuristic caching.
@@ -595,7 +595,7 @@ public class CacheConfig implements Clon
/**
* Sets the maximum number of threads to allow for background
* revalidations due to the {@code stale-while-revalidate} directive.
- * @param max number of threads; a value of 0 disables background
+ * @param asynchronousWorkersMax number of threads; a value of 0 disables background
* revalidations.
*/
public Builder setAsynchronousWorkersMax(final int asynchronousWorkersMax) {
@@ -606,7 +606,7 @@ public class CacheConfig implements Clon
/**
* Sets the minimum number of threads to keep alive for background
* revalidations due to the {@code stale-while-revalidate} directive.
- * @param min should be greater than zero and less than or equal
+ * @param asynchronousWorkersCore should be greater than zero and less than or equal
* to <code>getAsynchronousWorkersMax()</code>
*/
public Builder setAsynchronousWorkersCore(final int asynchronousWorkersCore) {
@@ -619,7 +619,7 @@ public class CacheConfig implements Clon
* background revalidation worker thread. If a worker thread is idle
* for this long, and there are more than the core number of worker
* threads alive, the worker will be reclaimed.
- * @param secs idle lifetime in seconds
+ * @param asynchronousWorkerIdleLifetimeSecs idle lifetime in seconds
*/
public Builder setAsynchronousWorkerIdleLifetimeSecs(final int asynchronousWorkerIdleLifetimeSecs) {
this.asynchronousWorkerIdleLifetimeSecs = asynchronousWorkerIdleLifetimeSecs;
@@ -636,13 +636,14 @@ public class CacheConfig implements Clon
/**
* Sets whether the cache should never cache HTTP 1.0 responses with a query string or not.
- * @param neverCache1_0ResponsesWithQueryString true to never cache responses with a query
+ * @param neverCacheHTTP10ResponsesWithQuery true to never cache responses with a query
* string, false to cache if explicit cache headers are found. Set this to {@code true}
* to better emulate IE, which also never caches responses, regardless of what caching
* headers may be present.
*/
- public Builder setNeverCacheHTTP10ResponsesWithQueryString(final boolean b) {
- this.neverCacheHTTP10ResponsesWithQuery = b;
+ public Builder setNeverCacheHTTP10ResponsesWithQueryString(
+ final boolean neverCacheHTTP10ResponsesWithQuery) {
+ this.neverCacheHTTP10ResponsesWithQuery = neverCacheHTTP10ResponsesWithQuery;
return this;
}
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectTimeoutException.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectTimeoutException.java?rev=1434000&r1=1433999&r2=1434000&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectTimeoutException.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ConnectTimeoutException.java Wed Jan 16 15:54:44 2013
@@ -54,8 +54,6 @@ public class ConnectTimeoutException ext
/**
* Creates a ConnectTimeoutException with the specified detail message.
- *
- * @param message The exception detail message
*/
public ConnectTimeoutException(final String message) {
super(message);
@@ -64,8 +62,6 @@ public class ConnectTimeoutException ext
/**
* Creates a ConnectTimeoutException with the specified detail message.
*
- * @param message The exception detail message
- *
* @since 4.3
*/
public ConnectTimeoutException(final HttpHost host, final InetSocketAddress remoteAddress) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/socket/ConnectionSocketFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/socket/ConnectionSocketFactory.java?rev=1434000&r1=1433999&r2=1434000&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/socket/ConnectionSocketFactory.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/socket/ConnectionSocketFactory.java Wed Jan 16 15:54:44 2013
@@ -44,8 +44,8 @@ public interface ConnectionSocketFactory
/**
* Creates new, unconnected socket. The socket should subsequently be passed to
- * {@link #connectSocket(Socket, SocketConfig, HttpHost, InetSocketAddress, InetSocketAddress,
- * HttpContext))}.
+ * {@link #connectSocket(int, Socket, HttpHost, InetSocketAddress, InetSocketAddress,
+ * HttpContext)}.
*
* @return a new socket
*
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ssl/SSLSocketFactory.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ssl/SSLSocketFactory.java?rev=1434000&r1=1433999&r2=1434000&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ssl/SSLSocketFactory.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/conn/ssl/SSLSocketFactory.java Wed Jan 16 15:54:44 2013
@@ -54,7 +54,6 @@ import javax.net.ssl.X509TrustManager;
import org.apache.http.HttpHost;
import org.apache.http.annotation.ThreadSafe;
-import org.apache.http.config.SocketConfig;
import org.apache.http.conn.ConnectTimeoutException;
import org.apache.http.conn.HttpInetSocketAddress;
import org.apache.http.conn.scheme.HostNameResolver;
@@ -525,8 +524,8 @@ public class SSLSocketFactory implements
/**
* @since 4.1
*
- * @deprecated (4.3) use {@link #connectSocket(Socket, SocketConfig, HttpHost,
- * InetSocketAddress, InetSocketAddress, HttpContext)}
+ * @deprecated (4.3) use {@link #connectSocket(int, Socket, HttpHost, InetSocketAddress,
+ * InetSocketAddress, HttpContext)}
*/
@Deprecated
public Socket connectSocket(
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/BasicAuthCache.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/BasicAuthCache.java?rev=1434000&r1=1433999&r2=1434000&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/BasicAuthCache.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/BasicAuthCache.java Wed Jan 16 15:54:44 2013
@@ -50,8 +50,6 @@ public class BasicAuthCache implements A
/**
* Default constructor.
*
- * @param schemeRegistry the scheme registry to resolve default port by scheme name.
- *
* @since 4.3
*/
public BasicAuthCache(final SchemePortResolver schemePortResolver) {
Modified: httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/ProxyClient.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/ProxyClient.java?rev=1434000&r1=1433999&r2=1434000&view=diff
==============================================================================
--- httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/ProxyClient.java (original)
+++ httpcomponents/httpclient/trunk/httpclient/src/main/java/org/apache/http/impl/client/ProxyClient.java Wed Jan 16 15:54:44 2013
@@ -129,6 +129,13 @@ public class ProxyClient {
HttpClientParamConfig.getRequestConfig(params));
}
+ /**
+ * @since 4.3
+ */
+ public ProxyClient(final RequestConfig requestConfig) {
+ this(null, null, requestConfig);
+ }
+
public ProxyClient() {
this(null, null, null);
}