com.dropbox.core

Class DbxRequestConfig

java.lang.Object

com.dropbox.core.DbxRequestConfig

public class DbxRequestConfig
extends Object

A grouping of a few configuration parameters for how we should make requests to the Dropbox servers.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbxRequestConfig.Builder Builder for DbxRequestConfig.

Constructor Summary

Constructors

Constructor and Description
DbxRequestConfig(String clientIdentifier) Creates a new configuration.
DbxRequestConfig(String clientIdentifier, String userLocale) Deprecated. Use newBuilder(java.lang.String) to customize configuration
DbxRequestConfig(String clientIdentifier, String userLocale, HttpRequestor httpRequestor) Deprecated. Use newBuilder(java.lang.String) to customize configuration

Method Summary

Modifier and Type	Method and Description
DbxRequestConfig.Builder	copy() Returns a builder for building a copy of this configuration.
String	getClientIdentifier() Returns an identifier for the API client, typically of the form "Name/Version".
HttpRequestor	getHttpRequestor() The HttpRequestor implementation to use when making HTTP requests to the Dropbox API servers.
int	getMaxRetries() Returns the maximum number of times the client should automatically retry RPC and download requests that fail with a RetryException.
String	getUserLocale() Returns the locale of the user of your app as an IETF BCP 47 language tag.
boolean	isAutoRetryEnabled() Returns whether or not the client should automatically retry RPC and download requests after recieving a RetryException.
static DbxRequestConfig.Builder	newBuilder(String clientIdentifier) Returns a new builder for creating a DbxRequestConfig instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

DbxRequestConfig

public DbxRequestConfig(String clientIdentifier)

Creates a new configuration.

Parameters:

clientIdentifier - client identifier typically in the form "Name/Version" to be used in the User-Agent header (see getClientIdentifier()).

DbxRequestConfig

@Deprecated
public DbxRequestConfig(String clientIdentifier,
                                    String userLocale)

Deprecated. Use newBuilder(java.lang.String) to customize configuration

Creates a new configuration.

Parameters:

clientIdentifier - client identifier typically in the form "Name/Version" to be used in the User-Agent header (see getClientIdentifier()).

userLocale - IETF BCP 47 language tag of locale to use for user-visible text in responses, or null to use the user's Dropbox locale preference.

DbxRequestConfig

@Deprecated
public DbxRequestConfig(String clientIdentifier,
                                    String userLocale,
                                    HttpRequestor httpRequestor)

Deprecated. Use newBuilder(java.lang.String) to customize configuration

Creates a new configuration.

Parameters:

clientIdentifier - client identifier typically in the form "Name/Version" to be used in the User-Agent header (see getClientIdentifier()).

userLocale - IETF BCP 47 language tag of locale to use for user-visible text in responses, or null to use the user's Dropbox locale preference.

httpRequestor - HTTP client to use for issuing requests.

Method Detail

getClientIdentifier

public String getClientIdentifier()

Returns an identifier for the API client, typically of the form "Name/Version". This is used to set the HTTP User-Agent header when making API requests. Example: "PhotoEditServer/1.3"

If you're the author a higher-level library on top of the basic SDK, and the "Photo Edit" Android app is using your library to access Dropbox, you should append your library's name and version to form the full identifier. For example, if your library is called "File Picker", you might set this field to: "PhotoEditAndroid/2.4 FilePicker/0.1-beta"

The exact format of the User-Agent header is described in section 3.8 of the HTTP specification.

Note that the underlying HttpRequestor may append other things to the User-Agent, such as the name of the library being used to actually make the HTTP request, or the version of the Java VM.

Returns:

HTTP User-Agent identifier for the API client

getUserLocale

public String getUserLocale()

Returns the locale of the user of your app as an IETF BCP 47 language tag. This is used by the Dropbox server to localize user-visible strings returned by API calls.

If the value is null or some locale that Dropbox doesn't support, the strings will be localized based on the user's Dropbox locale preference.

Defaults to null.

Returns:

locale of app user, or null to use user's Dropbox locale settings.

getHttpRequestor

public HttpRequestor getHttpRequestor()

The HttpRequestor implementation to use when making HTTP requests to the Dropbox API servers.

Defaults to StandardHttpRequestor.INSTANCE.

Returns:

HTTP requestor to use for issuing HTTP requests.

isAutoRetryEnabled

public boolean isAutoRetryEnabled()

Returns whether or not the client should automatically retry RPC and download requests after recieving a RetryException.

If enabled, the client will retry the request a max number of times (specified by getMaxRetries()) before propagating the RetryException.

Defaults to false (the client will not automatically retry any requests).

Returns:

whether this client will automatically retry requests that fail with a RetryException

getMaxRetries

public int getMaxRetries()

Returns the maximum number of times the client should automatically retry RPC and download requests that fail with a RetryException.

This value does not count the initial request attempt. For example, if maximum retries is 3, the client may issue a request a total of 4 times: once for the initial call, then 3 additional times for the 3 retries.

This value is ignored unless isAutoRetryEnabled() is true.

The value returned by this method is always positive if retries are enabled, otherwise it is 0.

Defaults to 3 when retries are enabled.

Returns:

maximum number of times the client will retry a request that throws a RetryException.

copy

public DbxRequestConfig.Builder copy()

Returns a builder for building a copy of this configuration. Useful for modifying an existing configuration.

Returns:

builder configured to build a copy of this instance

newBuilder

public static DbxRequestConfig.Builder newBuilder(String clientIdentifier)

Returns a new builder for creating a DbxRequestConfig instance. Identifiers are typically of the form "Name/Version" (e.g. "PhotoEditServer/1.3"). See getClientIdentifier() for more details.

Parameters:

clientIdentifier - HTTP User-Agent identifier for the API app (see getClientIdentifier()), never null