com.salesforce.androidsdk.config

Class BootConfig

java.lang.Object

com.salesforce.androidsdk.config.BootConfig

public class BootConfig
extends java.lang.Object

Class encapsulating the application configuration (consumer key, oauth scopes, refresh behavior).

Author:

wmathurin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BootConfig.BootConfigException Exception thrown for all bootconfig parsing errors.

Constructor Summary

Constructors

Constructor and Description
BootConfig()

Method Summary

Modifier and Type	Method and Description
JSONObject	asJSON()
boolean	attemptOfflineLoad() Returns whether the app should attempt to load cached content when offline.
static BootConfig	getBootConfig(Context ctx) Method to (build and) get the singleton instance.
java.lang.String	getErrorPage() Returns the path to the local error page.
java.lang.String	getOauthRedirectURI() Returns the redirect URI value specified for your remote access object or connected app.
java.lang.String[]	getOauthScopes() Returns the authorization/access scope(s) that the application needs to ask for at login.
java.lang.String	getRemoteAccessConsumerKey() Returns the consumer key value specified for your remote access object or connected app.
java.lang.String	getStartPage() Returns the path to the start page (local or remote).
java.lang.String	getUnauthenticatedStartPage() Returns the path to the optional unauthenticated start page (for remote deferred authentication).
static boolean	isAbsoluteUrl(java.lang.String urlString) Convenience method to determine whether a configured startPage value is an absolute URL.
boolean	isLocal() Returns if the start page is local or a VF page.
boolean	shouldAuthenticate() Returns whether the app should go through login flow the first time or not.
static void	validateBootConfig(BootConfig config) Validates a boot config's inputs against basic sanity tests.

Methods inherited from class java.lang.Object

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

Constructor Detail

BootConfig

public BootConfig()

Method Detail

getBootConfig

public static BootConfig getBootConfig(Context ctx)

Method to (build and) get the singleton instance.

Parameters:

ctx - Context.

Returns:

BootConfig instance.

validateBootConfig

public static void validateBootConfig(BootConfig config)

Validates a boot config's inputs against basic sanity tests.

Parameters:

config - The BootConfig instance to validate.

Throws:

BootConfig.BootConfigException - If the boot config is invalid.

asJSON

public JSONObject asJSON()

Returns:

boot config as JSONObject

getRemoteAccessConsumerKey

public java.lang.String getRemoteAccessConsumerKey()

Returns the consumer key value specified for your remote access object or connected app.

Returns:

Consumer key value specified for your remote access object or connected app.

getOauthRedirectURI

public java.lang.String getOauthRedirectURI()

Returns the redirect URI value specified for your remote access object or connected app.

Returns:

Redirect URI value specified for your remote access object or connected app.

getOauthScopes

public java.lang.String[] getOauthScopes()

Returns the authorization/access scope(s) that the application needs to ask for at login.

Returns:

Authorization/access scope(s) that the application needs to ask for at login.

isLocal

public boolean isLocal()

Returns if the start page is local or a VF page.

Returns:

True - if start page is in assets/www, False - if it's a VF page.

getStartPage

public java.lang.String getStartPage()

Returns the path to the start page (local or remote). Example: index.html or /apex/basicpage.

Returns:

Path to start page (local or remote).

getUnauthenticatedStartPage

public java.lang.String getUnauthenticatedStartPage()

Returns the path to the optional unauthenticated start page (for remote deferred authentication).

Returns:

URL of the unauthenticated start page.

isAbsoluteUrl

public static boolean isAbsoluteUrl(java.lang.String urlString)

Convenience method to determine whether a configured startPage value is an absolute URL.

Returns:

true if startPage is an absolute URL, false otherwise.

getErrorPage

public java.lang.String getErrorPage()

Returns the path to the local error page.

Returns:

Path to local error page.

shouldAuthenticate

public boolean shouldAuthenticate()

Returns whether the app should go through login flow the first time or not.

Returns:

True - if the app should go through login flow, False - otherwise.

attemptOfflineLoad

public boolean attemptOfflineLoad()

Returns whether the app should attempt to load cached content when offline.

Returns:

True - if the app should attempt to load cached content, False - otherwise.