com.salesforce.androidsdk.mobilesync.app.MobileSyncSDKManager Maven / Gradle / Ivy

/*
 * Copyright (c) 2014-present, salesforce.com, inc.
 * All rights reserved.
 * Redistribution and use of this software in source and binary forms, with or
 * without modification, are permitted provided that the following conditions
 * are met:
 * - Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither the name of salesforce.com, inc. nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission of salesforce.com, inc.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.salesforce.androidsdk.mobilesync.app;

import android.app.Activity;
import android.content.Context;

import androidx.annotation.NonNull;

import com.salesforce.androidsdk.accounts.UserAccount;
import com.salesforce.androidsdk.mobilesync.R;
import com.salesforce.androidsdk.mobilesync.config.SyncsConfig;
import com.salesforce.androidsdk.mobilesync.manager.SyncManager;
import com.salesforce.androidsdk.mobilesync.util.MobileSyncLogger;
import com.salesforce.androidsdk.smartstore.app.SmartStoreSDKManager;
import com.salesforce.androidsdk.ui.LoginActivity;
import com.salesforce.androidsdk.util.EventsObservable;
import com.salesforce.androidsdk.util.EventsObservable.EventType;

/**
 * SDK Manager for all native applications that use MobileSync.
 */

// Note: keeping the java implementation
//       otherwise calling MobileSyncSDKManager.init from java calls SmartStoreSDKManager.init
//       see https://youtrack.jetbrains.com/issue/KT-12993
public class MobileSyncSDKManager extends SmartStoreSDKManager {

    private static final String TAG = "MobileSyncSDKManager";

    /**
     * Protected constructor.
     *
     * @param context             Application context.
     * @param mainActivity        Activity that should be launched after the login flow.
     * @param loginActivity       Login activity.
     * @param nativeLoginActivity Native login activity.
     */
    protected MobileSyncSDKManager(Context context, Class mainActivity,
                                   Class loginActivity,
                                   Class nativeLoginActivity) {
        super(context, mainActivity, loginActivity, nativeLoginActivity);
    }

    private static void init(Context context, Class mainActivity,
                             Class loginActivity,
                             Class nativeLoginActivity) {
        if (INSTANCE == null) {
            INSTANCE = new MobileSyncSDKManager(context, mainActivity, loginActivity, nativeLoginActivity);
        }

        // Upgrade to the latest version.
        MobileSyncUpgradeManager.getInstance().upgrade();

        initInternal(context);
        EventsObservable.get().notifyEvent(EventType.AppCreateComplete);
    }

    /**
     * Initializes components required for this class
     * to properly function. This method should be called
     * by native apps using the Salesforce Mobile SDK.
     *
     * @param context      Application context.
     * @param mainActivity Activity that should be launched after the login flow.
     */
    public static void initNative(
            @NonNull Context context,
            @NonNull Class mainActivity
    ) {
        MobileSyncSDKManager.init(context, mainActivity, LoginActivity.class, null);
    }

    /**
     * Initializes components required for this class
     * to properly function. This method should be called
     * by native apps using the Salesforce Mobile SDK.
     *
     * @param context       Application context.
     * @param mainActivity  Activity that should be launched after the login flow.
     * @param loginActivity Login activity.
     * @noinspection unused
     */
    public static void initNative(Context context, Class mainActivity,
                                  Class loginActivity) {
        MobileSyncSDKManager.init(context, mainActivity, loginActivity, null);
    }

    /**
     * Initializes components required for this class
     * to properly function. This method should be called
     * by native apps using the Salesforce Mobile SDK.
     *
     * @param context             Application context.
     * @param mainActivity        Activity that should be launched after the login flow.
     * @param loginActivity       Login activity.
     * @param nativeLoginActivity Native login activity.
     * @noinspection unused
     */
    public static void initNative(Context context, Class mainActivity,
                                  Class loginActivity,
                                  Class nativeLoginActivity) {
        MobileSyncSDKManager.init(context, mainActivity, loginActivity, nativeLoginActivity);
    }

    /**
     * Returns a singleton instance of this class.
     *
     * @return Singleton instance of MobileSyncSDKManager.
     */
    @NonNull
    public static MobileSyncSDKManager getInstance() {
        if (INSTANCE != null) {
            return (MobileSyncSDKManager) INSTANCE;
        } else {
            throw new RuntimeException("Applications need to call MobileSyncSDKManager.init() first.");
        }
    }

    @Override
    protected void cleanUp(UserAccount userAccount) {
        SyncManager.reset(userAccount);
        super.cleanUp(userAccount);
    }

    /**
     * Setup global syncs using config found in res/raw/globalsyncs.json
     */
    public void setupGlobalSyncsFromDefaultConfig() {
        MobileSyncLogger.d(TAG, "Setting up global syncs using config found in res/raw/globalsyncs.json");
        SyncsConfig config = new SyncsConfig(context, R.raw.globalsyncs);
        if (config.hasSyncs()) {
            config.createSyncs(getGlobalSmartStore());
        }
    }

    /**
     * Setup user syncs using config found in res/raw/usersyncs.json
     */
    public void setupUserSyncsFromDefaultConfig() {
        MobileSyncLogger.d(TAG, "Setting up user syncs using config found in res/raw/usersyncs.json");
        SyncsConfig config = new SyncsConfig(context, R.raw.usersyncs);
        if (config.hasSyncs()) {
            config.createSyncs(getSmartStore());
        }
    }
}