com.ibm.mobilefirstplatform.clientsdk.android.core.api

Class BMSClient

java.lang.Object

AbstractClient

com.ibm.mobilefirstplatform.clientsdk.android.core.api.BMSClient

public class BMSClient
extends AbstractClient

The BMSClient is a singleton that serves as the entry point to MobileFirst.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HTTP_SCHEME
static java.lang.String	HTTPS_SCHEME
static java.lang.String	REGION_GERMANY
static java.lang.String	REGION_SYDNEY
static java.lang.String	REGION_TOKYO
static java.lang.String	REGION_UK
static java.lang.String	REGION_US_EAST
static java.lang.String	REGION_US_SOUTH

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBluemixAppGUID() Deprecated. As of release 2.2.0. if you use the new initialize methoud this function return null. Will be removed as release 3.x
java.lang.String	getBluemixAppRoute() Deprecated. As of release 2.2.0. if you use the new initialize methoud this function return null. Will be removed as release 3.x
java.lang.String	getBluemixRegionSuffix()
java.lang.String	getDefaultProtocol()
static BMSClient	getInstance() Should be called to obtain the instance of BMSClient.
void	initialize(Context context, java.lang.String bluemixRegion) Initializes the SDK with supplied parameters.
void	initialize(Context context, java.lang.String bluemixAppRoute, java.lang.String bluemixAppGUID, java.lang.String bluemixRegion) Deprecated. As of release 2.2.0, replaced by initialize(Context, String) Initializes the SDK with supplied parameters This method should be called before you send the first request
void	setDefaultProtocol(java.lang.String protocol)

Methods inherited from class java.lang.Object

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

Field Detail

REGION_US_SOUTH

public static final java.lang.String REGION_US_SOUTH

See Also:

Constant Field Values

REGION_UK

public static final java.lang.String REGION_UK

See Also:

Constant Field Values

REGION_SYDNEY

public static final java.lang.String REGION_SYDNEY

See Also:

Constant Field Values

REGION_GERMANY

public static final java.lang.String REGION_GERMANY

See Also:

Constant Field Values

REGION_US_EAST

public static final java.lang.String REGION_US_EAST

See Also:

Constant Field Values

REGION_TOKYO

public static final java.lang.String REGION_TOKYO

See Also:

Constant Field Values

HTTP_SCHEME

public static final java.lang.String HTTP_SCHEME

See Also:

Constant Field Values

HTTPS_SCHEME

public static final java.lang.String HTTPS_SCHEME

See Also:

Constant Field Values

Method Detail

getInstance

public static BMSClient getInstance()

Should be called to obtain the instance of BMSClient.

Returns:

the instance of BMSClient.

initialize

public void initialize(Context context,
                       java.lang.String bluemixAppRoute,
                       java.lang.String bluemixAppGUID,
                       java.lang.String bluemixRegion)
                throws java.net.MalformedURLException

Deprecated. As of release 2.2.0, replaced by initialize(Context, String) Initializes the SDK with supplied parameters

This method should be called before you send the first request

Parameters:

context - Android application context

bluemixAppRoute - Specifies the base URL for the authorization server

bluemixAppGUID - Specifies the GUID of the application

bluemixRegion - Specifies the Bluemix deployment to use. Use values in BMSClient.REGION* static props

Throws:

java.net.MalformedURLException - backendRoute could not be parsed as a URL.

initialize

public void initialize(Context context,
                       java.lang.String bluemixRegion)

Initializes the SDK with supplied parameters.

This method should be called before you send the first request

Parameters:

context - Android application context

bluemixRegion - Specifies the Bluemix region to use. Use values in BMSClient.REGION* static props.

Throws:

java.net.MalformedURLException - backendRoute could not be parsed as a URL.

getBluemixAppRoute

public java.lang.String getBluemixAppRoute()

Deprecated. As of release 2.2.0. if you use the new initialize methoud this function return null. Will be removed as release 3.x

Returns:

backend route url

getBluemixAppGUID

public java.lang.String getBluemixAppGUID()

Deprecated. As of release 2.2.0. if you use the new initialize methoud this function return null. Will be removed as release 3.x

Returns:

backend GUID

getBluemixRegionSuffix

public java.lang.String getBluemixRegionSuffix()

Returns:

Bluemix region suffix for SDK components to build URLs

getDefaultProtocol

public java.lang.String getDefaultProtocol()

Returns:

Bluemix region suffix for SDK components to build URLs

setDefaultProtocol

public void setDefaultProtocol(java.lang.String protocol)