oracle.cloud.mobile.mobilebackend

Class MobileBackendManager

java.lang.Object

oracle.cloud.mobile.mobilebackend.MobileBackendManager

public final class MobileBackendManager
extends java.lang.Object

The mobile backend manager is the entry point to the Oracle Mobile Cloud SDK on Android. Typically Android developers will call the getManager method to get a handle on the singleton for this class, then the defaultMobileBackend method to retrieve the default MCS mobile backend defined in the corresponding oracle_mobile_cloud_config.xml file, as shown in the following code example:

 
   try {
        MobileBackend mobileBackend = MobileBackendManager.getManager().getDefaultMobileBackend(MainActivity.this);
     } catch (ServiceProxyException e) {
         Log.i("Authorization", e.getMessage());
     }
 

 Once the singleton and mobile backend is derived, it will then use this to access other services
 provided by the SDK such as this example to authenticate the mobile user anonymously against MCS:

 
   try {
       MobileBackend mobileBackend = MobileBackendManager.getManager().getDefaultMobileBackend(MainActivity.this);
       mobileBackend.getAuthorization().authenticateAnonymous(MainActivity.this, new AuthorizationCallback() {
          @Override
          public void onCompletion(ServiceProxyException exception) {
              if (exception != null) {
                  Log.i("Authorization", exception.getMessage());
              }
              else {
                  Log.i("Authorization", "Authentication Successful.");
              }
          }
       });
     } catch (ServiceProxyException e) {
          Log.i("Authorization", e.getMessage());
     }
 

 If more than one mobile backend is defined in the oracle_mobile_cloud_config.xml file, the
 getMobileBackend method supplying the mobile backend name as a string can be used instead:

 
   try {
        MobileBackend mobileBackend = MobileBackendManager.getManager().getMobileBackend(MainActivity.this,"back_end_name");;
     } catch (ServiceProxyException e) {
         Log.i("Authorization", e.getMessage());
     }
 
 

Method Summary

Modifier and Type	Method and Description
MobileBackend	addMobileBackend(Context context, java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties) Adds a new mobile backend
MobileBackend	getDefaultMobileBackend(Context context) Returns the default mobile backend.
MobileBackend	getDefaultMobileBackend(Context context, java.util.Map<java.lang.String,java.lang.String> properties) Returns the default mobile backend with overridden properties specified in properties map.
static MobileBackendManager	getManager() Returns the mobile backend manager
MobileBackend	getMobileBackend(Context context, java.lang.String name) Returns the specified mobile backend.
MobileBackend	getMobileBackend(Context context, java.lang.String name, java.util.Map<java.lang.String,java.lang.String> properties) Returns the specified mobile backend with overridden properties specified in properties map.

Methods inherited from class java.lang.Object

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

Method Detail

getManager

public static MobileBackendManager getManager()

Returns the mobile backend manager

Returns:

MobileBackendManager instance

getDefaultMobileBackend

public MobileBackend getDefaultMobileBackend(Context context)
                                      throws ServiceProxyException

Returns the default mobile backend.

Parameters:

context - current context

Returns:

The mobile backend object

Throws:

ServiceProxyException - if supplied context is null or there is no default backend or there is an error in parsing the config file

getDefaultMobileBackend

public MobileBackend getDefaultMobileBackend(Context context,
                                             java.util.Map<java.lang.String,java.lang.String> properties)
                                      throws ServiceProxyException

Returns the default mobile backend with overridden properties specified in properties map.

Parameters:

context - current context

properties - mobile backend map containing properties to be overridden

Returns:

The mobile backend object

Throws:

ServiceProxyException - if the supplied context is null or there is no default backend or there is an error in parsing the config file.

getMobileBackend

public MobileBackend getMobileBackend(Context context,
                                      java.lang.String name)
                               throws ServiceProxyException

Returns the specified mobile backend. The name parameter takes the name of mobile backend to be returned.

Parameters:

context - current context

name - the mobile backend name

Returns:

MobileBackend instance

Throws:

ServiceProxyException - if supplied context is null or there is no backend with the supplied name or there is an error in parsing the config file.

getMobileBackend

public MobileBackend getMobileBackend(Context context,
                                      java.lang.String name,
                                      java.util.Map<java.lang.String,java.lang.String> properties)
                               throws ServiceProxyException

Returns the specified mobile backend with overridden properties specified in properties map. The name parameter takes the name of mobile backend to be returned.

Parameters:

context - current context

name - The mobile backend name

properties - mobile backend map containing properties to be overridden

Returns:

MobileBackend instance

Throws:

ServiceProxyException - if supplied context is null or there is no backend with the supplied name or there is an error in parsing the config file.

addMobileBackend

public MobileBackend addMobileBackend(Context context,
                                      java.lang.String name,
                                      java.util.Map<java.lang.String,java.lang.String> properties)
                               throws ServiceProxyException

Adds a new mobile backend

Parameters:

context - current context

name - mobile backend name

properties - mobile backend properties

Returns:

recently added MobileBackend

Throws:

ServiceProxyException - if supplied context is null or supplied backend name is null or there is an error in parsing the config file