Skip to content

Commit fd1d4e4

Browse files
bachuebachue
authored
Merge pull request #566 from YangSen-qn/javadoc
javadoc: change code commit style
2 parents d89f387 + 857416d commit fd1d4e4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+815
-431
lines changed

‎src/main/java/com/qiniu/cdn/CdnManager.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ public static String createTimestampAntiLeechUrl(URL oUrl, String encryptKey, lo
9393
* @param encryptKey 时间戳防盗链的签名密钥，从七牛后台获取
9494
* @param deadline 链接的有效期时间戳，是以秒为单位的Unix时间戳
9595
* @return signedUrl 最终的带时间戳防盗链的url
96+
* @throws QiniuException 异常
9697
*/
9798
public static String createTimestampAntiLeechUrl(
9899
String host, String fileName, final StringMap queryStringMap, String encryptKey, long deadline)
@@ -127,6 +128,7 @@ public static String createTimestampAntiLeechUrl(
127128
*
128129
* @param urls 待刷新文件外链列表
129130
* @return 刷新请求的回复
131+
* @throws QiniuException 异常
130132
*/
131133
public CdnResult.RefreshResult refreshUrls(String[] urls) throws QiniuException {
132134
return refreshUrlsAndDirs(urls, null);
@@ -139,6 +141,7 @@ public CdnResult.RefreshResult refreshUrls(String[] urls) throws QiniuException
139141
*
140142
* @param dirs 待刷新目录列表
141143
* @return 刷新请求的回复
144+
* @throws QiniuException 异常
142145
*/
143146
public CdnResult.RefreshResult refreshDirs(String[] dirs) throws QiniuException {
144147
return refreshUrlsAndDirs(null, dirs);
@@ -152,6 +155,7 @@ public CdnResult.RefreshResult refreshDirs(String[] dirs) throws QiniuException
152155
* @param urls 待刷新文件外链列表
153156
* @param dirs 待刷新目录列表
154157
* @return 刷新请求的回复
158+
* @throws QiniuException 异常
155159
*/
156160
public CdnResult.RefreshResult refreshUrlsAndDirs(String[] urls, String[] dirs) throws QiniuException {
157161
//check params
@@ -182,6 +186,7 @@ public CdnResult.RefreshResult refreshUrlsAndDirs(String[] urls, String[] dirs)
182186
*
183187
* @param urls 待预取的文件外链列表
184188
* @return 预取请求的回复
189+
* @throws QiniuException 异常
185190
*/
186191
public CdnResult.PrefetchResult prefetchUrls(String[] urls) throws QiniuException {
187192
if (urls != null && urls.length > MAX_API_PREFETCH_URL_COUNT) {
@@ -205,6 +210,7 @@ public CdnResult.PrefetchResult prefetchUrls(String[] urls) throws QiniuExceptio
205210
* @param endDate 截至日期，格式为：2017-02-20
206211
* @param granularity 数据粒度，支持的取值为 5min ／ hour ／day
207212
* @return 获取带宽数据请求的回复
213+
* @throws QiniuException 异常
208214
*/
209215
public CdnResult.BandwidthResult getBandwidthData(String[] domains, String startDate, String endDate,
210216
String granularity) throws QiniuException {
@@ -230,6 +236,7 @@ public CdnResult.BandwidthResult getBandwidthData(String[] domains, String start
230236
* @param endDate 截至日期，格式为：2017-02-20
231237
* @param granularity 数据粒度，支持的取值为 5min ／ hour ／day
232238
* @return 获取流量数据请求的回复
239+
* @throws QiniuException 异常
233240
*/
234241
public CdnResult.FluxResult getFluxData(String[] domains, String startDate, String endDate,
235242
String granularity) throws QiniuException {
@@ -253,6 +260,7 @@ public CdnResult.FluxResult getFluxData(String[] domains, String startDate, Stri
253260
* @param domains 待获取日志下载信息的域名列表
254261
* @param logDate 待获取日志的具体日期，格式为：2017-02-18
255262
* @return 获取日志下载链接的回复
263+
* @throws QiniuException 异常
256264
*/
257265
public CdnResult.LogListResult getCdnLogList(String[] domains, String logDate) throws QiniuException {
258266
HashMap<String, String> req = new HashMap<>();

‎src/main/java/com/qiniu/common/AutoZone.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ private UCRet getZoneJson(ZoneIndex index) throws QiniuException {
6161
* @param accessKey 账号 accessKey
6262
* @param bucket 空间名
6363
* @return 机房域名信息
64+
* @throws QiniuException 异常
6465
*/
6566
public ZoneInfo queryZoneInfo(String accessKey, String bucket) throws QiniuException {
6667
ZoneIndex index = new ZoneIndex(accessKey, bucket);

‎src/main/java/com/qiniu/common/Zone.java

Lines changed: 88 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ public class Zone {
88

99
// 区域名称：z0 华东 z1 华北 z2 华南 na0 北美 as0 东南亚
1010
private String region = "z0";
11+
1112
/**
1213
* 上传，备用上传，备用上传IP和源站资源域名使用各个机房对应的域名
1314
*/
@@ -34,6 +35,7 @@ public class Zone {
3435

3536
/**
3637
* 华东机房相关域名
38+
* @return 域名信息
3739
*/
3840
public static Zone zone0() {
3941
return new Builder().region("z0")
@@ -48,13 +50,15 @@ public static Zone zone0() {
4850

4951
/**
5052
* 华东机房相关域名
53+
* @return 域名信息
5154
*/
5255
public static Zone huadong() {
5356
return zone0();
5457
}
5558

5659
/**
5760
* 华东机房内网上传相关域名
61+
* @return 域名信息
5862
*/
5963
public static Zone qvmZone0() {
6064
return new Builder().region("z0")
@@ -69,13 +73,15 @@ public static Zone qvmZone0() {
6973

7074
/**
7175
* 华东机房内网上传相关域名
76+
* @return 域名信息
7277
*/
7378
public static Zone qvmHuadong() {
7479
return qvmZone0();
7580
}
7681

7782
/**
7883
* 华北机房相关域名
84+
* @return 域名信息
7985
*/
8086
public static Zone zone1() {
8187
return new Builder().region("z1")
@@ -90,13 +96,15 @@ public static Zone zone1() {
9096

9197
/**
9298
* 华北机房相关域名
99+
* @return 域名信息
93100
*/
94101
public static Zone huabei() {
95102
return zone1();
96103
}
97104

98105
/**
99106
* 华北机房内网上传相关域名
107+
* @return 域名信息
100108
*/
101109
public static Zone qvmZone1() {
102110
return new Builder().region("z1")
@@ -111,13 +119,15 @@ public static Zone qvmZone1() {
111119

112120
/**
113121
* 华北机房内网上传相关域名
122+
* @return 域名信息
114123
*/
115124
public static Zone qvmHuabei() {
116125
return qvmZone1();
117126
}
118127

119128
/**
120129
* 华南机房相关域名
130+
* @return 域名信息
121131
*/
122132
public static Zone zone2() {
123133
return new Builder().region("z2")
@@ -132,13 +142,15 @@ public static Zone zone2() {
132142

133143
/**
134144
* 华南机房相关域名
145+
* @return 域名信息
135146
*/
136147
public static Zone huanan() {
137148
return zone2();
138149
}
139150

140151
/**
141152
* 北美机房相关域名
153+
* @return 域名信息
142154
*/
143155
public static Zone zoneNa0() {
144156
return new Builder().region("na0")
@@ -153,13 +165,15 @@ public static Zone zoneNa0() {
153165

154166
/**
155167
* 北美机房相关域名
168+
* @return 域名信息
156169
*/
157170
public static Zone beimei() {
158171
return zoneNa0();
159172
}
160173

161174
/**
162175
* 新加坡相关域名
176+
* @return 域名信息
163177
*/
164178
public static Zone zoneAs0() {
165179
return new Builder().region("as0")
@@ -174,6 +188,7 @@ public static Zone zoneAs0() {
174188

175189
/**
176190
* 新加坡机房相关域名
191+
* @return 域名信息
177192
*/
178193
public static Zone xinjiapo() {
179194
return zoneAs0();
@@ -182,31 +197,59 @@ public static Zone xinjiapo() {
182197
/**
183198
* 自动根据AccessKey和Bucket来判断所在机房，并获取相关的域名
184199
* 空间所在的对应机房可以在空间创建的时候选择，或者创建完毕之后，从后台查看
200+
*
201+
* @return 域名信息
185202
*/
186203
public static Zone autoZone() {
187204
return new Builder().autoZone();
188205
}
189206

207+
/**
208+
* 获取区域 ID
209+
*
210+
* @param zoneReqInfo token 信息
211+
* @return 区域 ID
212+
*/
190213
public String getRegion(ZoneReqInfo zoneReqInfo) {
191214
return this.region;
192215
}
193216

194217
/**
195-
* 保留自动获取上传和资源抓取，更新相关域名接口
218+
* 获取上传 HTTP URL
219+
*
220+
* @param zoneReqInfo token 信息
221+
* @return URL
196222
*/
197-
198223
public String getUpHttp(ZoneReqInfo zoneReqInfo) {
199224
return this.upHttp;
200225
}
201226

227+
/**
228+
* 获取上传 HTTPS URL
229+
*
230+
* @param zoneReqInfo token 信息
231+
* @return URL
232+
*/
202233
public String getUpHttps(ZoneReqInfo zoneReqInfo) {
203234
return this.upHttps;
204235
}
205236

237+
/**
238+
* 获取备用上传 HTTP URL
239+
*
240+
* @param zoneReqInfo token 信息
241+
* @return URL
242+
*/
206243
public String getUpBackupHttp(ZoneReqInfo zoneReqInfo) {
207244
return this.upBackupHttp;
208245
}
209246

247+
/**
248+
* 获取备用上传 HTTPS URL
249+
*
250+
* @param zoneReqInfo token 信息
251+
* @return URL
252+
*/
210253
public String getUpBackupHttps(ZoneReqInfo zoneReqInfo) {
211254
return this.upBackupHttps;
212255
}
@@ -228,34 +271,69 @@ public String getIovipHttps(ZoneReqInfo zoneReqInfo) {
228271
}
229272

230273
/**
231-
* 保留自动获取资源管理，资源列表，资源处理相关域名接口
274+
* 获取 RS HTTP URL
275+
*
276+
* @param zoneReqInfo token 信息
277+
* @return r
232278
*/
233279
public String getRsHttp(ZoneReqInfo zoneReqInfo) {
234280
return rsHttp;
235281
}
236282

283+
/**
284+
* 获取 RS HTTPS URL
285+
*
286+
* @param zoneReqInfo token 信息
287+
* @return r
288+
*/
237289
public String getRsHttps(ZoneReqInfo zoneReqInfo) {
238290
return rsHttps;
239291
}
240292

293+
/**
294+
* 获取 RSF HTTP URL
295+
*
296+
* @param zoneReqInfo token 信息
297+
* @return r
298+
*/
241299
public String getRsfHttp(ZoneReqInfo zoneReqInfo) {
242300
return rsfHttp;
243301
}
244302

303+
/**
304+
* 获取 RSF HTTPS URL
305+
*
306+
* @param zoneReqInfo token 信息
307+
* @return r
308+
*/
245309
public String getRsfHttps(ZoneReqInfo zoneReqInfo) {
246310
return rsfHttps;
247311
}
248312

313+
/**
314+
* 获取 API HTTP URL
315+
*
316+
* @param zoneReqInfo token 信息
317+
* @return r
318+
*/
249319
public String getApiHttp(ZoneReqInfo zoneReqInfo) {
250320
return apiHttp;
251321
}
252322

323+
/**
324+
* 获取 API HTTPS URL
325+
*
326+
* @param zoneReqInfo token 信息
327+
* @return r
328+
*/
253329
public String getApiHttps(ZoneReqInfo zoneReqInfo) {
254330
return apiHttps;
255331
}
256332

257333
/**
258-
* 获取资源管理，资源列表，资源处理相关域名
334+
* 获取区域 ID
335+
*
336+
* @return 区域 ID
259337
*/
260338
public String getRegion() {
261339
return this.region;
@@ -391,14 +469,18 @@ public Builder apiHttps(String apiHttps) {
391469

392470

393471
/**
394-
* 自动选择,其它参数设置无效
472+
* 自动选择区域，其它参数设置无效
473+
*
474+
* @return 区域信息
395475
*/
396476
public Zone autoZone() {
397477
return AutoZone.instance;
398478
}
399479

400480
/**
401-
* 返回构建好的Zone对象
481+
* 构建 Zone 对象
482+
*
483+
* @return 区域信息
402484
*/
403485
public Zone build() {
404486
return zone;

‎src/main/java/com/qiniu/http/Client.java

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ public Client() {
4040

4141
/**
4242
* 构建一个自定义配置的 HTTP Client 类
43+
*
44+
* @param cfg 配置信息
4345
*/
4446
public Client(Configuration cfg) {
4547
this(cfg.dns, cfg.useDnsHostFirst, cfg.proxy,
@@ -57,6 +59,17 @@ public Client(com.qiniu.sms.Configuration cfg) {
5759

5860
/**
5961
* 构建一个自定义配置的 HTTP Client 类
62+
*
63+
* @param dns dns 解析类
64+
* @param hostFirst 是否优先使用 host
65+
* @param proxy 代理
66+
* @param connTimeout 链接超时
67+
* @param readTimeout 读超时
68+
* @param writeTimeout 写超时
69+
* @param dispatcherMaxRequests 并发最大请求数
70+
* @param dispatcherMaxRequestsPerHost 单 Host 并发最大请求数
71+
* @param connectionPoolMaxIdleCount 连接池中请求最大空闲数
72+
* @param connectionPoolMaxIdleMinutes 连接池中请求最大空闲分钟数
6073
*/
6174
public Client(final Dns dns, final boolean hostFirst, final ProxyConfiguration proxy,
6275
int connTimeout, int readTimeout, int writeTimeout, int dispatcherMaxRequests,

0 commit comments

Comments
 (0)