com.dropbox.core.DbxRequestConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation
A client library for Dropbox's HTTP-based "Core API".
The newest version!
package com.dropbox.core;

import com.dropbox.core.http.HttpRequestor;
import com.dropbox.core.http.StandardHttpRequestor;

import java.util.HashSet;
import java.util.Locale;
import java.util.Set;

/**
 * A grouping of a few configuration parameters for how we should make requests to the
 * Dropbox servers.
 */
public class DbxRequestConfig
{
    /**
     * An identifier for the API client, typically of the form "Name/Version".
     * This is used to set the HTTP {@code User-Agent} header when making API requests.
     * Example: {@code "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:
     * {@code "PhotoEditAndroid/2.4 FilePicker/0.1-beta"}
     * 
     *
     * 
     * The exact format of the {@code User-Agent} header is described in
     * section 3.8 of the HTTP specification.
     * 
     *
     * 
     * Note that the underlying {@link com.dropbox.core.http.HttpRequestor HttpRequestor} may
     * append other things to the {@code User-Agent}, such as the name of the library being used to
     * actually make the HTTP request, or the version of the Java VM.
     * 
     */
    public final String clientIdentifier;

    /**
     * The locale of the user of your app.  This is used by the Dropbox server to localize
     * user-visible strings returned by API calls.  For example,
     * {@link com.dropbox.core.DbxEntry.File#humanSize} is a localized string.
     *
     * 
     * If the value is {@code null} or some locale that Dropbox doesn't support, English will
     * be used.
     * 
     */
	public final String userLocale;

    /**
     * The {@link HttpRequestor} implementation to use when making
     * HTTP requests to the Dropbox API servers.  If you don't specify one, this defaults to
     * {@link StandardHttpRequestor#Instance}.
     */
    public final HttpRequestor httpRequestor;

    /**
     * @param clientIdentifier {@link #clientIdentifier}
     * @param userLocale {@link #userLocale}
     * @param httpRequestor {@link #httpRequestor}
     */
    public DbxRequestConfig(String clientIdentifier, String userLocale, HttpRequestor httpRequestor)
    {
        if (clientIdentifier == null) throw new IllegalArgumentException("'clientIdentifier' should not be null");
        if (httpRequestor == null) throw new IllegalArgumentException("'httpRequestor' should not be null");

        this.clientIdentifier = clientIdentifier;
        this.userLocale = userLocale;
        this.httpRequestor = httpRequestor;
    }

    /**
     * @param clientIdentifier {@link #clientIdentifier}
     * @param userLocale {@link #userLocale}
     */
    public DbxRequestConfig(String clientIdentifier, String userLocale)
    {
        this(clientIdentifier, userLocale, StandardHttpRequestor.Instance);
    }
}