org.sdn.api.sdk.SDKOpenClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of open-framework Show documentation
The newest version!
package org.sdn.api.sdk;


import org.sdn.api.OpenClient;
import org.sdn.api.constants.Msg;

import java.util.Map;

/**
 * User: fan
 * Date: 2018/12/12
 * Time: 12:03
 */
public interface SDKOpenClient {

    /**
     * API Gateway URL设置
     *
     * @param path
     */
    void setPath(String path);

    /**
     * @param appkey
     */
    void setAppkey(String appkey);

    void setAppSecret(String appSecret);

    void setNeedSubscribe(boolean needSubscribe);

    /**
     * 获取调用客户端实例
     *
     * @return 调用客户端
     */
    OpenClient getOpenClient() throws Exception;

    /**
     * 默认 Post
     *
     * @param path   路径
     * @param params 参数
     * @return
     */
    Msg forward(String path, Map params) throws Exception;

    /**
     * 默认 Post
     *
     * @param path    路径
     * @param params  参数
     * @param headers 请求头
     * @return
     */
    Msg forward(String path, Map params, Map headers) throws Exception;

    /**
     * 默认 Post
     * object 只允许传 javaBean
     *
     * @param path   路径
     * @param object 参数
     * @return
     */
    Msg forward(String path, Object object) throws Exception;

    /**
     * 默认 Post
     * object 只允许传 javaBean
     *
     * @param path    路径
     * @param object  参数
     * @param headers 请求头
     * @return
     */
    Msg forward(String path, Object object, Map headers) throws Exception;


    /**
     * object 只允许传 javaBean
     *
     * @param path   路径
     * @param method 请求方式
     * @param object 参数
     * @return
     */
    Msg forward(String path, String method, Object object) throws Exception;


    /**
     * object 只允许传 javaBean
     *
     * @param path    路径
     * @param method  请求方式
     * @param object  参数
     * @param headers 请求头
     * @return
     */
    Msg forward(String path, String method, Object object, Map headers) throws Exception;

    /**
     * @param path   路径
     * @param method 请求方式
     * @param params 参数
     * @return
     */
    Msg forward(String path, String method, Map params) throws Exception;

    /**
     * @param path    路径
     * @param method  请求方式
     * @param params  参数
     * @param headers 请求头
     * @return
     */
    Msg forward(String path, String method, Map params, Map headers) throws Exception;

}