BKNDLSS-23954 Add possibility to init android sdk with only domain, without appId and apiKey (#483)

Co-authored-by: sergey.kukurudzyak <[email protected]>

Author: ksv510

src/com/backendless/AndroidHeadersManager.java

@@ -31,10 +31,6 @@ static AndroidHeadersManager getInstance() throws BackendlessException
 
   AndroidHeadersManager()
   {
-    if( Backendless.getApplicationId() == null || Backendless.getApiKey() == null )
-    {
-      throw new IllegalStateException( ExceptionMessage.NOT_INITIALIZED );
-    }
     initialFill();
   }
 

src/com/backendless/Backendless.java

@@ -57,6 +57,8 @@
 import weborb.writer.amf.AmfV3Formatter;
 
 import java.io.IOException;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -170,26 +172,69 @@ public static void initApp( String applicationId, String apiKey )
     initApp( null, applicationId, apiKey );
   }
 
+  /**
+   * Initializes the Backendless API and all Backendless dependencies. This is the first step in using the client API.
+   * <p>
+   * There is a low probability for internal API data to be cleared by the garbage collector.
+   * In this case, an exception or fault, thrown by any of Backendless API methods, will contain 904 error code.
+   *
+   * @param customDomain custom domain which you setup in Backendless console https://backendless.com/docs/android/mgmt_custom_domain.html
+   */
+  public static void initApp( String customDomain )
+  {
+    initApp( (Object) null, customDomain );
+  }
+
   public static boolean isInitialized()
   {
     return initialized;
   }
 
-  public static void initApp( Object context, final String applicationId, final String apiKey )
+  public static void initApp( Object context, final String customDomain )
   {
-    if( isAndroid && context == null )
-      throw new IllegalArgumentException( ExceptionMessage.NULL_CONTEXT );
+    if( customDomain == null || customDomain.equals( "" ) )
+      throw new IllegalArgumentException( "Custom domain cant be null or empty" );
+
+    if( customDomain.startsWith( "http" ) )
+      setUrl( customDomain );
+    else
+      setUrl( "http://" + customDomain );
+
+    URI uri;
+    try
+    {
+      uri = new URI( Backendless.getUrl() );
+    }
+    catch( URISyntaxException e )
+    {
+      throw new RuntimeException( e );
+    }
 
+    prefs.setCustomDomain( uri.getHost() );
+
+    initApp( context );
+  }
+
+  public static void initApp( Object context, final String applicationId, final String apiKey )
+  {
     if( applicationId == null || applicationId.equals( "" ) )
       throw new IllegalArgumentException( ExceptionMessage.NULL_APPLICATION_ID );
 
     if( apiKey == null || apiKey.equals( "" ) )
       throw new IllegalArgumentException( ExceptionMessage.NULL_API_KEY );
 
-    prefs.onCreate( context );
     prefs.initPreferences( applicationId, apiKey );
     prefs.setUrl( url );
 
+    initApp( context );
+  }
+
+  private static void initApp( Object context )
+  {
+    if( isAndroid && context == null )
+      throw new IllegalArgumentException( ExceptionMessage.NULL_CONTEXT );
+
+    prefs.onCreate( context );
     MessageWriter.addTypeWriter( BackendlessUser.class, new BackendlessUserWriter() );
     MessageWriter.addTypeWriter( Double.class, new DoubleWriter() );
     MessageWriter.addTypeWriter( Geometry.class, new BackendlessGeometryWriter() );
@@ -227,7 +272,7 @@ public static void initApp( Object context, final String applicationId, final St
       ThreadPoolService.getThreadPoolExecutor();
       return;
     }
-    
+
     String userToken = UserTokenStorageFactory.instance().getStorage().get();
 
     if( userToken != null && !userToken.equals( "" ) )
@@ -269,12 +314,18 @@ public static void setUIState( String state )
     }
   }
 
-  public static String getApplicationId()
+  public static String getApplicationIdOrDomain()
   {
     if( prefs == null )
       throw new IllegalStateException( ExceptionMessage.NOT_INITIALIZED );
 
-    return prefs.getApplicationId();
+    if( prefs.getApplicationId() != null )
+       return prefs.getApplicationId();
+
+    if( prefs.getCustomDomain() != null )
+      return prefs.getCustomDomain();
+
+    throw new IllegalStateException( ExceptionMessage.NOT_INITIALIZED );
   }
 
   public static String getApiKey()
@@ -302,13 +353,28 @@ public static void setUrl( String url )
   {
     Backendless.url = url;
 
-    if( prefs != null && prefs.isAuthKeysExist() )
+    if( prefs != null )
     {
       prefs.setUrl( url );
       Invoker.reinitialize();
     }
   }
 
+  /**
+   * @return url to call to backendless
+   * If application initialized with appId and api key returns url with the following pattern
+   * "http(s)://<backendless-host>/<appId>/<apiKey>/..."
+   * Else if application initialized with domain returns url with the following pattern
+   * "http(s)://<backendless-host>/..."
+   */
+  public static String getApplicationUrl()
+  {
+    final String applicationId = prefs.getApplicationId();
+    return applicationId == null
+            ? getUrl() + "/api"
+            : getUrl() + '/' + applicationId + '/' + getApiKey();
+  }
+
   public static boolean isCodeRunner()
   {
     return isCodeRunner;

src/com/backendless/BackendlessPrefs.java

@@ -12,6 +12,7 @@ class BackendlessPrefs
   protected AuthKeys authKeys;
   protected Map<String, String> headers;
   protected String url;
+  protected String customDomain;
 
   public BackendlessPrefs()
   {
@@ -44,7 +45,9 @@ public void onCreate( Object context )
 
   public String getApplicationId()
   {
-    return getAuthKeys().getApplicationId();
+
+    final AuthKeys authKeys = getAuthKeys();
+    return authKeys == null ? null : authKeys.getApplicationId();
   }
 
   public String getApiKey()
@@ -59,9 +62,6 @@ public synchronized Map getHeaders()
 
   private synchronized AuthKeys getAuthKeys()
   {
-    if( authKeys == null)
-      throw new IllegalStateException( ExceptionMessage.NOT_INITIALIZED );
-    
     return authKeys;
   }
 
@@ -82,4 +82,15 @@ public String getUrl()
 
     return this.url;
   }
+
+  public String getCustomDomain()
+  {
+    return customDomain;
+  }
+
+  public BackendlessPrefs setCustomDomain( String customDomain )
+  {
+    this.customDomain = customDomain;
+    return this;
+  }
 }

src/com/backendless/Files.java

@@ -125,7 +125,7 @@ public BackendlessFile uploadFromStream( OutputStreamRouter outputStreamRouter,
 
     try
     {
-      String urlStr = Backendless.getUrl() + '/' + Backendless.getApplicationId() + '/' + Backendless.getApiKey() + "/files/" + encodeURL( path ) + "/" + encodeURL( name );
+      String urlStr = Backendless.getApplicationUrl() + "/files/" + encodeURL( path ) + "/" + encodeURL( name );
 
       if( overwrite )
         urlStr = urlStr + "?" + OVERWRITE_PARAMETER_NAME + "=" + overwrite;

src/com/backendless/Invoker.java

@@ -40,7 +40,7 @@ public class Invoker
 
   static void reinitialize()
   {
-    String urlEnding = Backendless.getUrl() + '/' + Backendless.getApplicationId() + '/' + Backendless.getApiKey() + "/binary";
+    String urlEnding = Backendless.getApplicationUrl() + "/binary";
     weborbClient = new WeborbClient( urlEnding, DEFAULT_TIMEOUT, DESTINATION );
     weborbClient.setCookiesDateFormat( "EEE, dd-MMM-yy HH:mm:ss z" );
 

src/com/backendless/SocialAsyncCallback.java

@@ -25,7 +25,8 @@ public class ExceptionMessage
   public final static String CLIENT_ERROR = "Internal client exception.";
 
   public final static String WRONG_MANIFEST = "Wrong dependencies at the manifest";
-  public final static String NOT_INITIALIZED = "Backendless application was not initialized";
+  public final static String NOT_INITIALIZED = "Backendless application was not initialized. " +
+          "Call Backendless.initApp method before use any backendless functionality";
 
   public final static String NULL_USER = "User cannot be null or empty.";
   public final static String NULL_PASSWORD = "User password cannot be null or empty.";

src/com/backendless/exceptions/ExceptionMessage.java

@@ -146,7 +146,7 @@ private void fallBackMode( Context context, String message, String contentTitle,
     // android.os.Build.VERSION_CODES.O == 26
     if( android.os.Build.VERSION.SDK_INT > 25 )
     {
-      final String channelId = Backendless.getApplicationId() + ":" + channelName;
+      final String channelId = Backendless.getApplicationIdOrDomain() + ":" + channelName;
       NotificationManager notificationManager = (NotificationManager) context.getSystemService( Context.NOTIFICATION_SERVICE );
       NotificationChannel notificationChannel = notificationManager.getNotificationChannel( channelId );
 

src/com/backendless/push/BackendlessFCMService.java

@@ -335,14 +335,14 @@ static public void deleteNotificationChannel( Context context )
 
   static public NotificationChannel getNotificationChannel( final Context context, final String templateName )
   {
-    final String channelId = Backendless.getApplicationId() + ":" + templateName;
+    final String channelId = Backendless.getApplicationIdOrDomain() + ":" + templateName;
     NotificationManager notificationManager = (NotificationManager) context.getSystemService( Context.NOTIFICATION_SERVICE );
     return notificationManager.getNotificationChannel( channelId );
   }
 
   static public NotificationChannel getOrCreateNotificationChannel( Context context, final AndroidPushTemplate template )
   {
-    final String channelId = Backendless.getApplicationId() + ":" + template.getName();
+    final String channelId = Backendless.getApplicationIdOrDomain() + ":" + template.getName();
     NotificationManager notificationManager = (NotificationManager) context.getSystemService( Context.NOTIFICATION_SERVICE );
 
     NotificationChannel notificationChannel = notificationManager.getNotificationChannel( channelId );

src/com/backendless/push/PushTemplateHelper.java

@@ -9,6 +9,7 @@
 import io.socket.client.Socket;
 import io.socket.emitter.Emitter;
 
+import java.net.URI;
 import java.net.URISyntaxException;
 import java.util.Arrays;
 import java.util.logging.Logger;
@@ -59,13 +60,13 @@ Socket get()
       final IO.Options opts = new IO.Options();
       opts.reconnection = false;
 
-      opts.path = "/" + Backendless.getApplicationId();
+      opts.path = "/" + Backendless.getApplicationIdOrDomain();
 
       opts.query = "apiKey=" + Backendless.getApiKey()
               + "&clientId=" + Backendless.Messaging.getDeviceId()
               + "&binary=true";
 
-      final String host = rtLookupService.lookup( ) + opts.path;
+      final String host = rtLookupService.lookup() + opts.path;
       logger.info( "Looked up for server " + host );
 
       String userToken = HeadersManager.getInstance().getHeader( HeadersManager.HeadersEnum.USER_TOKEN_KEY );