com.icoderman.woocommerce.HttpClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wc-api-java Show documentation

Java wrapper for WooCommerce REST API

There is a newer version: 1.4

package com.icoderman.woocommerce;

import java.util.List;
import java.util.Map;

/**
 * Basic interface for HTTP client
 */
public interface HttpClient {

    /**
     * Requests url with HTTP GET and returns result object as Map
     *
     * @param url url to request
     * @return retrieved result
     */
    Map get(String url);

    /**
     * Requests url with HTTP GET and returns List of objects (Maps)
     *
     * @param url url to request
     * @return retrieved result
     */
    List getAll(String url);

    /**
     * Requests url with HTTP POST and retrieves result object as Map
     *
     * @param url    url to request
     * @param params request params
     * @param object request object with will be sent as json
     * @return retrieved result
     */
    Map post(String url, Map params, Map object);

    /**
     * Requests url with HTTP PUT and retrieves result object as Map
     *
     * @param url    url to request
     * @param params request params
     * @param object request object with will be sent as json
     * @return retrieved result
     */
    Map put(String url, Map params, Map object);

    /**
     * Requests url with HTTP DELETE and retrieves result object as Map
     *
     * @param url    url to request
     * @param params request params
     * @return retrieved result
     */
    Map delete(String url, Map params);
}