com.salesforce.androidsdk.rest

Class RestClient.OAuthRefreshInterceptor

java.lang.Object

com.salesforce.androidsdk.rest.RestClient.OAuthRefreshInterceptor

Enclosing class:

RestClient

public static class RestClient.OAuthRefreshInterceptor
extends java.lang.Object

Network interceptor that does oauth refresh and request retry when access token has expired.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthToken()
long	getElapsedTimeSinceLastRefresh()
java.lang.String	getRefreshToken()
Response	intercept(Chain chain)
void	refreshAccessToken() Swaps the existing access token for a new one.
void	setClientInfo(RestClient.ClientInfo clientInfo)

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthRefreshInterceptor

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

Constructs a SalesforceHttpInterceptor with the given clientInfo, authToken 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 -

authTokenProvider -

Method Detail

intercept

public Response intercept(Chain chain)
                   throws java.io.IOException

Throws:

java.io.IOException

getAuthToken

public java.lang.String getAuthToken()

Returns:

The authToken for this RestClient.

getRefreshToken

public java.lang.String getRefreshToken()

Returns:

The refresh token, if available.

getElapsedTimeSinceLastRefresh

public long getElapsedTimeSinceLastRefresh()

Returns:

Elapsed time (ms) since the last refresh.

refreshAccessToken

public void refreshAccessToken()
                        throws java.io.IOException

Swaps the existing access token for a new one.

Throws:

java.io.IOException

setClientInfo

public void setClientInfo(RestClient.ClientInfo clientInfo)