com.qiniu.util

类 Auth

java.lang.Object

com.qiniu.util.Auth

public final class Auth
extends java.lang.Object

字段概要

字段

限定符和类型	字段和说明
java.lang.String	accessKey

方法概要

限定符和类型	方法和说明
StringMap	authorization(java.lang.String url)
StringMap	authorization(java.lang.String url, byte[] body, java.lang.String contentType)
StringMap	authorizationV2(java.lang.String url)
StringMap	authorizationV2(java.lang.String url, java.lang.String method, byte[] body, java.lang.String contentType)
static Auth	create(java.lang.String accessKey, java.lang.String secretKey)
boolean	isValidCallback(java.lang.String originAuthorization, java.lang.String url, byte[] body, java.lang.String contentType) 验证回调签名是否正确
java.lang.String	privateDownloadUrl(java.lang.String baseUrl) 下载签名
java.lang.String	privateDownloadUrl(java.lang.String baseUrl, long expires) 下载签名
java.lang.String	privateDownloadUrlWithDeadline(java.lang.String baseUrl, long deadline)
java.lang.String	sign(byte[] data)
java.lang.String	sign(java.lang.String data)
java.lang.String	signRequest(java.lang.String urlString, byte[] body, java.lang.String contentType) 生成HTTP请求签名字符串
java.lang.String	signRequestV2(java.lang.String urlString, java.lang.String method, byte[] body, java.lang.String contentType) 生成HTTP请求签名字符串
java.lang.String	signRoomToken(java.lang.String roomAccess)
java.lang.String	signWithData(byte[] data)
java.lang.String	signWithData(java.lang.String data)
java.lang.String	uploadToken(java.lang.String bucket) scope = bucket 一般情况下可通过此方法获取token
java.lang.String	uploadToken(java.lang.String bucket, java.lang.String key) scope = bucket:key 同名文件覆盖操作、只能上传指定key的文件可以可通过此方法获取token
java.lang.String	uploadToken(java.lang.String bucket, java.lang.String key, long expires, StringMap policy) 生成上传token
java.lang.String	uploadToken(java.lang.String bucket, java.lang.String key, long expires, StringMap policy, boolean strict) 生成上传token
java.lang.String	uploadTokenWithDeadline(java.lang.String bucket, java.lang.String key, long deadline, StringMap policy, boolean strict)
java.lang.String	uploadTokenWithPolicy(java.lang.Object obj)

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

accessKey

public final java.lang.String accessKey

方法详细资料

create

public static Auth create(java.lang.String accessKey,
                          java.lang.String secretKey)

sign

public java.lang.String sign(byte[] data)

sign

public java.lang.String sign(java.lang.String data)

signWithData

public java.lang.String signWithData(byte[] data)

signWithData

public java.lang.String signWithData(java.lang.String data)

signRequest

public java.lang.String signRequest(java.lang.String urlString,
                                    byte[] body,
                                    java.lang.String contentType)

生成HTTP请求签名字符串

参数:

urlString -

body -

contentType -

返回:

isValidCallback

public boolean isValidCallback(java.lang.String originAuthorization,
                               java.lang.String url,
                               byte[] body,
                               java.lang.String contentType)

验证回调签名是否正确

参数:

originAuthorization - 待验证签名字符串，以 "QBox "作为起始字符

url - 回调地址

body - 回调请求体。原始请求体，不要解析后再封装成新的请求体--可能导致签名不一致。

contentType - 回调ContentType

返回:

privateDownloadUrl

public java.lang.String privateDownloadUrl(java.lang.String baseUrl)

下载签名

参数:

baseUrl - 待签名文件url，如 http://img.domain.com/u/3.jpg 、 http://img.domain.com/u/3.jpg?imageView2/1/w/120

返回:

privateDownloadUrl

public java.lang.String privateDownloadUrl(java.lang.String baseUrl,
                                           long expires)

下载签名

参数:

baseUrl - 待签名文件url，如 http://img.domain.com/u/3.jpg 、 http://img.domain.com/u/3.jpg?imageView2/1/w/120

expires - 有效时长，单位秒。默认3600s

返回:

privateDownloadUrlWithDeadline

public java.lang.String privateDownloadUrlWithDeadline(java.lang.String baseUrl,
                                                       long deadline)

uploadToken

public java.lang.String uploadToken(java.lang.String bucket)

scope = bucket 一般情况下可通过此方法获取token

参数:

bucket - 空间名

返回:

生成的上传token

uploadToken

public java.lang.String uploadToken(java.lang.String bucket,
                                    java.lang.String key)

scope = bucket:key 同名文件覆盖操作、只能上传指定key的文件可以可通过此方法获取token

参数:

bucket - 空间名

key - key，可为 null

返回:

生成的上传token

uploadToken

public java.lang.String uploadToken(java.lang.String bucket,
                                    java.lang.String key,
                                    long expires,
                                    StringMap policy)

生成上传token

参数:

bucket - 空间名

key - key，可为 null

expires - 有效时长，单位秒

policy - 上传策略的其它参数，如 new StringMap().put("endUser", "uid").putNotEmpty("returnBody", "")。 scope通过 bucket、key间接设置，deadline 通过 expires 间接设置

返回:

生成的上传token

uploadToken

public java.lang.String uploadToken(java.lang.String bucket,
                                    java.lang.String key,
                                    long expires,
                                    StringMap policy,
                                    boolean strict)

生成上传token

参数:

bucket - 空间名

key - key，可为 null

expires - 有效时长，单位秒。默认3600s

policy - 上传策略的其它参数，如 new StringMap().put("endUser", "uid").putNotEmpty("returnBody", "")。 scope通过 bucket、key间接设置，deadline 通过 expires 间接设置

strict - 是否去除非限定的策略字段，默认true

返回:

生成的上传token

uploadTokenWithDeadline

public java.lang.String uploadTokenWithDeadline(java.lang.String bucket,
                                                java.lang.String key,
                                                long deadline,
                                                StringMap policy,
                                                boolean strict)

uploadTokenWithPolicy

public java.lang.String uploadTokenWithPolicy(java.lang.Object obj)

authorization

public StringMap authorization(java.lang.String url,
                               byte[] body,
                               java.lang.String contentType)

authorization

public StringMap authorization(java.lang.String url)

signRequestV2

public java.lang.String signRequestV2(java.lang.String urlString,
                                      java.lang.String method,
                                      byte[] body,
                                      java.lang.String contentType)

生成HTTP请求签名字符串

参数:

urlString -

body -

contentType -

返回:

authorizationV2

public StringMap authorizationV2(java.lang.String url,
                                 java.lang.String method,
                                 byte[] body,
                                 java.lang.String contentType)

authorizationV2

public StringMap authorizationV2(java.lang.String url)

signRoomToken

public java.lang.String signRoomToken(java.lang.String roomAccess)
                               throws java.lang.Exception

抛出:

java.lang.Exception