AbstractAWSSigner (java-sdk 1.2.3 API)

java.lang.Object
- com.sinacloud.scs.auth.AbstractAWSSigner

所有已实现的接口:

Signer

直接已知子类:

S3QueryStringSigner, S3Signer
```
public abstract class AbstractAWSSigner
extends Object
implements Signer
```
Abstract base class for AWS signing protocol implementations. Provides utilities commonly needed by signing protocols such as computing canonicalized host names, query string parameters, etc.
Not intended to be sub-classed by developers.

字段概要

字段
限定符和类型字段和说明

protected static String DEFAULT_ENCODING
The default encoding to use when URL encoding

字段
限定符和类型	字段和说明
`protected static String`	`DEFAULT_ENCODING` The default encoding to use when URL encoding

构造器概要

构造器
构造器和说明

AbstractAWSSigner()

构造器
构造器和说明
`AbstractAWSSigner()`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected abstract void`	`addSessionCredentials(Request<?> request, AWSSessionCredentials credentials)` Adds session credentials to the request given.
`protected byte[]`	`getBinaryRequestPayload(Request<?> request)` Returns the request's payload as binary data.
`protected InputStream`	`getBinaryRequestPayloadStream(Request<?> request)`
`protected InputStream`	`getBinaryRequestPayloadStreamWithoutQueryParams(Request<?> request)`
`protected byte[]`	`getBinaryRequestPayloadWithoutQueryParams(Request<?> request)` Returns the request's payload contents as binary data, without processing any query string params (i.e. no form encoding for query params).
`protected String`	`getCanonicalizedEndpoint(URI endpoint)`
`protected String`	`getCanonicalizedQueryString(Map<String,String> parameters)` Examines the specified query string parameters and returns a canonicalized form.
`protected String`	`getCanonicalizedQueryString(Request<?> request)`
`protected String`	`getCanonicalizedResourcePath(String resourcePath)`
`protected String`	`getCanonicalizedResourcePath(String resourcePath, boolean urlEncode)`
`protected String`	`getRequestPayload(Request<?> request)` Returns the request's payload as a String.
`protected String`	`getRequestPayloadWithoutQueryParams(Request<?> request)` Returns the request's payload contents as a String, without processing any query string params (i.e. no form encoding for query params).
`protected Date`	`getSignatureDate(int timeOffset)`
`protected int`	`getTimeOffset(Request<?> request)`
`byte[]`	`hash(byte[] data)` Hashes the binary data using the SHA-256 algorithm.
`protected byte[]`	`hash(InputStream input)`
`byte[]`	`hash(String text)` Hashes the string contents (assumed to be UTF-8) using the SHA-256 algorithm.
`protected String`	`newString(byte[] bytes)` Safely converts a UTF-8 encoded byte array into a String.
`protected AWSCredentials`	`sanitizeCredentials(AWSCredentials credentials)` Loads the individual access key ID and secret key from the specified credentials, ensuring that access to the credentials is synchronized on the credentials object itself, and trimming any extra whitespace from the credentials.
`protected byte[]`	`sign(byte[] data, byte[] key, SigningAlgorithm algorithm)`
`byte[]`	`sign(String stringData, byte[] key, SigningAlgorithm algorithm)`
`protected String`	`signAndBase64Encode(byte[] data, String key, SigningAlgorithm algorithm)` Computes an RFC 2104-compliant HMAC signature for an array of bytes and returns the result as a Base64 encoded string.
`protected String`	`signAndBase64Encode(String data, String key, SigningAlgorithm algorithm)` Computes an RFC 2104-compliant HMAC signature and returns the result as a Base64 encoded string.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 com.sinacloud.scs.auth.Signer
sign

- 字段详细资料
  - DEFAULT_ENCODING
```
protected static final String DEFAULT_ENCODING
```
    The default encoding to use when URL encoding
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - AbstractAWSSigner
```
public AbstractAWSSigner()
```
- 方法详细资料
  - signAndBase64Encode
```
protected String signAndBase64Encode(String data,
                                     String key,
                                     SigningAlgorithm algorithm)
                              throws SCSClientException
```
    Computes an RFC 2104-compliant HMAC signature and returns the result as a Base64 encoded string.
    
    抛出:
    
    SCSClientException
  - signAndBase64Encode
```
protected String signAndBase64Encode(byte[] data,
                                     String key,
                                     SigningAlgorithm algorithm)
                              throws SCSClientException
```
    Computes an RFC 2104-compliant HMAC signature for an array of bytes and returns the result as a Base64 encoded string.
    
    抛出:
    
    SCSClientException
  - sign
```
public byte[] sign(String stringData,
                   byte[] key,
                   SigningAlgorithm algorithm)
            throws SCSClientException
```
    抛出:
    
    SCSClientException
  - sign
```
protected byte[] sign(byte[] data,
                      byte[] key,
                      SigningAlgorithm algorithm)
               throws SCSClientException
```
    抛出:
    
    SCSClientException
  - hash
```
public byte[] hash(String text)
            throws SCSClientException
```
    Hashes the string contents (assumed to be UTF-8) using the SHA-256 algorithm.
    
    参数:
    
    text - The string to hash.
    
    返回:
    
    The hashed bytes from the specified string.
    
    抛出:
    
    SCSClientException - If the hash cannot be computed.
  - hash
```
protected byte[] hash(InputStream input)
               throws SCSClientException
```
    抛出:
    
    SCSClientException
  - hash
```
public byte[] hash(byte[] data)
            throws SCSClientException
```
    Hashes the binary data using the SHA-256 algorithm.
    
    参数:
    
    data - The binary data to hash.
    
    返回:
    
    The hashed bytes from the specified data.
    
    抛出:
    
    SCSClientException - If the hash cannot be computed.
  - getCanonicalizedQueryString
```
protected String getCanonicalizedQueryString(Map<String,String> parameters)
```
    Examines the specified query string parameters and returns a canonicalized form.
    The canonicalized query string is formed by first sorting all the query string parameters, then URI encoding both the key and value and then joining them, in order, separating key value pairs with an '&'.
    
    参数:
    
    parameters - The query string parameters to be canonicalized.
    
    返回:
    
    A canonicalized form for the specified query string parameters.
  - getCanonicalizedQueryString
```
protected String getCanonicalizedQueryString(Request<?> request)
```
  - getBinaryRequestPayload
```
protected byte[] getBinaryRequestPayload(Request<?> request)
```
    Returns the request's payload as binary data.
    
    参数:
    
    request - The request
    
    返回:
    
    The data from the request's payload, as binary data.
  - getRequestPayload
```
protected String getRequestPayload(Request<?> request)
```
    Returns the request's payload as a String.
    
    参数:
    
    request - The request
    
    返回:
    
    The data from the request's payload, as a string.
  - getRequestPayloadWithoutQueryParams
```
protected String getRequestPayloadWithoutQueryParams(Request<?> request)
```
    Returns the request's payload contents as a String, without processing any query string params (i.e. no form encoding for query params).
    
    参数:
    
    request - The request
    
    返回:
    
    the request's payload contents as a String, not including any form encoding of query string params.
  - getBinaryRequestPayloadWithoutQueryParams
```
protected byte[] getBinaryRequestPayloadWithoutQueryParams(Request<?> request)
```
    Returns the request's payload contents as binary data, without processing any query string params (i.e. no form encoding for query params).
    
    参数:
    
    request - The request
    
    返回:
    
    The request's payload contents as binary data, not including any form encoding of query string params.
  - getBinaryRequestPayloadStream
```
protected InputStream getBinaryRequestPayloadStream(Request<?> request)
```
  - getBinaryRequestPayloadStreamWithoutQueryParams
```
protected InputStream getBinaryRequestPayloadStreamWithoutQueryParams(Request<?> request)
```
  - getCanonicalizedResourcePath
```
protected String getCanonicalizedResourcePath(String resourcePath)
```
  - getCanonicalizedResourcePath
```
protected String getCanonicalizedResourcePath(String resourcePath,
                                              boolean urlEncode)
```
  - getCanonicalizedEndpoint
```
protected String getCanonicalizedEndpoint(URI endpoint)
```
  - sanitizeCredentials
```
protected AWSCredentials sanitizeCredentials(AWSCredentials credentials)
```
    Loads the individual access key ID and secret key from the specified credentials, ensuring that access to the credentials is synchronized on the credentials object itself, and trimming any extra whitespace from the credentials.
    Returns either a BasicSessionCredentials or a BasicAWSCredentials object, depending on the input type.
    
    参数:
    
    credentials -
    
    返回:
    
    A new credentials object with the sanitized credentials.
  - newString
```
protected String newString(byte[] bytes)
```
    Safely converts a UTF-8 encoded byte array into a String.
    
    参数:
    
    bytes - UTF-8 encoded binary character data.
    
    返回:
    
    The converted String object.
  - getSignatureDate
```
protected Date getSignatureDate(int timeOffset)
```
  - getTimeOffset
```
protected int getTimeOffset(Request<?> request)
```
  - addSessionCredentials
```
protected abstract void addSessionCredentials(Request<?> request,
                                              AWSSessionCredentials credentials)
```
    Adds session credentials to the request given.
    
    参数:
    
    request - The request to add session credentials information to
    
    credentials - The session credentials to add to the request

类 AbstractAWSSigner

字段概要

构造器概要

方法概要

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

从接口继承的方法 com.sinacloud.scs.auth.Signer

字段详细资料

DEFAULT_ENCODING

构造器详细资料

AbstractAWSSigner

方法详细资料

signAndBase64Encode

signAndBase64Encode

sign

sign

hash

hash

hash

getCanonicalizedQueryString

getCanonicalizedQueryString

getBinaryRequestPayload

getRequestPayload

getRequestPayloadWithoutQueryParams

getBinaryRequestPayloadWithoutQueryParams

getBinaryRequestPayloadStream

getBinaryRequestPayloadStreamWithoutQueryParams

getCanonicalizedResourcePath

getCanonicalizedResourcePath

getCanonicalizedEndpoint

sanitizeCredentials

newString

getSignatureDate

getTimeOffset

addSessionCredentials