Package com.dropbox.core.v2

Class DbxRawClientV2

java.lang.Object

com.dropbox.core.v2.DbxRawClientV2

public abstract class DbxRawClientV2
extends Object

Use this class to make remote calls to the Dropbox API. You'll need an access token first, normally acquired via DbxWebAuth.

This class has no mutable state, so it's thread safe as long as you pass in a thread safe HttpRequestor implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	USER_AGENT_ID

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DbxRawClientV2(DbxRequestConfig requestConfig, DbxHost host, String userId, PathRoot pathRoot)

Method Summary

Modifier and Type	Method	Description
protected abstract void	addAuthHeaders(List<HttpRequestor.Header> headers)	Add the appropriate authentication headers to the request, if any.
protected abstract boolean	canRefreshAccessToken()
<ArgT, ResT, ErrT> DbxDownloader<ResT>	downloadStyle(String host, String path, ArgT arg, boolean noAuth, List<HttpRequestor.Header> extraHeaders, StoneSerializer<ArgT> argSerializer, StoneSerializer<ResT> responseSerializer, StoneSerializer<ErrT> errorSerializer)
DbxHost	getHost()	Returns the DbxHost that was passed in to the constructor.
DbxRequestConfig	getRequestConfig()	Returns the DbxRequestConfig that was passed in to the constructor.
String	getUserId()	Returns the userId that was passed in to the constructor.
protected abstract boolean	needsRefreshAccessToken()
abstract DbxRefreshResult	refreshAccessToken()
<ArgT, ResT, ErrT> ResT	rpcStyle(String host, String path, ArgT arg, boolean noAuth, StoneSerializer<ArgT> argSerializer, StoneSerializer<ResT> responseSerializer, StoneSerializer<ErrT> errorSerializer)
<ArgT> HttpRequestor.Uploader	uploadStyle(String host, String path, ArgT arg, boolean noAuth, StoneSerializer<ArgT> argSerializer)
protected abstract DbxRawClientV2	withPathRoot(PathRoot pathRoot)	Clone a new DbxRawClientV2 with Dropbox-API-Path-Root header.

Methods inherited from class java.lang.Object

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

Field Details

USER_AGENT_ID

public static final String USER_AGENT_ID

See Also:

• Constant Field Values

Constructor Details

DbxRawClientV2

protected DbxRawClientV2(DbxRequestConfig requestConfig,
 DbxHost host,
 String userId,
 PathRoot pathRoot)

Parameters:

requestConfig - Configuration controlling How requests should be issued to Dropbox servers.

host - Dropbox server hostnames (primarily for internal use)

userId - The user ID of the current Dropbox account. Used for multi-Dropbox account use-case.

pathRoot - We will send this value in Dropbox-API-Path-Root header if it presents.

Method Details

addAuthHeaders

protected abstract void addAuthHeaders(List<HttpRequestor.Header> headers)

Add the appropriate authentication headers to the request, if any.

Parameters:

headers - List of request headers. Add authentication headers to this list.

refreshAccessToken

public abstract DbxRefreshResult refreshAccessToken()
                                             throws DbxException

Throws:

DbxException

canRefreshAccessToken

protected abstract boolean canRefreshAccessToken()

needsRefreshAccessToken

protected abstract boolean needsRefreshAccessToken()

withPathRoot

protected abstract DbxRawClientV2 withPathRoot(PathRoot pathRoot)

Clone a new DbxRawClientV2 with Dropbox-API-Path-Root header.

Parameters:

pathRoot - pathRoot object containing the content for Dropbox-API-Path-Root header.

rpcStyle

public <ArgT,
ResT,
ErrT> ResT rpcStyle(String host,
 String path,
 ArgT arg,
 boolean noAuth,
 StoneSerializer<ArgT> argSerializer,
 StoneSerializer<ResT> responseSerializer,
 StoneSerializer<ErrT> errorSerializer)
                                 throws DbxWrappedException,
DbxException

Throws:

DbxWrappedException

DbxException

downloadStyle

public <ArgT,
ResT,
ErrT> DbxDownloader<ResT> downloadStyle(String host,
 String path,
 ArgT arg,
 boolean noAuth,
 List<HttpRequestor.Header> extraHeaders,
 StoneSerializer<ArgT> argSerializer,
 StoneSerializer<ResT> responseSerializer,
 StoneSerializer<ErrT> errorSerializer)
                                                     throws DbxWrappedException,
DbxException

Throws:

DbxWrappedException

DbxException

uploadStyle

public <ArgT> HttpRequestor.Uploader uploadStyle(String host,
 String path,
 ArgT arg,
 boolean noAuth,
 StoneSerializer<ArgT> argSerializer)
                                          throws DbxException

Throws:

DbxException

getRequestConfig

public DbxRequestConfig getRequestConfig()

Returns the DbxRequestConfig that was passed in to the constructor.

Returns:

configuration to use for issuing requests.

getHost

public DbxHost getHost()

Returns the DbxHost that was passed in to the constructor.

Returns:

Dropbox hosts to use for requests.

getUserId

public String getUserId()

Returns the userId that was passed in to the constructor.

Returns:

The user ID of the current Dropbox account.