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
HashMap<String,String>	productEndpointMap
String	productEndpointRegional
String	productNetwork
String	productSuffix
protected String	strToSign

Fields inherited from class com.aliyuncs.http.HttpMessage

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

Constructor Summary

Constructors

Constructor and Description
AcsRequest(String product)

Method Summary

Modifier and Type	Method and Description
void	appendUserAgent(String key, String value)
abstract String	composeUrl(String endpoint, Map<String,String> queries)
static String	concatQueryString(Map<String,String> parameters)
FormatType	getAcceptFormat() Deprecated. : Use getSysAcceptFormat instead of this
String	getActionName() Deprecated. : Use getSysActionName instead of this
Map<String,String>	getBodyParameters() Deprecated. : Use getSysBodyParameters instead of this
Map<String,String>	getDomainParameters() Deprecated. : Use getSysDomainParameters instead of this
String	getEndpointType() Deprecated. : Use getSysEndpointType instead of this
String	getLocationProduct() Deprecated. : Use getSysLocationProduct instead of this
String	getProduct() Deprecated. : Use getSysProduct instead of this
ProductDomain	getProductDomain() Deprecated. : Use getSysProductDomain instead of this
ProtocolType	getProtocol() Deprecated. : Use getSysProtocol instead of this
Map<String,String>	getQueryParameters() Deprecated. : Use getSysQueryParameters instead of this
String	getRegionId() Deprecated. : Use getSysRegionId instead of this
abstract Class<T>	getResponseClass()
String	getSecurityToken() Deprecated. : Use getSysSecurityToken instead of this
FormatType	getSysAcceptFormat()
String	getSysActionName()
Map<String,String>	getSysBodyParameters()
Map<String,String>	getSysDomainParameters()
String	getSysEndpointType()
String	getSysLocationProduct()
String	getSysProduct()
ProductDomain	getSysProductDomain()
ProtocolType	getSysProtocol()
Map<String,String>	getSysQueryParameters()
String	getSysRegionId()
String	getSysSecurityToken()
SignatureAlgorithm	getSysSignatureAlgorithm()
SignatureVersion	getSysSignatureVersion()
protected String	getSysSignedHeaders(Map<String,String> headers)
String	getSysStrToSign()
UserAgentConfig	getSysUserAgentConfig()
String	getSysVersion()
String	getVersion() Deprecated. : Use getSysVersion instead of this
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	resolveSignatureComposer()
void	setAcceptFormat(FormatType acceptFormat) Deprecated. : Use setSysAcceptFormat instead of this
void	setActionName(String actionName) Deprecated. : Use setSysActionName instead of this
void	setEndpoint(String endpoint) Deprecated. : Use setSysEndpoint instead of this
void	setEndpointType(String endpointType) Deprecated. : Use setSysEndpointType instead of this
void	setLocationProduct(String locationProduct) Deprecated. : Use setSysLocationProduct instead of this
protected void	setParameter(Map<String,String> map, String name, Object value)
void	setProductDomain(ProductDomain productDomain) Deprecated. : Use setSysProductDomain instead of this
void	setProtocol(ProtocolType protocol) Deprecated. : Use setSysProtocol instead of this
void	setRegionId(String regionId) Deprecated. : Use setSysRegionId instead of this
void	setSecurityToken(String securityToken) Deprecated. : Use setSysSecurityToken instead of this
void	setSysAcceptFormat(FormatType acceptFormat)
void	setSysActionName(String actionName)
void	setSysEndpoint(String endpoint)
void	setSysEndpointType(String endpointType)
void	setSysLocationProduct(String locationProduct)
void	setSysProductDomain(ProductDomain productDomain)
void	setSysProtocol(ProtocolType protocol)
void	setSysRegionId(String regionId)
void	setSysSecurityToken(String securityToken)
void	setSysSignatureAlgorithm(SignatureAlgorithm signatureAlgorithm)
void	setSysSignatureVersion(SignatureVersion signatureVersion)
void	setSysVersion(String version)
void	setVersion(String version) Deprecated. : Use setSysVersion instead of this
abstract HttpRequest	signRequest(Signer signer, AlibabaCloudCredentials credentials, FormatType format, ProductDomain domain)

Methods inherited from class com.aliyuncs.http.HttpMessage

getConnectTimeout, getContentTypeValue, getEncoding, getHeaders, getHeaderValue, getHttpContent, getHttpContentString, getHttpContentType, getKeyManagers, getMethod, getReadTimeout, getSysConnectTimeout, getSysEncoding, getSysHeaders, getSysMethod, getSysReadTimeout, getSysRetryPolicy, getSysUrl, getUrl, getX509TrustManagers, isIgnoreSSLCerts, putHeaderParameter, setConnectTimeout, setEncoding, setHttpContent, setHttpContentType, setIgnoreSSLCerts, setKeyManagers, setMethod, setReadTimeout, setSysConnectTimeout, setSysEncoding, setSysMethod, setSysReadTimeout, setSysRetryPolicy, setSysUrl, setUrl, setX509TrustManagers

Methods inherited from class java.lang.Object

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

Field Detail

composer

protected ISignatureComposer composer

strToSign

protected String strToSign

productEndpointMap

public HashMap<String,String> productEndpointMap

productEndpointRegional

public String productEndpointRegional

productNetwork

public String productNetwork

productSuffix

public String productSuffix

Constructor Detail

AcsRequest

public AcsRequest(String product)

Method Detail

resolveSignatureComposer

public void resolveSignatureComposer()

getSysSignedHeaders

protected String getSysSignedHeaders(Map<String,String> headers)

concatQueryString

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

Throws:

UnsupportedEncodingException

setEndpoint

@Deprecated
public void setEndpoint(String endpoint)

Deprecated. : Use setSysEndpoint instead of this

getVersion

@Deprecated
public String getVersion()

Deprecated. : Use getSysVersion instead of this

setVersion

@Deprecated
public void setVersion(String version)

Deprecated. : Use setSysVersion instead of this

getProduct

@Deprecated
public String getProduct()

Deprecated. : Use getSysProduct instead of this

getActionName

@Deprecated
public String getActionName()

Deprecated. : Use getSysActionName instead of this

setActionName

@Deprecated
public void setActionName(String actionName)

Deprecated. : Use setSysActionName instead of this

getRegionId

@Deprecated
public String getRegionId()

Deprecated. : Use getSysRegionId instead of this

setRegionId

@Deprecated
public void setRegionId(String regionId)

Deprecated. : Use setSysRegionId instead of this

getSecurityToken

@Deprecated
public String getSecurityToken()

Deprecated. : Use getSysSecurityToken instead of this

setSecurityToken

@Deprecated
public void setSecurityToken(String securityToken)

Deprecated. : Use setSysSecurityToken instead of this

getAcceptFormat

@Deprecated
public FormatType getAcceptFormat()

Deprecated. : Use getSysAcceptFormat instead of this

setAcceptFormat

@Deprecated
public void setAcceptFormat(FormatType acceptFormat)

Deprecated. : Use setSysAcceptFormat instead of this

getProtocol

@Deprecated
public ProtocolType getProtocol()

Deprecated. : Use getSysProtocol instead of this

setProtocol

@Deprecated
public void setProtocol(ProtocolType protocol)

Deprecated. : Use setSysProtocol instead of this

getQueryParameters

@Deprecated
public Map<String,String> getQueryParameters()

Deprecated. : Use getSysQueryParameters instead of this

getSysQueryParameters

public Map<String,String> getSysQueryParameters()

putQueryParameter

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

putQueryParameter

protected void putQueryParameter(String name,
                                 String value)

getDomainParameters

@Deprecated
public Map<String,String> getDomainParameters()

Deprecated. : Use getSysDomainParameters instead of this

getSysDomainParameters

public Map<String,String> getSysDomainParameters()

putDomainParameter

protected void putDomainParameter(String name,
                                  Object value)

getBodyParameters

@Deprecated
public Map<String,String> getBodyParameters()

Deprecated. : Use getSysBodyParameters instead of this

getSysBodyParameters

public Map<String,String> getSysBodyParameters()

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)

getLocationProduct

@Deprecated
public String getLocationProduct()

Deprecated. : Use getSysLocationProduct instead of this

setLocationProduct

@Deprecated
public void setLocationProduct(String locationProduct)

Deprecated. : Use setSysLocationProduct instead of this

getEndpointType

@Deprecated
public String getEndpointType()

Deprecated. : Use getSysEndpointType instead of this

setEndpointType

@Deprecated
public void setEndpointType(String endpointType)

Deprecated. : Use setSysEndpointType instead of this

getProductDomain

@Deprecated
public ProductDomain getProductDomain()

Deprecated. : Use getSysProductDomain instead of this

setProductDomain

@Deprecated
public void setProductDomain(ProductDomain productDomain)

Deprecated. : Use setSysProductDomain instead of this

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()

getSysVersion

public String getSysVersion()

setSysVersion

public void setSysVersion(String version)

getSysProduct

public String getSysProduct()

getSysActionName

public String getSysActionName()

setSysActionName

public void setSysActionName(String actionName)

getSysRegionId

public String getSysRegionId()

setSysRegionId

public void setSysRegionId(String regionId)

getSysSecurityToken

public String getSysSecurityToken()

setSysSecurityToken

public void setSysSecurityToken(String securityToken)

getSysAcceptFormat

public FormatType getSysAcceptFormat()

setSysAcceptFormat

public void setSysAcceptFormat(FormatType acceptFormat)

getSysProtocol

public ProtocolType getSysProtocol()

setSysProtocol

public void setSysProtocol(ProtocolType protocol)

setSysEndpoint

public void setSysEndpoint(String endpoint)

getSysLocationProduct

public String getSysLocationProduct()

setSysLocationProduct

public void setSysLocationProduct(String locationProduct)

getSysEndpointType

public String getSysEndpointType()

setSysEndpointType

public void setSysEndpointType(String endpointType)

getSysProductDomain

public ProductDomain getSysProductDomain()

setSysProductDomain

public void setSysProductDomain(ProductDomain productDomain)

getSysUserAgentConfig

public UserAgentConfig getSysUserAgentConfig()

appendUserAgent

public void appendUserAgent(String key,
                            String value)

getSysSignatureVersion

public SignatureVersion getSysSignatureVersion()

setSysSignatureVersion

public void setSysSignatureVersion(SignatureVersion signatureVersion)

getSysSignatureAlgorithm

public SignatureAlgorithm getSysSignatureAlgorithm()

setSysSignatureAlgorithm

public void setSysSignatureAlgorithm(SignatureAlgorithm signatureAlgorithm)

getSysStrToSign

public String getSysStrToSign()

Overrides:

getSysStrToSign in class HttpMessage