com.feedhenry.sdk.api.FHActRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of fh-android-sdk Show documentation
There is a newer version: 4.0.0
/**
 * Copyright Red Hat, Inc, and individual contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.feedhenry.sdk.api;

import android.content.Context;
import com.feedhenry.sdk.CloudProps;
import com.feedhenry.sdk.FH;
import com.feedhenry.sdk.FHRemote;
import cz.msebera.android.httpclient.Header;
import org.json.fh.JSONObject;

/**
 * The request for calling the cloud side function of the app. Example:
 * 
 *  * {@code
 *   //calling a cloud side function called "getTweets" and pass in the keywords
 *   FHActRequest request = FH.buildActRequest("getTweets", new JSONObject().put("keyword",
 * "FeedHenry"));
 *   reqeust.executeAsync(new FHActCallback(){
 *     public void success(FHResponse pResp){
 *       JSONObject tweetsObj = pResp.getJson();
 *       ...
 *     }
 * 
 *     public void fail(FHResponse pResp){
 *       //process error data
 *       ...
 *     }
 *   });
 * }
 * 
 */
public class FHActRequest extends FHRemote {

    private String mRemoteAct;
    protected JSONObject mArgs = new JSONObject();

    protected static String LOG_TAG = "com.feedhenry.sdk.api.FHActRequest";

    /**
     * Constructor
     * 
     * @param context the application context
     */
    public FHActRequest(Context context) {
        super(context);
    }

    protected String getApiURl() {
        String host = CloudProps.getInstance().getCloudHost();
        String path = getPath();
        String hostUrl = host + (path.startsWith("/") ? path : '/' + path);
        return hostUrl;
    }

    /**
     * The name of the cloud side function
     * 
     * @param pAction cloud side function name
     */
    public void setRemoteAction(String pAction) {
        mRemoteAct = pAction;
    }

    /**
     * Set the parameters for the cloud side function
     * 
     * @param pArgs the parameters that will be passed to the cloud side function
     */
    public void setArgs(JSONObject pArgs) {
        mArgs = pArgs;
        // keep backward compatibility
        if (!mArgs.has("__fh")) {
            try {
                mArgs.put("__fh", FH.getDefaultParams());
            } catch (Exception e) {

            }
        }
    }

    protected JSONObject getRequestArgs() {
        return mArgs;
    }

    @Override
    protected String getPath() {
        return "cloud/" + mRemoteAct;
    }

    @Override
    protected Header[] buildHeaders(Header[] pHeaders) {
        return FH.getDefaultParamsAsHeaders(pHeaders);
    }
}