com.dropbox.core

Class DbxRequestUtil

java.lang.Object

com.dropbox.core.DbxRequestUtil

public final class DbxRequestUtil
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DbxRequestUtil.RequestMaker<T,E extends Throwable>
static class	DbxRequestUtil.ResponseHandler<T>

Constructor Summary

Constructors

Constructor and Description
DbxRequestUtil()

Method Summary

Modifier and Type	Method and Description
static List<HttpRequestor.Header>	addAuthHeader(List<HttpRequestor.Header> headers, String accessToken)
static List<HttpRequestor.Header>	addBasicAuthHeader(List<HttpRequestor.Header> headers, String username, String password)
static List<HttpRequestor.Header>	addSelectUserHeader(List<HttpRequestor.Header> headers, String memberId)
static List<HttpRequestor.Header>	addUserAgentHeader(List<HttpRequestor.Header> headers, DbxRequestConfig requestConfig, String sdkUserAgentIdentifier)
static List<HttpRequestor.Header>	addUserLocaleHeader(List<HttpRequestor.Header> headers, DbxRequestConfig requestConfig)
static String	buildUri(String host, String path)
static String	buildUrlWithParams(String userLocale, String host, String path, String[] params)
static HttpRequestor.Header	buildUserAgentHeader(DbxRequestConfig requestConfig, String sdkUserAgentIdentifier)
static <T> T	doGet(DbxRequestConfig requestConfig, String accessToken, String sdkUserAgentIdentifier, String host, String path, String[] params, List<HttpRequestor.Header> headers, DbxRequestUtil.ResponseHandler<T> handler)
static <T> T	doPost(DbxRequestConfig requestConfig, String accessToken, String sdkUserAgentIdentifier, String host, String path, String[] params, List<HttpRequestor.Header> headers, DbxRequestUtil.ResponseHandler<T> handler)
static <T> T	doPostNoAuth(DbxRequestConfig requestConfig, String sdkUserAgentIdentifier, String host, String path, String[] params, List<HttpRequestor.Header> headers, DbxRequestUtil.ResponseHandler<T> handler)
static String	encodeUrlParam(String s)
static <T> T	finishResponse(HttpRequestor.Response response, DbxRequestUtil.ResponseHandler<T> handler)
static String	getFirstHeader(HttpRequestor.Response response, String name)
static String	getFirstHeaderMaybe(HttpRequestor.Response response, String name)
static String	getRequestId(HttpRequestor.Response response)
static byte[]	loadErrorBody(HttpRequestor.Response response)
static String	parseErrorBody(String requestId, int statusCode, byte[] body)
static <T> T	readJsonFromResponse(JsonReader<T> reader, HttpRequestor.Response response)
static <T,E extends Throwable> T	runAndRetry(int maxRetries, DbxRequestUtil.RequestMaker<T,E> requestMaker)
static HttpRequestor.Response	startGet(DbxRequestConfig requestConfig, String accessToken, String sdkUserAgentIdentifier, String host, String path, String[] params, List<HttpRequestor.Header> headers) Convenience function for making HTTP GET requests.
static HttpRequestor.Response	startPostNoAuth(DbxRequestConfig requestConfig, String sdkUserAgentIdentifier, String host, String path, String[] params, List<HttpRequestor.Header> headers) Convenience function for making HTTP POST requests.
static HttpRequestor.Response	startPostRaw(DbxRequestConfig requestConfig, String sdkUserAgentIdentifier, String host, String path, byte[] body, List<HttpRequestor.Header> headers) Convenience function for making HTTP POST requests.
static HttpRequestor.Uploader	startPut(DbxRequestConfig requestConfig, String accessToken, String sdkUserAgentIdentifier, String host, String path, String[] params, List<HttpRequestor.Header> headers) Convenience function for making HTTP PUT requests.
static DbxException	unexpectedStatus(HttpRequestor.Response response)

Methods inherited from class java.lang.Object

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

Constructor Detail

DbxRequestUtil

public DbxRequestUtil()

Method Detail

encodeUrlParam

public static String encodeUrlParam(String s)

buildUrlWithParams

public static String buildUrlWithParams(String userLocale,
                                        String host,
                                        String path,
                                        String[] params)

buildUri

public static String buildUri(String host,
                              String path)

addAuthHeader

public static List<HttpRequestor.Header> addAuthHeader(List<HttpRequestor.Header> headers,
                                                       String accessToken)

addSelectUserHeader

public static List<HttpRequestor.Header> addSelectUserHeader(List<HttpRequestor.Header> headers,
                                                             String memberId)

addBasicAuthHeader

public static List<HttpRequestor.Header> addBasicAuthHeader(List<HttpRequestor.Header> headers,
                                                            String username,
                                                            String password)

addUserAgentHeader

public static List<HttpRequestor.Header> addUserAgentHeader(List<HttpRequestor.Header> headers,
                                                            DbxRequestConfig requestConfig,
                                                            String sdkUserAgentIdentifier)

addUserLocaleHeader

public static List<HttpRequestor.Header> addUserLocaleHeader(List<HttpRequestor.Header> headers,
                                                             DbxRequestConfig requestConfig)

buildUserAgentHeader

public static HttpRequestor.Header buildUserAgentHeader(DbxRequestConfig requestConfig,
                                                        String sdkUserAgentIdentifier)

startGet

public static HttpRequestor.Response startGet(DbxRequestConfig requestConfig,
                                              String accessToken,
                                              String sdkUserAgentIdentifier,
                                              String host,
                                              String path,
                                              String[] params,
                                              List<HttpRequestor.Header> headers)
                                       throws NetworkIOException

Convenience function for making HTTP GET requests.

Throws:

NetworkIOException

startPut

public static HttpRequestor.Uploader startPut(DbxRequestConfig requestConfig,
                                              String accessToken,
                                              String sdkUserAgentIdentifier,
                                              String host,
                                              String path,
                                              String[] params,
                                              List<HttpRequestor.Header> headers)
                                       throws NetworkIOException

Convenience function for making HTTP PUT requests.

Throws:

NetworkIOException

startPostNoAuth

public static HttpRequestor.Response startPostNoAuth(DbxRequestConfig requestConfig,
                                                     String sdkUserAgentIdentifier,
                                                     String host,
                                                     String path,
                                                     String[] params,
                                                     List<HttpRequestor.Header> headers)
                                              throws NetworkIOException

Convenience function for making HTTP POST requests.

Throws:

NetworkIOException

startPostRaw

public static HttpRequestor.Response startPostRaw(DbxRequestConfig requestConfig,
                                                  String sdkUserAgentIdentifier,
                                                  String host,
                                                  String path,
                                                  byte[] body,
                                                  List<HttpRequestor.Header> headers)
                                           throws NetworkIOException

Convenience function for making HTTP POST requests. Like startPostNoAuth but takes byte[] instead of params.

Throws:

NetworkIOException

loadErrorBody

public static byte[] loadErrorBody(HttpRequestor.Response response)
                            throws NetworkIOException

Throws:

NetworkIOException

parseErrorBody

public static String parseErrorBody(String requestId,
                                    int statusCode,
                                    byte[] body)
                             throws BadResponseException

Throws:

BadResponseException

unexpectedStatus

public static DbxException unexpectedStatus(HttpRequestor.Response response)
                                     throws NetworkIOException,
                                            BadResponseException

Throws:

NetworkIOException

BadResponseException

readJsonFromResponse

public static <T> T readJsonFromResponse(JsonReader<T> reader,
                                         HttpRequestor.Response response)
                                  throws BadResponseException,
                                         NetworkIOException

Throws:

BadResponseException

NetworkIOException

doGet

public static <T> T doGet(DbxRequestConfig requestConfig,
                          String accessToken,
                          String sdkUserAgentIdentifier,
                          String host,
                          String path,
                          String[] params,
                          List<HttpRequestor.Header> headers,
                          DbxRequestUtil.ResponseHandler<T> handler)
                   throws DbxException

Throws:

DbxException

doPost

public static <T> T doPost(DbxRequestConfig requestConfig,
                           String accessToken,
                           String sdkUserAgentIdentifier,
                           String host,
                           String path,
                           String[] params,
                           List<HttpRequestor.Header> headers,
                           DbxRequestUtil.ResponseHandler<T> handler)
                    throws DbxException

Throws:

DbxException

doPostNoAuth

public static <T> T doPostNoAuth(DbxRequestConfig requestConfig,
                                 String sdkUserAgentIdentifier,
                                 String host,
                                 String path,
                                 String[] params,
                                 List<HttpRequestor.Header> headers,
                                 DbxRequestUtil.ResponseHandler<T> handler)
                          throws DbxException

Throws:

DbxException

finishResponse

public static <T> T finishResponse(HttpRequestor.Response response,
                                   DbxRequestUtil.ResponseHandler<T> handler)
                            throws DbxException

Throws:

DbxException

getFirstHeader

public static String getFirstHeader(HttpRequestor.Response response,
                                    String name)
                             throws BadResponseException

Throws:

BadResponseException

getFirstHeaderMaybe

public static String getFirstHeaderMaybe(HttpRequestor.Response response,
                                         String name)

getRequestId

public static String getRequestId(HttpRequestor.Response response)

runAndRetry

public static <T,E extends Throwable> T runAndRetry(int maxRetries,
                                                    DbxRequestUtil.RequestMaker<T,E> requestMaker)
                                             throws DbxException,
                                                    E extends Throwable

Throws:

DbxException

E extends Throwable