com.salesforce.androidsdk.auth

Class HttpAccess

java.lang.Object

com.salesforce.androidsdk.auth.HttpAccess

public class HttpAccess
extends java.lang.Object

Generic HTTP Access layer - used internally by RestClient and OAuth2. This class watches network changes as well.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpAccess.NoNetworkException Exception thrown if the device is offline, during an attempted HTTP call.
static class	HttpAccess.UserAgentInterceptor Interceptor that adds user agent header

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONNECT_TIMEOUT
static HttpAccess	DEFAULT
static int	READ_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
HttpAccess(Context app, java.lang.String userAgent) Parameterized constructor.

Method Summary

Modifier and Type	Method and Description
OkHttpClient.Builder	createNewClientBuilder() Creates a new OkHttp Client Builder with appropriate connection spec and user agent interceptor.
OkHttpClient	getOkHttpClient()
OkHttpClient.Builder	getOkHttpClientBuilder() Deprecated. To be removed in 14.0. Please use createNewClientBuilder() instead.
OkHttpClient.Builder	getUnauthenticatedOkHttpBuilder() Deprecated. To be removed in 14.0. Please use createNewClientBuilder() instead.
java.lang.String	getUserAgent() Returns the current user agent.
boolean	hasNetwork() Returns the status of network connectivity.
static void	init(Context app) Initializes HttpAccess.

Methods inherited from class java.lang.Object

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

Field Detail

CONNECT_TIMEOUT

public static final int CONNECT_TIMEOUT

See Also:

Constant Field Values

READ_TIMEOUT

public static final int READ_TIMEOUT

See Also:

Constant Field Values

DEFAULT

public static HttpAccess DEFAULT

Constructor Detail

HttpAccess

public HttpAccess(Context app,
                  java.lang.String userAgent)

Parameterized constructor.

Parameters:

app - Reference to the application.

userAgent - The user agent to be used with requests.

Method Detail

init

public static void init(Context app)

Initializes HttpAccess. Should be called from the application.

getOkHttpClientBuilder

@Deprecated
public OkHttpClient.Builder getOkHttpClientBuilder()

Deprecated. To be removed in 14.0. Please use createNewClientBuilder() instead.

Returns:

okHttpClient.Builder with appropriate connection spec and user agent interceptor for an authenticated client.

getUnauthenticatedOkHttpBuilder

@Deprecated
public OkHttpClient.Builder getUnauthenticatedOkHttpBuilder()

Deprecated. To be removed in 14.0. Please use createNewClientBuilder() instead.

Returns:

okHttpClient.Builder with appropriate connection spec and user agent interceptor for an unauthenticated client.

createNewClientBuilder

public OkHttpClient.Builder createNewClientBuilder()

Creates a new OkHttp Client Builder with appropriate connection spec and user agent interceptor.

Returns:

the okHttpClient.Builder

getOkHttpClient

public OkHttpClient getOkHttpClient()

Returns:

okHttpClient tied to this HttpAccess - builds one if needed

hasNetwork

public boolean hasNetwork()

Returns the status of network connectivity.

Returns:

True - if network connectivity is available, False - otherwise.

getUserAgent

public java.lang.String getUserAgent()

Returns the current user agent.

Returns:

User agent.