README.md · liujiliang2008/dtcp

#dtcp

一、	概述
1.1	平台基本原理及使用流程
行业统一平台传输环境提供行业三级数据传输的各项功能，以标准化接口方式将行业性应用系统的非结构化数据接入行业统一平台传输环境，自动调用数据传输组件实现非结构化数据的上行和下行传输。根据使用者在数据量、传输频度、传输时效性等方面的不同要求，数据传输组件内置消息数据传输、可管理文件传输、同步传输三种模式。其中，消息数据传输模式适用于消息型数据或较小的文件（小于20Mb）；可管理文件传输模式适用于视频、图片等大数据文件；同步传输模式适用于时效性要求高或需要同步响应结果的业务数据（小于5Mb）。
接入申请:行业单位向国家烟草专卖局烟草经济信息中心提出应用系统接入申请，审批通过后为申请接入的应用系统分配身份识别码、源应用及目标应用编码和数据传输类型代码等。
接入实施:行业单位根据应用系统身份识别码及数据传输类型代码等相关参数，按照《烟草行业统一平台传输环境使用规范》开发发送与接收功能，完成数据传输。

二、	非结构化数据传输接口
2.1	开发准备
开发组提供了基于《烟草行业统一平台传输环境使用规范》的JAVA的一组接口实现，封装在icss-dtcp.jar传输工具包中，用以简化第三方应用系统接入传输平台，忽略与传输前置接口交互的细节，专注于具体业务逻辑处理上。
1.	开发前根据传输需要将附件中的传输工具包导入工程的classpath下
 
A.	传输基础包：包含icss-dtcp.jar的传输工具包和log4j等日志jar包
B.	HTTP：包含HTTP方式接入通道依赖的jar包及配置文件
C.	WEBSERVICE：包含JAX-WS实现的WEBSERVICE方式接入通道依赖的jar包及配置文件
2.	修改icss-dtcp.jar传输工具包的配置文件
将icss-dtcp.jar中的trans.properties修改内容为当前节点的传输平台的前置接口IP和端口。

2.2	HTTP发送
HTTP发送接口是数据传输组件向应用系统提供的基于HTTP协议的数据发送接口，应用系统调用此接口接入数据传输组件发送数据。接口规范及详细信息请参见《烟草行业统一平台传输环境使用规范》C1.1。

调用示例: 
第三方业务系统需要传输文件到目标节点可以直接引用由传输环境开发组提供的icss-dtcp.jar工具包，通过HttpSender.sendData(SendParam param)方法调用通道传输数据，方法参数在接入申请时传输平台为业务系统分配，在调用传输接口时请替换为真实的参数。
示例代码：
SendParam param = new SendParam.Builder().sourceAppCode("ICSS_ETL")
                    .destAppCode("ICSS_ETL")
                    .dataTransType("test001")
                    .destOrgCode("10000001")
                    .fileName("1.xml")
                    .fileInputstream(new File("E:/test/aaa.rar"))
                    .md5Str(MD5Util.getFileMD5String(new File("E:/test/aaa.rar")))
                    .key("key001")
                    .appTransId("1111")
                    .build();

int code = HttpSender.sendData(param);

接口参数说明：
sourceAppCode:源应用编码, 接入申请时传输平台为要接入的业务系统分配的编码。
destOrgCode: 目标组织编码 接收数据的单位对应的编码。
key:身份识别码, 接入申请成功后传输平台为业务系统生成的唯一识别码。
destAppCode:目标应用编码  接收数据的业务系统对应的编码。
dataTransType:数据类型, 接入申请时传输平台指定的可以传输的数据类型。
fileName:文件名,待传输的文件名称。
fileInputstream:文件流, 待传输的文件对应的文件流
md5Str:MD5值,待传输的文件对应的MD5值。
2.3	HTTP数据推送
传输组件接收到数据之后，实时调用推送接口将数据文件推送给应用系统。此接口由应用系统实现，具体业务逻辑由应用系统根据需要编制。接口规范及详细信息请参见《烟草行业统一平台传输环境使用规范》C2.1。
HTTP主动推送业务数据给业务系统。该接口只有接受数据的业务系统使用，在icss-dtcp.jar工具包中提供了J2EE的servlet实现。
注：使用springmvc,struts等框架的应用按照使用规范开发相应的接收接口即可。

调用示例:

1.	继承com.icss.trans.accept.httppush.TransServlet类，并覆写其中的doPush方法
在doPush方法中对推送过来的内容进行处理。
public class TestPushServlet extends TransServlet {
	private static final long serialVersionUID = 1L;
       
    /**
     * @see TransServlet#TransServlet()
     */
    public TestPushServlet() {
        super();
    }

@Override
    public void doPush(PushParam pushParam) {
        System.out.println("sourceAppCode -" + pushParam.getSourceAppCode());
        System.out.println("sourceOrgCode -" + pushParam.getSourceOrgCode());
        System.out.println("destAppCode -" + pushParam.getDestAppCode());
        System.out.println("dataTransType -" + pushParam.getDataTransType());
        System.out.println("fileName -" + pushParam.getFileName());
        System.out.println("inputStream -" + pushParam.getInputStream());
// 测试将inputStream写入到文件
        try {
            FileUtils.writeByteArrayToFile(new File("E:/test/temp/" + pushParam.getFileName()),
                    IOUtils.toByteArray(pushParam.getInputStream()));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

}

参数说明：
sourceOrgCode :发送数据的单位组织编码
sourceAppCode : 发送数据的业务系统编码
destAppCode :接受数据的业务系统编码
dataTransType :当前传输的数据类型
fileName :本次传输的传输唯一标示
inputStream:业务数据文件流
2.	在web.xml中配置servlet信息

<servlet>
    <description>传输前置接收处理servlet</description>
    <display-name>TransServlet</display-name>
    <servlet-name>TransServlet</servlet-name>
  <servlet-class>com.icss.trans.accept.httppush.TestPushServlet</servlet-class>
</servlet>
<servlet-mapping>
    <servlet-name>TransServlet</servlet-name>
<url-pattern>/transEntrance</url-pattern>
</servlet-mapping>

2.4	HTTP文件下载
应用系统通过HTTP方式调用文件列表下载接口和文件下载接口，数据传输组件根据请求参数以文件流方式将文件下载到请求方。接口规范及详细信息请参见《烟草行业统一平台传输环境使用规范》C2.3。

调用示例:
业务系统引用实例代码，传入对应的参数直接调用传输平台接口，此实现封装了列表获取和文件下载两个方法，有文件即下载到本地，在IAnalyzeFile的execute方法中对当前下载到的文件名和文件流进行处理，此方法每调用一次会把当前所有的文件依次下载并进行处理，分批传输的文件需要多次调用进行处理。
注：通过HTTP下载接口获取传输文件同一个数据类型不支持多线程并发下载！

AcceptParam acceptParam = new AcceptParam.Builder().appCode("ICSS_ETL")
                .dataTransType("test001")
                .key("key001")
                .build();
        try {
            HttpAccepter.accept(acceptParam, new IAnalyzeFile() {
                @Override
                public void execute(String fileName, InputStream fileInputStream) {
                    // 测试将文件流写入到本地
                    try {
                        FileUtils.writeByteArrayToFile(new File("E:/test/temp/" + fileName), 
                                IOUtils.toByteArray(fileInputStream));
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
            });
        } catch (Exception e) {
            e.printStackTrace();
        }

参数说明:
appCode:业务系统在传输平台中对应的编码。
dataTransType:待下载文件的数据类型。
key:传输平台为本业务系统分配的唯一身份识别码。

2.5	WEBSERVICE同步发送
同步发送接口只发送时效性要求高或需要同步响应结果的业务数据（小于5Mb），通过Web Service方式进行数据传输。接口规范及详细信息请参见《烟草行业统一平台传输环境使用规范》C1.3。
调用示例:
业务系统调用本接口可以直接引用由传输环境开发组提供的icss-dtcp.jar，通过HttpSender.sendData(SendParam param)方法调用通道传输数据，方法参数在接入申请时传输平台为业务系统分配，在调用传输接口时请替换为真实的参数。
示例代码：
WsSendParam sendParam = new WsSendParam.Builder().sourceAppCode("010001")
                    .destOrgCode("10000001")
                    .destAppCode("010001")
                    .dataTransType("010001111")
                    .fileContent("aaaa")
                    .fileName("a.tx010001t")
                    .key("54CA5C39A400D3F90448039A5D80E23E")
                    .build();
            String strRet = WsSender.sendData(sendParam);
接口参数说明：
sourceAppCode    源应用编码
key  身份识别码
destOrgCode 目标节点组织机构编码
destAppCode  目标应用编码
dataTransType  数据传输类型
filename  文件名称
fileContent  文件经Base64编码后的字符串

2.6	WEBSERVICE同步接收
同步数据接收接口是指数据传输组件通过Web Service方式将数据推送到接收方应用系统，并将接收方应用系统的接收结果值返回给调用方的方式。接口规范及详细信息请参见《烟草行业统一平台传输环境使用规范》C2.5。

调用示例:
1.	继承icss-dtcp.jar中的com.icssi.webservice.receive.ReceiveFile类(基于JAX-WS的实现)，复写doPush方法对推送过来的内容进行处理
@WebService
public class WsPush extends ReceiveFile {

@WebMethod(exclude=true)
    @Override
    public String doPush(WsPushParam parameterObject) {
        log.debug("WsPush:doPush:" + parameterObject.toString());

return returnMessage("1", "success");
    }

}

接口参数说明：
sourceOrgCode  源节点组织编码
sourceAppCode 源应用编码
destAppCode 目标应用编码
dataTransType 数据传输类型
sysTransId 传输唯一标识
filename 文件名称
fileContent 文件经Base64编码后的字符串
2.	拷贝wsdl文件夹到J2EE工程的webroot目录下
 
3.	在拷贝sun-jaxws.xml到WEB-INF下修改implementation内容为第一步WsPush的类路径
<?xml version="1.0" encoding="UTF-8"?>
<endpoints version="2.0" xmlns="http://java.sun.com/xml/ns/jax-ws/ri/runtime">

4.	修改web.xml增加如下内容
<listener>  
          <listener-class>com.sun.xml.ws.transport.http.servlet.WSServletContextListener</listener-class>
</listener>
<servlet>
		<servlet-name>ReceiveFile</servlet-name>
		<servlet-class>com.sun.xml.ws.transport.http.servlet.WSServlet</servlet-class>
	</servlet>
	<servlet-mapping>
		<servlet-name>ReceiveFile</servlet-name>
		<url-pattern>/ReceiveFileService</url-pattern>
	</servlet-mapping>

三、	源代码下载
icss-dtcp.jar源代码已托管在开源中国的Git服务器上，下载地址如下：
https://git.oschina.net/liujiliang2008/dtcp.git

liujiliang2008/dtcp

简介

发行版

贡献者

近期动态

liujiliang2008/dtcp .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

liujiliang2008/dtcp