Android Open Source - force_analytics_example Force Plugin

From Project

Back to project page force_analytics_example.

License

The source code is released under:

Copyright (c) 2011, salesforce.com, inc. All rights reserved. ======================================== Redistribution and use of this software in source and binary forms, with or without modificatio...

If you think the Android project force_analytics_example listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.

Java Source Code

/*
 * Copyright (c) 2012, salesforce.com, inc.
 * All rights reserved./*w w w .  ja va 2  s  .  co m*/
 * 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.phonegap;

import org.apache.cordova.api.CallbackContext;
import org.apache.cordova.api.CordovaPlugin;
import org.json.JSONArray;
import org.json.JSONException;

import android.util.Log;

import com.salesforce.androidsdk.app.SalesforceSDKManager;

/**
 * Abstract super class for all Salesforce plugins
 */
public abstract class ForcePlugin extends CordovaPlugin {
  
  private static final String VERSION_KEY = "pluginSDKVersion";


  /**
     * Executes the plugin request and returns PluginResult.
     *
     * @param action        The action to exectute
     * @param args          JSONArray of arguments for the plugin (possibly starting with version)
     * @param callbackContext Used when calling back into Javascript.
     * @return              A PluginResult object with a status and message.
     * @throws              JSONException
     */
  @Override
    public boolean execute(String action, JSONArray args, CallbackContext callbackContext) throws JSONException {
    // args is an array
    // when versioned, the first element is the string "pluginSDKVersion:xxx" where xxx is the version        
    String jsVersionStr = "";
    if (args.length() > 0) {
        String firstArg = args.optString(0);
        if (firstArg.startsWith(VERSION_KEY)) {
          jsVersionStr = firstArg.substring(VERSION_KEY.length() + 1);
          args = shift(args);
        }
      }

    JavaScriptPluginVersion jsVersion = new JavaScriptPluginVersion(jsVersionStr);
      Log.i(getClass().getSimpleName() + ".execute", "action: " + action + ", jsVersion: " + jsVersion);

      if (jsVersion.isOlder()) {
        Log.w(getClass().getSimpleName() + ".execute", "is being called by js from older sdk, jsVersion: " + jsVersion + ", nativeVersion: " + SalesforceSDKManager.SDK_VERSION);
      }
      else if (jsVersion.isNewer()) {
        Log.w(getClass().getSimpleName() + ".execute", "is being called by js from newer sdk, jsVersion: " + jsVersion + ", nativeVersion: " + SalesforceSDKManager.SDK_VERSION);
      }
      
        return execute(action, jsVersion, args, callbackContext);
    }


  /**
   * @param args
   * @return copy of args JSONArray without the first element
   * @throws JSONException 
   */
  private JSONArray shift(JSONArray args) throws JSONException {
    JSONArray res = new JSONArray();
    for (int i = 1; i<args.length(); i++)
      res.put(args.get(i));
    return res;
  }


  /**
   * Abstract method to concrete subclass need to implement
     * @param actionStr     The action to execute
     @ @param jsVersion     The version targeted
     * @param args          JSONArray of arguments for the plugin.
     * @param callbackContext Used when calling back into Javascript.
     * @return              Whether the action was valid.
   * @throws JSONExceptiopn
   */
  abstract protected boolean execute(String actionStr, JavaScriptPluginVersion jsVersion, JSONArray args, CallbackContext callbackContext) throws JSONException;
}

Java Source Code List