com.aliyun.api.AliyunRequest Maven / Gradle / Ivy

Go to download
package com.aliyun.api;

import java.util.Map;

import com.taobao.api.ApiRuleException;

/**
 * aliyun sdk 请求信息。
 * 
 * @author lijie.ma
 * @since 1.0, May 19, 2014
 */
public interface AliyunRequest{
	/**
	 * 获取TOP的API名称。
	 * 
	 * @return API名称
	 */
	public String getApiMethodName();

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

	/**
	 * @return 指定或默认的时间戳
	 */
	public Long getTimestamp();

	/**
	 * 设置时间戳，如果不设置,发送请求时将使用当时的时间。
	 * 
	 * @param timestamp 时间戳
	 */
	public void setTimestamp(Long timestamp);

	public Class getResponseClass();

	/**
	 * 客户端参数检查，减少服务端无效调用
	 */
	public void check() throws ApiRuleException;

	/**
	 * 添加HTTP请求头参数
	 */
	public Map getHeaderMap();

	/**
	 * 添加自定义请求参数
	 */
	public void putOtherTextParam(String key, String value);
}