Integrating SDKs (for Eclipse)

Integrating the AppGallery Connect SDK and Cloud Functions SDK

1. Generate the Eclipse project package on which AppGallery Connect services depend.
   NOTE

   Before generating an Eclipse project package, ensure that the JDK and Android SDK have been installed on your PC.

   1. Download the aar2eclipse.zip tool package for generating an Eclipse project package to your PC and decompress it.
   2. Open the build.gradle file in the aar2eclipse/aar directory and check whether the Maven repository address is correct. If not, correct it.
      Collapse

      Word wrap

      Dark theme

      Copy code

      allprojects {
          repositories {
              maven { url 'https://developer.huawei.com/repo' }
              google()
              jcenter()
          }
      }

   3. Configure the SDK dependency address of Cloud Functions in dependencies.
      Java

      Kotlin

      Collapse

      Word wrap

      Dark theme

      Copy code

      dependencies {
          transform "com.huawei.agconnect:agconnect-function:1.9.6.300"
      }

      Collapse

      Word wrap

      Dark theme

      Copy code

      dependencies {
          transform "com.huawei.agconnect:agconnect-function-ktx:1.9.1.300"
      }

   4. Double-click the build.bat file in the aar2eclipse\aar directory. When the file execution is successful, the path (eclipse under aar2eclipse/aar) of the Eclipse project package is recorded in logs.

      

2. Open your Eclipse project, go to File > Import, and import the generated Eclipse project package to your workspace.
   1. Go to Android > Existing Android Code Into Workspace and click Next.

      

   2. Click Browse and select the aar2eclipse\aar\eclipse directory where the project package is located. Select the project to be imported under Projects and click Finish. By default, the project name is BridgeActivity.
      NOTE

      The project to be imported must be located in the same drive as the workspace, for example, D:\. If they are not in the same drive, select Copy projects into workspace to copy the project files to the workspace. Do not place the project to be imported in the directory whose level is the same as that of your Eclipse project. Otherwise, the import may fail.

      

3. Add the project dependency.
   1. Right-click your project and choose Properties from the shortcut menu.
   2. Choose Android from the navigation tree on the left, click Add, and select the BridgeActivity project that you have imported to the workspace.

      

   3. Click Apply and Close.
4. Copy resource files in the assets directory of the imported BridgeActivity project to the same directory of your Eclipse project.

   This step is required because Eclipse cannot automatically merge these assets directories. The following figure shows the resource files to be copied.

   

5. Modify the project configuration.
   1. Configure the project.properties file.

      By default, Eclipse does not support AndroidManifest.xml file merging. You need to find the project.properties file in your project directory, open it, and add the following configuration to merge the Manifest files in subprojects:

      Collapse

      Word wrap

      Dark theme

      Copy code

       manifestmerger.enabled=true

   2. Set the app package name.

      Replace all ${applicationId} variables in the AndroidManifest.xml file of the BridgeActivity project with your app package name. Example:

      Before:

      Collapse

      Word wrap

      Dark theme

      Copy code

      <application>
      <provider
          android:name="com.huawei.agconnect.core.provider.AGConnectInitializeProvider"
          android:authorities="${applicationId}.AGCInitializeProvider"
          android:exported="false" />

      After:

      Collapse

      Word wrap

      Dark theme

      Copy code

      <application>
          <provider
              android:name="com.huawei.agconnect.core.provider.AGConnectInitializeProvider"
              android:authorities="com.huawei.functioneclipse.AGCInitializeProvider"
              android:exported="false" />

6. Add the AppGallery Connect configuration file.
   1. Place the agconnect-services.json file in the assets directory of your project, and add the following code to the Application class of the app. This is because the Eclipse IDE does not support the AppGallery Connect plugin. If your app does not have the Application class, create one, for example, MyApplication.
      Collapse

      Word wrap

      Dark theme

      Copy code

      public class MyApplication extends Application{
          // TODO: Add the following code:
          @Override
          public void onCreate() {
              super.onCreate();
              try {
                  AGConnectOptionsBuilder builder = new AGConnectOptionsBuilder();
                  builder.setInputStream(getAssets().open("agconnect-services.json"));
                  AGConnectInstance.initialize(this, builder);
              } catch (IOException e) {
                  e.printStackTrace();
              }
          }
          // Code adding ends.
      }

   2. Open the AndroidManifest.xml file of your project and declare the MyApplication class in the application block. If the class has been declared, skip this step.
      Collapse

      Word wrap

      Dark theme

      Copy code

      <application
          <!-- Declaration starts. -->
          android:name=".MyApplication">
          <!-- Declaration ends. -->
      </application>

   3. Click Project on the Eclipse menu bar and then run the clean command.

(Optional) Passing the Key Information to AppGallery Connect

Through Parameters in the Configuration File

The AppGallery Connect SDK provides the AGConnectOptionsBuilder class to set parameters in the agconnect-services.json file. If you have selected Do not include key when downloading the file, the file does not include the client_id, client_secret, and api_key parameters. You must set these parameters in the AppGallery Connect SDK through the AGConnectOptionsBuilder class during app launch.

// Add the following code:
try {
    AGConnectOptionsBuilder builder = new AGConnectOptionsBuilder();
    InputStream in = getAssets().open("agconnect-services.json");    // If you are using the AppGallery Connect plugin, delete this line.
    builder.setInputStream(in);                                      // If you are using the AppGallery Connect plugin, delete this line.
    builder.setClientId("client_id");
    builder.setClientSecret("client_secret");
    builder.setApiKey("api_key");
    builder.setCPId("cp_id");
    builder.setProductId("product_id");
    builder.setAppId("app_id");
    AGConnectInstance.initialize(this, builder);
} catch (IOException e) {
    e.printStackTrace();
}
// TODO: Code adding ends.

You can go to Project settings > General information and check the value of each parameter, or click next to a parameter to copy the parameter value.

Replace the parameters in the code with the settings on the General information tab page as follows:

• Replace client_id with the value of Client ID in the Project information area.
• Replace client_secret with the value of Client secret in the Project information area.
• Replace api_key with the value of API key in the Project information area.
• Replace cp_id with the value of Developer ID in the Developer information area.
• Replace product_id with the value of Project ID in the Project information area.
• Replace app_id with the value of App ID in the App information area.

Through the Token

If you think it is insecure to store client_id and client_secret in the JSON file, you are advised to store them on your own server. You can call the API https://connect-drcn.dbankcloud.cn/agc/apigw/oauth2/v1/token to obtain a token, after which you can call setCustomCredentialsProvider to pass the token to AppGallery Connect during the AppGallery Connect SDK initialization.

Sample code for calling the API to obtain a token:

POST /agc/apigw/oauth2/v1/token
Host: connect-drcn.dbankcloud.cn
Content-Type: application/json
{
   "grant_type":"client_credentials",
   "client_id":client ID displayed in the App information area on the Project settings page of AppGallery Connect,
   "client_secret":client secret displayed in the App information area on the Project settings page of AppGallery Connect,
   "useJwt":1
}

Response example of the API for obtaining a token:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "access_token": "eyJhbGciOiJIUzU****************",
    "expires_in": 0
}

String tokenStr = "
access_token";
long expiration = 
expires_in;

CustomCredentialsProvider developerClientToken = new CustomCredentialsProvider() {
    @Override
    public Task<Token> getTokens(boolean forceRefresh) {
        TaskCompletionSource<Token> source = new TaskCompletionSource<>();
        Token token;
            token = new Token() {
                @Override
                public long getExpiration() {
                    return expiration;
                }

                @Override
                public long getIssuedAt() {
                    return 0;
                }

                @Override
                public long getNotBefore() {
                    return 0;
                }

                @Override
                public String getTokenString() {
                    return tokenStr;
                }
            };
        source.setResult(token);
        return source.getTask();
    }
};

AGConnectOptionsBuilder builder = new AGConnectOptionsBuilder();
builder.setCustomCredentialsProvider(developerClientToken);
AGConnectInstance.initialize(getApplicationContext(),builder);

val tokenStr = "
access_token"
val expiration: Long = 
expires_in

val developerClientToken = CustomCredentialsProvider {
    val source = TaskCompletionSource<Token>()
    val token: Token
    token = object : Token {
        override fun getExpiration(): Long {
            return expiration
        }

        override fun getIssuedAt(): Long {
            return 0
        }

        override fun getNotBefore(): Long {
            return 0
        }

        override fun getTokenString(): String {
            return tokenStr
        }
    }
    source.setResult(token)
    source.task
}
val builder = AGConnectOptionsBuilder()
builder.setCustomCredentialsProvider(developerClientToken)
AGConnectInstance.initialize(getApplicationContext(), builder)

Configuring Obfuscation Scripts

Before building the APK, configure obfuscation scripts to prevent the AppGallery Connect SDK from being obfuscated. If obfuscation arises, the AppGallery Connect SDK may not function properly.

1. Open the obfuscation configuration file.
2. Add configurations to exclude the AppGallery Connect SDK from obfuscation.

   Add configurations to the proguard-project.txt file to exclude the AppGallery Connect SDK from obfuscation.

   Collapse

   Word wrap

   Dark theme

   Copy code

   -keep class com.huawei.agconnect.remoteconfig.*{*;}
   -keepclassmembers class **{
       public <init>(android.content.Context,com.huawei.agconnect.AGConnectInstance);
   }
   -keepclassmembers class com.huawei.agconnect.remoteconfig.internal.server.**{*;}
   -keep class * implements android.os.Parcelable {
       public static final android.os.Parcelable$Creator *;
   }

(Optional) Initializing the AppGallery Connect SDK

If multiple processes are running concurrently, you need to call an initialization method in each subprocess to initialize the AppGallery Connect SDK after it is integrated into your app.

Add the initialization code to the onCreate method of Application:

if (AGConnectInstance.getInstance() == null) { 
     AGConnectInstance.initialize(getApplicationContext()); 
}