com.aliyuncs

Class AcsRequest<T extends AcsResponse>

java.lang.Object

com.aliyuncs.http.HttpMessage

com.aliyuncs.http.HttpRequest

com.aliyuncs.AcsRequest<T>

Direct Known Subclasses:

RoaAcsRequest, RpcAcsRequest

public abstract class AcsRequest<T extends AcsResponse>
extends HttpRequest

Field Summary

Fields

Modifier and Type	Field and Description
protected ISignatureComposer	composer

Fields inherited from class com.aliyuncs.http.HttpMessage

connectTimeout, CONTENT_LENGTH, CONTENT_MD5, CONTENT_TYPE, encoding, headers, httpContent, httpContentType, readTimeout

Constructor Summary

Constructors

Constructor and Description
AcsRequest(String product)

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	composeUrl(String endpoint, Map<String,String> queries)
static String	concatQueryString(Map<String,String> parameters)
FormatType	getAcceptFormat()
String	getActionName()
Map<String,String>	getBodyParameters()
Map<String,String>	getDomainParameters()
String	getEndpointType()
String	getLocationProduct()
String	getProduct()
ProductDomain	getProductDomain()
ProtocolType	getProtocol()
Map<String,String>	getQueryParameters()
String	getRegionId()
abstract Class<T>	getResponseClass()
String	getSecurityToken()
String	getVersion()
protected void	putBodyParameter(String name, Object value)
protected void	putDomainParameter(String name, Object value)
protected void	putDomainParameter(String name, String value)
<K> void	putQueryParameter(String name, K value)
protected void	putQueryParameter(String name, String value)
void	setAcceptFormat(FormatType acceptFormat)
void	setActionName(String actionName)
void	setEndpoint(String endpoint)
void	setEndpointType(String endpointType)
void	setLocationProduct(String locationProduct)
protected void	setParameter(Map<String,String> map, String name, Object value)
void	setProductDomain(ProductDomain productDomain)
void	setProtocol(ProtocolType protocol)
void	setRegionId(String regionId)
void	setSecurityToken(String securityToken)
void	setVersion(String version)
abstract HttpRequest	signRequest(Signer signer, AlibabaCloudCredentials credentials, FormatType format, ProductDomain domain)
HttpRequest	signRequest(Signer signer, Credential credential, FormatType format, ProductDomain domain)

Methods inherited from class com.aliyuncs.http.HttpMessage

getConnectTimeout, getContentTypeValue, getEncoding, getHeaders, getHeaderValue, getHttpContent, getHttpContentString, getHttpContentType, getMethod, getReadTimeout, getUrl, putHeaderParameter, setConnectTimeout, setEncoding, setHttpContent, setHttpContentType, setMethod, setReadTimeout, setUrl

Methods inherited from class java.lang.Object

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

Field Detail

composer

protected ISignatureComposer composer

Constructor Detail

AcsRequest

public AcsRequest(String product)

Method Detail

getLocationProduct

public String getLocationProduct()

setLocationProduct

public void setLocationProduct(String locationProduct)

getEndpointType

public String getEndpointType()

setEndpointType

public void setEndpointType(String endpointType)

getActionName

public String getActionName()

setActionName

public void setActionName(String actionName)

getProduct

public String getProduct()

getProtocol

public ProtocolType getProtocol()

setProtocol

public void setProtocol(ProtocolType protocol)

getQueryParameters

public Map<String,String> getQueryParameters()

putQueryParameter

public <K> void putQueryParameter(String name,
                         K value)

putQueryParameter

protected void putQueryParameter(String name,
                     String value)

getDomainParameters

public Map<String,String> getDomainParameters()

putDomainParameter

protected void putDomainParameter(String name,
                      Object value)

getBodyParameters

public Map<String,String> getBodyParameters()

putDomainParameter

protected void putDomainParameter(String name,
                      String value)

putBodyParameter

protected void putBodyParameter(String name,
                    Object value)

setParameter

protected void setParameter(Map<String,String> map,
                String name,
                Object value)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

getAcceptFormat

public FormatType getAcceptFormat()

setAcceptFormat

public void setAcceptFormat(FormatType acceptFormat)

getRegionId

public String getRegionId()

setRegionId

public void setRegionId(String regionId)

getSecurityToken

public String getSecurityToken()

setSecurityToken

public void setSecurityToken(String securityToken)

concatQueryString

public static String concatQueryString(Map<String,String> parameters)
                                throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

signRequest

public HttpRequest signRequest(Signer signer,
                      Credential credential,
                      FormatType format,
                      ProductDomain domain)
                        throws InvalidKeyException,
                               IllegalStateException,
                               UnsupportedEncodingException,
                               NoSuchAlgorithmException

Throws:

InvalidKeyException

IllegalStateException

UnsupportedEncodingException

NoSuchAlgorithmException

signRequest

public abstract HttpRequest signRequest(Signer signer,
                      AlibabaCloudCredentials credentials,
                      FormatType format,
                      ProductDomain domain)
                                 throws InvalidKeyException,
                                        IllegalStateException,
                                        UnsupportedEncodingException,
                                        NoSuchAlgorithmException

Throws:

InvalidKeyException

IllegalStateException

UnsupportedEncodingException

NoSuchAlgorithmException

composeUrl

public abstract String composeUrl(String endpoint,
                Map<String,String> queries)
                           throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getResponseClass

public abstract Class<T> getResponseClass()

getProductDomain

public ProductDomain getProductDomain()

setProductDomain

public void setProductDomain(ProductDomain productDomain)

setEndpoint

public void setEndpoint(String endpoint)