Apache
/
httpcomponents-client
mirror of https://github.com/apache/httpcomponents-client.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixed javadocs 

git-svn-id: https://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk@1434000 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Oleg Kalnichevski 2013-01-16 15:54:44 +00:00
parent 3ebbcab3b4
commit 2ea3298894
6 changed files with 23 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
httpclient-cache/src/main/java/org/apache/http/impl/client/cache/CacheConfig.java vendored
View File

@ -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 Cloneable {
* 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 Cloneable {
/**
* 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 Cloneable {
/**
* 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 Cloneable {
* 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 Cloneable {
/**
* 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;
}

4
httpclient/src/main/java/org/apache/http/conn/ConnectTimeoutException.java
View File

@ -54,8 +54,6 @@ public class ConnectTimeoutException extends InterruptedIOException {
/**
* 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 extends InterruptedIOException {
/**
* 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) {

4
httpclient/src/main/java/org/apache/http/conn/socket/ConnectionSocketFactory.java
View File

@ -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
*

5
httpclient/src/main/java/org/apache/http/conn/ssl/SSLSocketFactory.java
View File

@ -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 LayeredConnectionSocketFactory, SchemeL
/**
* @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(

2
httpclient/src/main/java/org/apache/http/impl/client/BasicAuthCache.java
View File

@ -50,8 +50,6 @@ public class BasicAuthCache implements AuthCache {
/**
* Default constructor.
*
* @param schemeRegistry the scheme registry to resolve default port by scheme name.
*
* @since 4.3
*/
public BasicAuthCache(final SchemePortResolver schemePortResolver) {

7
httpclient/src/main/java/org/apache/http/impl/client/ProxyClient.java
View File

@ -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);
}