Package com.dropbox.core.http

Class StandardHttpRequestor.Config

java.lang.Object

com.dropbox.core.http.StandardHttpRequestor.Config

Enclosing class:

StandardHttpRequestor

public static final class StandardHttpRequestor.Config
extends Object

Configuration for StandardHttpRequestor that determines how network connections to the server are established. Use this class to configure timeouts and proxy settings. Some requests may require different connection settings than others. Create multiple StandardHttpRequestor objects with different configurations to handle these requests. For example, calls to DbxUserFilesRequests.listFolderLongpoll(String,long) should use a StandardHttpRequestor with its read timeout (see StandardHttpRequestor.Config.Builder.withReadTimeout(long, java.util.concurrent.TimeUnit)) set longer than the longpoll timeout.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StandardHttpRequestor.Config.Builder	Builder for StandardHttpRequestor.Config.

Field Summary

Fields

Modifier and Type	Field	Description
static final StandardHttpRequestor.Config	DEFAULT_INSTANCE	StandardHttpRequestor.Config with all its attributes set to their default values.

Method Summary

Modifier and Type	Method	Description
static StandardHttpRequestor.Config.Builder	builder()	Returns a new builder for creating a StandardHttpRequestor.Config.
StandardHttpRequestor.Config.Builder	copy()	Returns a new builder for creating a copy of this config.
long	getConnectTimeoutMillis()	Returns the timeout, in milliseconds, for opening a connection to the servers.
Proxy	getProxy()	Returns the proxy configuration for network connections.
long	getReadTimeoutMillis()	Returns the timeout, in milliseconds, for receiving a response from the servers.
SSLSocketFactory	getSslSocketFactory()	Returns the SSLSocketFactory if provided.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_INSTANCE

public static final StandardHttpRequestor.Config DEFAULT_INSTANCE

StandardHttpRequestor.Config with all its attributes set to their default values.

Method Details

getProxy

public Proxy getProxy()

Returns the proxy configuration for network connections.

Returns:

proxy configuration to use for network connections.

getConnectTimeoutMillis

public long getConnectTimeoutMillis()

Returns the timeout, in milliseconds, for opening a connection to the servers. If the timeout is 0, then connect timeouts are disabled.

Returns:

timeout, in milliseconds, for opening connections to the servers.

getReadTimeoutMillis

public long getReadTimeoutMillis()

Returns the timeout, in milliseconds, for receiving a response from the servers. If the timeout is 0, then read timeouts are disabled.

Returns:

timeout, in milliseconds, for receiving a response from the server.

getSslSocketFactory

@Nullable
public SSLSocketFactory getSslSocketFactory()

Returns the SSLSocketFactory if provided. This is to be used for certificate pinning and other custom SSL configurations.

Returns:

SSLSocketFactory or null.

copy

public StandardHttpRequestor.Config.Builder copy()

Returns a new builder for creating a copy of this config. The builder is configured to use this config's values as its default.

Returns:

builder for creating a copy of this config.

builder

public static StandardHttpRequestor.Config.Builder builder()

Returns a new builder for creating a StandardHttpRequestor.Config.

Returns:

builder for creating an instance of this class