com.salesforce.androidsdk.rest

Class RestClient

java.lang.Object

com.salesforce.androidsdk.rest.RestClient

public class RestClient
extends java.lang.Object

RestClient allows you to send authenticated HTTP requests to a force.com server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RestClient.AsyncRequestCallback AsyncRequestCallback interface.
static interface	RestClient.AuthTokenProvider AuthTokenProvider interface.
static class	RestClient.ClientInfo All immutable information for an authenticated client (e.g.
static class	RestClient.OAuthRefreshInterceptor Network interceptor that does oauth refresh and request retry when access token has expired.
static class	RestClient.RefreshTokenRevokedException Exception thrown when refresh token was found to be revoked
static class	RestClient.UnauthenticatedClientInfo Use a unauthenticated client info when do not need authentication support (e.g.

Constructor Summary

Constructors

Constructor and Description
RestClient(RestClient.ClientInfo clientInfo, java.lang.String authToken, HttpAccess httpAccessor, RestClient.AuthTokenProvider authTokenProvider) Constructs a RestClient with the given clientInfo, authToken, httpAccessor and authTokenProvider.

Method Summary

Modifier and Type	Method and Description
Request	buildRequest(RestRequest restRequest) Helper to build okHttp Request from RestRequest
static void	clearCaches() Clear caches of org-id/user-id to OkHttpClient.Builder, OkHttpClient and OAuthRefreshInterceptor
static void	clearCaches(UserAccount userAccount) Remove cached OkHttpClient.Builder, OkHttpClient and OAuthRefreshInterceptor for the given user
java.lang.String	getAuthToken()
RestClient.ClientInfo	getClientInfo()
JSONObject	getJSONCredentials()
RestClient.OAuthRefreshInterceptor	getOAuthRefreshInterceptor()
OkHttpClient	getOkHttpClient()
OkHttpClient.Builder	getOkHttpClientBuilder()
java.lang.String	getRefreshToken()
Call	sendAsync(RestRequest restRequest, RestClient.AsyncRequestCallback callback) Send the given restRequest and process the result asynchronously with the given callback.
RestResponse	sendSync(RestRequest restRequest) Send the given restRequest synchronously and return a RestResponse Note: Cannot be used by code on the UI thread (use sendAsync instead).
RestResponse	sendSync(RestRequest restRequest, Interceptor... interceptors) Send the given restRequest synchronously and return a RestResponse Note: Cannot be used by code on the UI thread (use sendAsync instead).
void	setClientInfo(RestClient.ClientInfo clientInfo) Set the client info.
void	setOkHttpClient(OkHttpClient okHttpClient) Sets the OkHttpclient associated with this user account.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RestClient

public RestClient(RestClient.ClientInfo clientInfo,
                  java.lang.String authToken,
                  HttpAccess httpAccessor,
                  RestClient.AuthTokenProvider authTokenProvider)

Constructs a RestClient with the given clientInfo, authToken, httpAccessor and authTokenProvider. When it gets a 401 (not authorized) response from the server:

• If authTokenProvider is not null, it will ask the authTokenProvider for a new access token and retry the request a second time.
• Otherwise it will return the 401 response.

Parameters:

clientInfo -

authToken -

httpAccessor -

authTokenProvider -

Method Detail

clearCaches

public static void clearCaches(UserAccount userAccount)

Remove cached OkHttpClient.Builder, OkHttpClient and OAuthRefreshInterceptor for the given user

clearCaches

public static void clearCaches()

Clear caches of org-id/user-id to OkHttpClient.Builder, OkHttpClient and OAuthRefreshInterceptor

setOkHttpClient

public void setOkHttpClient(OkHttpClient okHttpClient)

Sets the OkHttpclient associated with this user account. The OkHttpclient are cached in a map and reused as and when a user account switch occurs, to prevent multiple threads being spawned unnecessarily.

setClientInfo

public void setClientInfo(RestClient.ClientInfo clientInfo)

Set the client info. Used by clients to implement Login As

Parameters:

clientInfo - The new client info to set

getJSONCredentials

public JSONObject getJSONCredentials()

Returns:

credentials as JSONObject

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getAuthToken

public java.lang.String getAuthToken()

Returns:

The authToken for this RestClient.

getRefreshToken

public java.lang.String getRefreshToken()

Returns:

The refresh token, if available.

getClientInfo

public RestClient.ClientInfo getClientInfo()

Returns:

The client info.

getOAuthRefreshInterceptor

public RestClient.OAuthRefreshInterceptor getOAuthRefreshInterceptor()

Returns:

underlying OAuthRefreshInterceptor

getOkHttpClientBuilder

public OkHttpClient.Builder getOkHttpClientBuilder()

Returns:

underlying OkHttpClient.Builder

getOkHttpClient

public OkHttpClient getOkHttpClient()

Returns:

underlying OkHttpClient

buildRequest

public Request buildRequest(RestRequest restRequest)

Helper to build okHttp Request from RestRequest

Parameters:

restRequest -

Returns:

sendAsync

public Call sendAsync(RestRequest restRequest,
                      RestClient.AsyncRequestCallback callback)

Send the given restRequest and process the result asynchronously with the given callback. Note: Intended to be used by code on the UI thread.

Parameters:

restRequest -

callback -

Returns:

okHttp Call object (through which you can cancel the request or get the request back)

sendSync

public RestResponse sendSync(RestRequest restRequest)
                      throws java.io.IOException

Send the given restRequest synchronously and return a RestResponse Note: Cannot be used by code on the UI thread (use sendAsync instead).

Parameters:

restRequest -

Returns:

Throws:

java.io.IOException

sendSync

public RestResponse sendSync(RestRequest restRequest,
                             Interceptor... interceptors)
                      throws java.io.IOException

Send the given restRequest synchronously and return a RestResponse Note: Cannot be used by code on the UI thread (use sendAsync instead).

Parameters:

restRequest -

interceptors - Interceptor(s) to add to the network client before making the request

Returns:

Throws:

java.io.IOException