com.aiwiown.face.ApiRequest Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of face-java-sdk Show documentation

Face++ java sdk

There is a newer version: 3.0.9

package com.aiwiown.face;

import java.util.Map;

/**
 * 请求接口。
 *
 * @author carver.gu
 * @since 1.0, Sep 12, 2009
 */
public interface ApiRequest {
    /**
     * 获取请求的形式
     *
     * @return ApiMethod
     */
    ApiMethod getApiMethod();

    /**
     * 获取请求地址
     *
     * @return String
     */
    String getApiUrl();

    /**
     * 获取所有的Key-Value形式的文本请求参数集合。其中：
     * 
     * Key: 请求参数名
     * Value: 请求参数值
     * 
     *
     * @return 文本请求参数集合
     */
    Map getTextParams() throws IllegalAccessException;

    /**
     * 获取所有的Key-Byte[]形式的文本请求参数集合。其中：
     * 
     * Key: 请求参数名
     * Value: 请求参数值
     * 
     *
     * @return 图片请求参数集合
     */
    Map getByteArrayParams() throws IllegalAccessException;

    /**
     * 得到当前接口的版本
     *
     * @return API版本
     */
    String getApiVersion();

    /**
     * 得到当前API的响应结果类型
     *
     * @return 响应类型
     */
    Class getResponseClass();

    /**
     * @return
     */
    String getBizContent();

    /**
     * 签名方法
     *
     * @return
     */
    String signVersion();

    /**
     * 签名消息
     *
     * @return
     */
    String getSignInfo(String apiKey, String secretKey) throws Exception;

}