• Home
• com.github.ddth
• ddth-commons-core
• 1.0.0
• source code
• JsonRpcUtils.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.ddth.commons.jsonrpc.JsonRpcUtils Maven / Gradle / Ivy

package com.github.ddth.commons.jsonrpc;

import java.util.Map;

import com.fasterxml.jackson.databind.JsonNode;
import com.github.ddth.commons.utils.MapUtils;
import com.github.ddth.commons.utils.SerializationUtils;

/**
 * Json-RPC helper class.
 * 
 * @author Thanh Nguyen 
 * @since 0.9.0
 */
public class JsonRpcUtils {
    public final static String FIELD_STATUS = "status";
    public final static String FIELD_MESSAGE = "message";
    public final static String FIELD_DATA = "data";

    public final static HttpJsonRpcClient httpJsonRpcClient = new HttpJsonRpcClient().init();

    /**
     * Build Json-RPC's response in JSON format.
     * 
     * 

     * Json-RPC response as the following format:
     * 
     * 
     * 
     * {
     *     "status" : (int) response status/error code,
     *     "message": (string) response message,
     *     "data"   : (object) response data
     * }
     * 
     * 
     * @param status
     * @param message
     * @param data
     * @return
     */
    public static JsonNode buildResponse(int status, String message, Object data) {
        return SerializationUtils.toJson(MapUtils.removeNulls(MapUtils.createMap(FIELD_STATUS,
                status, FIELD_MESSAGE, message, FIELD_DATA, data)));
    }

    /**
     * Build Json-RPC's response in JSON format.
     * 
     * @param status
     * @return
     * @see #buildResponse(int, String, Object)
     */
    public static JsonNode buildResponse(int status) {
        return buildResponse(status, null, null);
    }

    /**
     * Build Json-RPC's response in JSON format.
     * 
     * @param status
     * @param message
     * @return
     * @see #buildResponse(int, String, Object)
     */
    public static JsonNode buildResponse(int status, String message) {
        return buildResponse(status, message, null);
    }

    /**
     * Build Json-RPC's response in JSON format.
     * 
     * @param status
     * @param data
     * @return
     * @see #buildResponse(int, String, Object)
     */
    public static JsonNode buildResponse(int status, Object data) {
        return buildResponse(status, null, data);
    }

    /**
     * Perform a HTTP GET request using default HTTP client.
     * 
     * @param url
     * @param headers
     * @param urlParams
     * @return
     */
    public static RequestResponse callHttpGet(String url, Map headers,
            Map urlParams) {
        return callHttpGet(httpJsonRpcClient, url, headers, urlParams);
    }

    /**
     * Perform a HTTP GET request using supplied HTTP client.
     * 
     * @param client
     * @param url
     * @param headers
     * @param urlParams
     * @return
     * @since 0.9.1.6
     */
    public static RequestResponse callHttpGet(HttpJsonRpcClient client, String url,
            Map headers, Map urlParams) {
        return client.doGet(url, headers, urlParams);
    }

    /**
     * Perform a HTTP POST request using default HTTP client.
     * 
     * @param url
     * @param headers
     * @param urlParams
     * @param requestData
     * @return
     */
    public static RequestResponse callHttpPost(String url, Map headers,
            Map urlParams, Object requestData) {
        return callHttpPost(httpJsonRpcClient, url, headers, urlParams, requestData);
    }

    /**
     * Perform a HTTP POST request using supplied HTTP client.
     * 
     * @param client
     * @param url
     * @param headers
     * @param urlParams
     * @param requestData
     * @return
     * @since 0.9.1.6
     */
    public static RequestResponse callHttpPost(HttpJsonRpcClient client, String url,
            Map headers, Map urlParams, Object requestData) {
        return client.doPost(url, headers, urlParams, requestData);
    }

    /**
     * Perform a HTTP PUT request using default HTTP client.
     * 
     * @param url
     * @param headers
     * @param urlParams
     * @param requestData
     * @return
     */
    public static RequestResponse callHttpPut(String url, Map headers,
            Map urlParams, Object requestData) {
        return callHttpPut(httpJsonRpcClient, url, headers, urlParams, requestData);
    }

    /**
     * Perform a HTTP PUT request using supplied HTTP client.
     * 
     * @param client
     * @param url
     * @param headers
     * @param urlParams
     * @param requestData
     * @return
     * @since 0.9.1.6
     */
    public static RequestResponse callHttpPut(HttpJsonRpcClient client, String url,
            Map headers, Map urlParams, Object requestData) {
        return client.doPut(url, headers, urlParams, requestData);
    }

    /**
     * Perform a HTTP PATCH request using default HTTP client.
     * 
     * @param url
     * @param headers
     * @param urlParams
     * @param requestData
     * @return
     */
    public static RequestResponse callHttpPatch(String url, Map headers,
            Map urlParams, Object requestData) {
        return callHttpPatch(httpJsonRpcClient, url, headers, urlParams, requestData);
    }

    /**
     * Perform a HTTP PATCH request using supplied HTTP client.
     * 
     * @param client
     * @param url
     * @param headers
     * @param urlParams
     * @param requestData
     * @return
     * @since 0.9.1.6
     */
    public static RequestResponse callHttpPatch(HttpJsonRpcClient client, String url,
            Map headers, Map urlParams, Object requestData) {
        return client.doPatch(url, headers, urlParams, requestData);
    }

    /**
     * Perform a HTTP DELETE request using default HTTP client.
     * 
     * @param url
     * @param headers
     * @param urlParams
     * @return
     */
    public static RequestResponse callHttpDelete(String url, Map headers,
            Map urlParams) {
        return callHttpDelete(httpJsonRpcClient, url, headers, urlParams);
    }

    /**
     * Perform a HTTP DELETE request using supplied HTTP client.
     * 
     * @param client
     * @param url
     * @param headers
     * @param urlParams
     * @return
     * @since 0.9.1.6
     */
    public static RequestResponse callHttpDelete(HttpJsonRpcClient client, String url,
            Map headers, Map urlParams) {
        return client.doDelete(url, headers, urlParams);
    }

    /**
     * Perform a HTTP DELETE request using default HTTP client.
     * 
     * @param url
     * @param headers
     * @param urlParams
     * @param requestData
     * @return
     * @deprecated since v0.9.3
     */
    public static RequestResponse callHttpDelete(String url, Map headers,
            Map urlParams, Object requestData) {
        return callHttpDelete(httpJsonRpcClient, url, headers, urlParams, requestData);
    }

    /**
     * Perform a HTTP DELETE request using supplied HTTP client.
     * 
     * @param client
     * @param url
     * @param headers
     * @param urlParams
     * @param requestData
     * @return
     * @since 0.9.1.6
     * @deprecated since v0.9.3
     */
    public static RequestResponse callHttpDelete(HttpJsonRpcClient client, String url,
            Map headers, Map urlParams, Object requestData) {
        return client.doDelete(url, headers, urlParams, requestData);
    }
}