XRequest.java
1.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
package com.xiniunet.open.api.client;
import java.util.Map;
/**
*/
public interface XRequest<T extends XResponse> {
/**
* 获取TOP的API名称。
*
* @return API名称
*/
String getApiMethodName();
/**
* 获取所有的Key-Value形式的文本请求参数集合。其中：
* <ul>
* <li>Key: 请求参数名</li>
* <li>Value: 请求参数值</li>
* </ul>
*
* @return 文本请求参数集合
*/
Map<String, String> getTextParams();
/**
* @return 指定或默认的时间戳
*/
Long getTimestamp();
/**
* 设置时间戳，如果不设置,发送请求时将使用当时的时间。
*
* @param timestamp 时间戳
*/
void setTimestamp(Long timestamp);
/**
* 获取响应类型
* @return
*/
Class<T> getResponseClass();
/**
* 客户端参数检查，减少服务端无效调用
*/
void check() throws ApiRuleException;
/**
* 添加HTTP请求头参数
*/
Map<String, String> getHeaderMap();
/**
* 添加自定义请求参数
*/
void putOtherTextParam(String key, String value);
}