All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.aliyuncs.AcsRequest Maven / Gradle / Ivy

There is a newer version: 1.8.10
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.aliyuncs;

import java.io.UnsupportedEncodingException;
import java.security.InvalidKeyException;
import java.security.NoSuchAlgorithmException;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;

import com.aliyuncs.auth.AcsURLEncoder;
import com.aliyuncs.auth.Credential;
import com.aliyuncs.auth.ISignatureComposer;
import com.aliyuncs.auth.ISigner;
import com.aliyuncs.http.FormatType;
import com.aliyuncs.http.HttpRequest;
import com.aliyuncs.http.ProtocolType;
import com.aliyuncs.regions.ProductDomain;

public abstract class AcsRequest extends HttpRequest {
	
	private String version = null;
	private String product = null;
	private String actionName = null;
	private String regionId = null;
	private String securityToken = null;
	private FormatType acceptFormat = null;
	protected ISignatureComposer composer = null;
	private ProtocolType protocol = ProtocolType.HTTP;
    private final Map queryParameters  = new HashMap();
    private final Map domainParameters = new HashMap();

	private String locationProduct;
	private String endpointType;
	
	public AcsRequest(String product) {
		super(null);
		this.headers.put("x-sdk-client", "Java/2.0.0");
		this.product = product;
	}
	
	public AcsRequest(String product, String version) {
		super(null);
		this.product = product;
		this.setVersion(version);
	}

	public String getLocationProduct() {
		return locationProduct;
	}

	public void setLocationProduct(String locationProduct) {
		this.locationProduct = locationProduct;
        putQueryParameter("ServiceCode", locationProduct);
	}

	public String getEndpointType() {
		return endpointType;
	}

	public void setEndpointType(String endpointType) {
		this.endpointType = endpointType;
        putQueryParameter("Type", endpointType);
	}

	public String getActionName() {
		return actionName;
	}
	
	public void setActionName(String actionName) {
		this.actionName = actionName;
	}

	public String getProduct() {
		return product;
	}

	public ProtocolType getProtocol() {
		return protocol;
	}

	public void setProtocol(ProtocolType protocol) {
		this.protocol = protocol;
	}
	
	public Map getQueryParameters() {
		return Collections.unmodifiableMap(queryParameters);
	}
	
	public  void putQueryParameter(String name, K value) {
		setParameter(this.queryParameters, name, value);
	}
	
	protected void putQueryParameter(String name, String value) {
		setParameter(this.queryParameters, name, value);
	}
	
	public Map getDomainParameters() {
		return Collections.unmodifiableMap(domainParameters);
	}

	protected void putDomainParameter(String name, Object value) {
		setParameter(this.domainParameters, name, value);
	}
	
	protected void putDomainParameter(String name, String value) {
		setParameter(this.domainParameters, name, value);
	}
	
	protected  void setParameter(Map map, String name, K value) {
		if (null == map || null == name || null == value){
			return;
		}
		map.put(name,String.valueOf(value));
	}

	public String getVersion() {
		return version;
	}

	public void setVersion(String version) {
		this.version = version;
	}

	public FormatType getAcceptFormat() {
		return acceptFormat;
	}

	public void setAcceptFormat(FormatType acceptFormat) {
		this.acceptFormat = acceptFormat;
		this.putHeaderParameter("Accept", 
				FormatType.mapFormatToAccept(acceptFormat));
	}
	
	public String getRegionId() {
		return regionId;
	}

	public void setRegionId(String regionId) {
		this.regionId = regionId;
	}

	public String getSecurityToken() {
		return securityToken;
	}

	public void setSecurityToken(String securityToken) {
		this.securityToken = securityToken;
        putQueryParameter("SecurityToken", securityToken);
	}
	
	public static String concatQueryString(Map parameters) 
			throws UnsupportedEncodingException {
		if (null == parameters)
			return null;
		
		StringBuilder urlBuilder = new StringBuilder("");
		for(Entry entry : parameters.entrySet()){
            String key = entry.getKey();
            String val = entry.getValue();
			urlBuilder.append(AcsURLEncoder.encode(key));
			if (val != null){
            	urlBuilder.append("=").append(AcsURLEncoder.encode(val));
			}
			urlBuilder.append("&");
        }
		
		int strIndex = urlBuilder.length();
		if (parameters.size() > 0)
			urlBuilder.deleteCharAt(strIndex - 1);
		
		return urlBuilder.toString();
	}
	
	public abstract HttpRequest signRequest(ISigner signer, Credential credential, 
			FormatType format, ProductDomain domain) 
					throws InvalidKeyException, IllegalStateException, 
						UnsupportedEncodingException, NoSuchAlgorithmException;
	
	public abstract String composeUrl(String endpoint, Map queries) 
			throws UnsupportedEncodingException;
	
	public abstract Class getResponseClass();


}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy