com.alibaba.csb.ws.sdk.AxisCallWrapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ws-client Show documentation
There is a newer version: 1.1.5.11
package com.alibaba.csb.ws.sdk;

import javax.xml.soap.MimeHeaders;
import java.util.Map;

/**
 *  * Axis客户端Call的wrapper类， 用以在发送soap请求前，将CSB所要求的签名信息存放到http header里， 具体用法：
 * 
 *   //设置服务调用的安全信息
 *   String apiName = "PING";  //要调用的服务名称
 *   String apiVersion = "vcsb.ws";  //要调用的服务版本
 *   String ak = "xxxx"; //订购服务的accessKey
 *   String sk = "xxxx"; //订购服务的secrectKey
 *   
 *   Service service = new Service();
 *   // 首先，构造封装Call对象
 *   Call call = AxisCallWrapper.createCallWrapper(service, ak, sk, apiName, apiVersion); 
 *   
 *   // 然后，使用封装Call对象进行方法调用
 *   call.setTargetEndpointAddress("http://localhost:9081/PING/vcsb.ws/ws2ws");
 *   call.setOperationName(new QName("http://hc.wsprocess.csb.alibaba.com/", "ping"));
 *   
 *   call.addParameter("arg0", // 设置要传递的参数
 *   	org.apache.axis.encoding.XMLType.XSD_STRING, javax.xml.rpc.ParameterMode.IN);
 *   
 *   Object[] args = { "wiseking" };
 *  
 *   Object ret = call.invoke(args);
 *   System.out.println("ret=" + ret);
 * 
 * 注意，如果要正确使用这个类，需要在你的编译和运行环境中包含axis依赖， 如：
 * 
 * <dependency>
 *		<groupId>axis</groupId>
 *		<artifactId>axis</artifactId>
 *		<version>1.4</version>
 *	</dependency>
 *
 *	<dependency>
 *		<groupId>org.apache.axis</groupId>
 *		<artifactId>axis-jaxrpc</artifactId>
 *		<version>1.4</version>
 *	</dependency>
 * 
 * 
 * @author liaotian.wq 2017年7月19日
 *
 */
public class AxisCallWrapper extends org.apache.axis.client.Call {
	private WSParams params;

	/**
	 *
	 * @param service
	 * @param ak
	 * @param sk
	 * @param api
	 * @param apiVersion
	 * @return
	 *
	 * @deprecated use WSParams as the requet parameter
	 */
	public static org.apache.axis.client.Call createCallWrapper(org.apache.axis.client.Service service, String ak,
			String sk, String api, String apiVersion) {
		AxisCallWrapper call = new AxisCallWrapper(service);
		call.params = WSParams.create();
		call.params.api(api);
		call.params.version(apiVersion);
		call.params.accessKey(ak);
		call.params.secretKey(sk);
		call.params.timestamp(true);
		call.params.fingerPrinter("axisCaller");

		return call;
	}

	public static org.apache.axis.client.Call createCallWrapper(org.apache.axis.client.Service service, WSParams params) {
		AxisCallWrapper call = new AxisCallWrapper(service);
		call.params = params;
		return call;
	}

	private AxisCallWrapper(org.apache.axis.client.Service service) {
		super(service);
	}

	@Override
	public void setRequestMessage(org.apache.axis.Message msg) {
		super.setRequestMessage(msg);

		//每次调用时，将安全相关的信息放到soap请求的http header里
		MimeHeaders mimeHeaders = msg.getMimeHeaders();
		addHttpHeaders(mimeHeaders, params);
	}

	private boolean addHttpHeaders(MimeHeaders mimeHeaders, WSParams params) {
		if (mimeHeaders != null) {
			Map headers =WSClientSDK.generateSignHeaders(params);
			for(Map.Entry kv:headers.entrySet()) {
				mimeHeaders.addHeader(kv.getKey(), kv.getValue());
			}
			return true;
		}

		return false;
	}
}