系统之间接口V3.0_第1页
系统之间接口V3.0_第2页
系统之间接口V3.0_第3页
系统之间接口V3.0_第4页
系统之间接口V3.0_第5页
已阅读5页，还剩10页未读， 继续免费阅读

下载本文档

版权说明：本文档由用户提供并上传，收益归属内容提供方，若内容存在侵权，请进行举报或认领

文档简介

1、系统接口定义2011-05-05目 录1.概述32.结构图443.总体说明43.1.接口列表43.2.接口访问方式54.接口描述54.1.添加日志54.1.1.接口说明54.1.2.接口定义54.1.3.响应报文64.2.用户登陆64.2.1.接口说明64.2.2.接口定义64.2.3.响应报文64.3.导出数据74.3.1.接口说明74.3.2.接口定义74.3.3.响应报文74.4.获取数据库与表的配置信息84.4.1.接口说明84.4.2.接口定义84.4.3.响应报文84.5.获取部门名称94.5.1.接口说明94.5.2.接口定义94.5.3.响应报文94.6.获取数据字典中导出文件

2、路径94.6.1.接口说明94.6.2.接口定义104.6.3.响应报文104.7.获取数据字典中导出数据最大值，一页多少数据配置104.7.1.接口说明104.7.2.接口定义104.7.3.响应报文114.8.获取表信息（数据库类型、数据库名称、表名称、可以同步的数据总数）114.8.1.接口说明114.8.2.接口定义114.8.3.响应报文124.9.获取用户基本信息124.9.1.接口说明124.9.2.接口定义124.9.3.响应报文124.10.导入数据134.10.1.接口说明134.10.2.接口定义134.10.3.响应报文144.11.修改同步标志144.11.1.接口说

3、明144.11.2.接口定义144.11.3.响应报文151. 概述本文档用于描述数据交互系统中，平台部分与应用系统之间的接口。平台部分作为基础服务端，应用部分作为接口客户端。平台提供部门、用户、权限、日志、字典等基本功能，应用部分进行调用。调用协议主要为基于Xml的Web Service协议。2. 结构图 WebServiceClientDB1DB2DB3DB 配置信息3. 总体说明3.1. 接口列表基础服务平台接口列表序号接口名称接口说明备注1addOperLog记录日记2checkLogin用户登陆接口3generateXml导出数据4getDbTableName获取数据库与表的配置信息

4、5getDeptName获取部门名称6getFileRoot获取文件的默认导出路径7getPageSizeAndMaxCount获取数据字典中导出数据最大值，一页多少数据配置8getRowData获取表信息（数据库类型，数据库名称，表名称，需要同步的数据总数）9getUser获取用户信息10loadToDBFromXmlFile导入数据11updateSynchflag修改数据同步标志3.2. 接口访问方式一、 WSDL路径：http:/localhost:8080/dataService/services/DataexchangeService?wsdl4. 接口描述4.1. 添加日志4.1

5、.1. 接口说明向数据库添加操作日志4.1.2. 接口定义Ø 接口：void addOperLog(String userCode,String password,OpeLog opeLog)Ø 功能：添加用户日志参数： userCode：用户代码 userPassword：用户密码opeLog：操作日志对象Ø 返回：无返回值4.1.3. 响应报文无4.2. 用户登陆4.2.1. 接口说明应用系统登陆时，可以在自己的界面中调用此接口进行登陆认证。4.2.2. 接口定义Ø 接口：String checkLogin(String userCode,Strin

6、g userPassword)Ø 功能：用户登陆Ø 参数： userCode：用户代码 userPassword：用户密码Ø 返回：见响应报文 4.2.3. 响应报文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_CODE>返回代码，true表示成功，false表示失败</ RET_CODE ><RET_MSG>返回消息</RET_MSG></HEAD><BODY&

7、gt;</BODY></MSG>4.3. 导出数据4.3.1. 接口说明导出数据，返回ExportReturn对象，对象包含String success;（成功信息）String fail（异常信息），String primarKey（主键类型）;PkValue pkValue（主键值）;byte dataXML（导出的二进制数据）;4.3.2. 接口定义Ø 接口：ExportReturn generateXml(String userCode, String password, String srcDbName, String srcTbName, int

8、pageSize, int page, String pass)Ø 功能：导出二进制数据，日志等信息。Ø 参数：userCode:用户账号password:用户密码srcDbName:数据库名称srcTbName：表名pageSize：一次导多少条数据page：当前页pass：加密密码Ø 返回：ExportReturn 对象(Success：成功信息、Fail：异常信息、primarKey：主键列名、pkValue：导出数据的主键值、dataXML：导出的二进制数据）4.3.3. 响应报文<?xml version="1.0" encod

9、ing="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><DATA_XML>二进制数据</ DATA_XML > <PK_VALUE >主键值</ PK_VALUE><FAIL>异常信息</ FAIL >< PRIMARKEY >主键列名</ PRIMARKEY >< SUCCESS >成功信息</

10、SUCCESS></REC></BODY></MSG>4.4. 获取数据库与表的配置信息4.4.1. 接口说明获取数据库与表的配置信息，形成树型结构图,返回一维数组。格式如下：String0:数据库名称，表名，表名，表名;String1:数据库名称，表名，表名4.4.2. 接口定义Ø 接口：String getDbTableName(String userCode, String password)Ø 功能：获取数据库与表配置信息Ø 参数：userCode：用户代码Password：用户密码Ø 返回：String

11、:4.4.3. 响应报文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC>< ns:return >数据库名称，表名，表名。</ ns:return > < ns:return >数据库名称，表名。</ ns:return > </REC></BODY><

12、/MSG>4.5. 获取部门名称4.5.1. 接口说明通过部门ID获取部门名称4.5.2. 接口定义Ø 接口：String getDeptName(String userCode, String password, String deptId)Ø 功能：获取用户基本信息Ø 参数：userCode：用户代码Password：用户名称deptId：部门IDØ 返回：String 部门名称4.5.3. 响应报文<?xml version="1.0" encoding="UTF-8"?><MSG&g

13、t;<HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC>< ns:return >部门名称</ ns:return > </REC></BODY></MSG>4.6. 获取数据字典中导出文件路径4.6.1. 接口说明应用系统调用此接口获取数据字典中导出文件的路径。4.6.2. 接口定义Ø 接口：getFileRoot(String userCode, String password,String userKey)

14、Ø 功能：获取导出时，文件夹的默认路径Ø 参数：userCode:用户编码Password：用户密码userKey用户编码+”IN” or “OUT”Ø 返回：文件路径4.6.3. 响应报文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><ns:return>默认导出文件路径</ns

15、:return > </REC></BODY></MSG>4.7. 获取数据字典中导出数据最大值，一页多少数据配置4.7.1. 接口说明获取数据字典中导出数据最大值，一页多少数据配置4.7.2. 接口定义Ø 接口：int getPageSizeAndMaxCount(String userCode, String password)Ø 功能：业务日志记录Ø 参数：userCode:用户编码Password：用户密码Ø 返回：int0:tableSize(一次最多可导多少条数据),int1:pageSize（一个文

16、件存储多少条数据）4.7.3. 响应报文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><TABLESIZE>一次最多可导多少条数据</TABLESIZE > < PAGESIZE>一个文件存储多少条数据</PAGESIZE ></REC></BODY><

17、;/MSG>4.8. 获取表信息（数据库类型、数据库名称、表名称、可以同步的数据总数）4.8.1. 接口说明查询导出数据表的，数据类型，数据库名称，表名称，可以同步的数据总数4.8.2. 接口定义Ø 接口：String getRowData(String userCode, String password,String dbName, String tblName)Ø 功能：业务日志记录Ø 参数：userCode:用户编码Password：用户密码dbName：数据库名称tblName：表名称Ø 返回：String0:dbType(数据库类型),S

18、tring1:dbName（数据库名称）,String2:tableName表名，String3 synCount:可同步的数据总数4.8.3. 响应报文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><ns:return>数据库类型</ns:return> <ns:return>数据库名称&l

19、t;/ns:return>< ns:return>表名称</ ns:return ><ns:return>可同步的数据总条数</ns:return></REC></BODY></MSG>4.9. 获取用户基本信息4.9.1. 接口说明根据用户代码获取用户基本信息4.9.2. 接口定义Ø 接口：getUser(String userCode, String password)Ø 功能：获取用户基本信息Ø 参数：userCode：用户代码Password：密码Ø 返回：

20、见响应报文4.9.3. 响应报文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><USER_CODE>用户代码</USER_CODE > <USER_NAME >用户名称</ USER_NAME ><DEPT_ID >所属部门序号</ DEPT_ID><

21、/REC></BODY></MSG>4.10. 导入数据4.10.1. 接口说明通过IO字节流获取导入文件（加过密）的二进制byte导入数据，webService 服务器端会先解密byte，再以xml的方式解析byte，最后导入数据库。4.10.2. 接口定义Ø 接口：String loadToDBFromXmlFile(String userCode, String password,String dbName, String tableName, byte data, String pass,String fileName)Ø 功能：通过I

22、mportParam里的DataHandler导入数据Ø 参数：userCode：用户代码Password：用户密码dbName：数据库名称tableName：表名data：二进制数据pass：加密密码fileName：文件名称Ø 返回：String0:true(成功) or false (失败)Stirng1:成功信息String2:异常信息4.10.3. 响应报文<?xml version="1.0" encoding="UTF-8"?><MSG><HEAD><RET_MSG>返回消息</RET_MSG></HEAD><BODY><REC><USER_CODE>用户代码</USER_CODE > <USER_NAME >用户名称</ USER_NAME ><

人人文库> 全部分类> 教育资料 > 备课教案

温馨提示

  • 1. 本站所有资源如无特殊说明，都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等，如果需要附件，请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸，网页内容里面会有图纸预览，若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间，仅对用户上传内容的表现方式做保护处理，对用户上传分享的文档内容本身不做任何修改或编辑，并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容，请与我们联系，我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

最新文档

评论

0/150

提交评论