MAS2.0内部插件开发手册

MAS2.0内部插件开发手册

前 言

本手册是深圳嘉讯有限公司MAS系统内部插件的开发指导手册。

本手册包括以下几方面内容：文档概述、开发环境、集成环境、如何集成、类关系图、接口说明、如何打包、如何安装。

本手册由深圳嘉讯有限公司产品与解决方案部MAS组提出并归口。 本手册由手册归口部门负责解释。 本手册起草单位：深圳嘉讯有限公司 本手册主要起草人：吴江

MAS2.0内部插件开发手册

1. 范 围

本手册用于指导嘉讯MAS2.0平台上的内部应用插件开发，嘉讯公司以及嘉讯MAS2.0平台的使用产商共同使用。

其阅读对象为需要采用中国移动代理服务器MAS2.0完成内部应用插件开发的技术人员。

2. 引用文件

下列文件中的条款通过本手册的引用而成为本手册所遵循的条款。

3. 文档概述

本手册详细描述了中国移动代理服务器MAS2.0内部应用插件开发原理及过程。用于指导利用中国移动代理服务器MAS2.0所提供的内部插件管理接口实现客户的二次开发需要，满足客户基于短信、彩信、WAP、USSD、LBS等移动信息化的应用开发。

4. 开发环境

JDK：java5 数据库：mysql5.0

MAS2.0内部插件开发手册

应用服务器：Tomcat5.5

类库：嘉讯有限公司提供的插件开发库 ① Struts：1.2.7⑥

5. 集成环境

MAS2.0运行 MAS管理平台环境 ② 符合规范的插件包 ⑦

6. 如何集成

1、 编写内部插件，确保格式正确，并正确打包 ⑦ 2、 MAS2.0启动

3、 在MAS2.0管理平台上新建一个通信类型为‘Inner’的插件，输入相对应的通信能力要求，并确保能

通过鉴权 ③

4、 然后安装，完成安装后重启MAS2.0平台 ④

5、 重启MAS2.0管理平台后到‘配置中心/插件管理’中启动该插件 6、 如果该插件是有Web界面的话，请到‘应用中心’中即可找到使用入口

MAS2.0内部插件开发手册

7. 类关系图

图1

图2

MAS2.0内部插件开发手册

图1反映的是与内部插件相关的类图集合，而这些关联类，会在插件集成到基座后，由基座的

IOC容器自动装载，作为一个内部插件必须实现LocalPlugin接口，不同的内部插件可根据需要进行扩展。

图2反映的是LocalPlugin的接口内容，不过为了方便开发我们提供了AbstractLocalPlugin抽象

类，该类部分实现了LocalPlugin的接口内容，一般的情况下可直接继承它。

8. 接口说明 8.1 内部插件接口

接口名称：LocalPlugin⑤

8.2系统用户接口

接口名称：ISysUserService⑤

8.3通讯录接口

接口名称：IContactService⑤

8.4号码文件服务接口

接口名称：IMobileFileService⑤

8.5彩信模板服务接口

接口名称：IMmsResService⑤

8.6常用短消息服务接口

接口名称：ICommMsgService⑤

8.7 MO维护服务接口

接口名称：IMOCommondService⑤

MAS2.0内部插件开发手册

8.8短信过滤，黑白名单服务接口

接口名称：IMsgFilterService⑤

8.9数据库连接接口服务接口

接口名称：IDBConnService⑤

8.10通信接口

短信下行接口：SmsAgentService⑤

短信上行接口：com.jasson.mas.uca.sms.service.ISmsHandler⑤ 彩信下行接口：com.jasson.mas.uca.mms.service.IMmsAgentService⑤ 彩信上行接口：com.jasson.mas.uca.mms.service.IMmsHandler⑤ LBS下行接口：com.jasson.mas.uca.lbs.service.ILbsAgentService⑤ LBS上行接口：com.jasson.mas.uca.lbs.service.ILbsHandler⑤

USSD下行接口：http://www.77cn.com.cnsd.service.IUssdAgentService⑤ USSD上行接口：http://www.77cn.com.cnsd.service.IUssdHandler⑤

8.11数据接口

应用插件DAO继承PlugDao即可访问数据库

8.12其他接口

Js脚本：请参照$mas/js/pub.js和$mas/js/datapicker.js 翻页控件类：com.jasson.mas.web.sys.PageControl

选择用户：$mas /common/selectsysuser/selectSysUser.jsp：可以直接调用页面来选择系统用户 选择通讯录用户：$mas /common/ selectaddressuser/selectAddressUser.jsp：选择通讯录用户

9. 如何打包

‘内部插件’的目录结构如下：

MAS2.0内部插件开发手册

3

应用插件最终开发完后以zip压缩文件发布。

zip压缩文件由两个目录（ap与web-inf）和一个描述文件(applicationlugIn.xml。)组成。 应用插件描述文件格式如下：（文件名为applicationPlugIn.xml）

‘ap’目录存放应用插件的前台页面（如jsp文件、html文件以及图片文件等）WEB-INF存放后台

classes文件以及配置文件信息。

MAS2.0内部插件开发手册

1 2 2.1 2.1.1 2.1.2 2.1.3 AP BaseInfo Show Show Show BaseInfo Show ShortCut Icon Desktop 1

插件基本信 息

1 1 1 1

0 0 Int 0 0 Int 0 1 示 应用的首页 String 0 0 Int 100 面 10 插件的排序 要 String 修 改 ap/mms 大

的靠后 1:是 String 1 捷图标 100 快捷图标 是否桌面显 1:显示 images/icon/yhgl.gif 0:否 是否显示快 0:不显示

2.1.4 2.1.5

Show Show

Forward Position

1 1

2.2

BaseInfo

Web

1

web.xml 才有 此项

2.2.1 2.2.2 2.2.3 2.2.4 2.2.5

Web Web

fileter filter-mappin

+ +

0 0

g Web Web ing Web listener + 0 0 2.3 BaseInfo Struts 1 采用 struts 框 架(才有此 项) 0 2.3.1 Struts CfgFile 1 String 英文逗号隔 开) xml 配置文件名 称(多个请用 /WEB-INF/struts-cfg. servlet servlet-mapp + + 0 0

MAS2.0内部插件开发手册

9.1采用struts框架开发的页面

增加配置文件struts-cfg-XXX.xml

示例：

<? xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE struts-config PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 1.1//EN"

"http://www.77cn.com.cn/struts/dtds/struts-config_1_1.dtd"> <struts-config> <form-beans>

<!--补充该应用插件的form </form-beans>

<action-mappings>

<!--补充该应用插件的Action </action-mappings>

MAS2.0内部插件开发手册

<!—多语言支持->

<message-resources key="???" parameter="???"/> </struts-config>

在插件配置文件applicationPlugIn.xml中，更改其中的相关配置信息

示例： <Struts>

<CfgFile>/WEB-INF/struts-cfg-???.xml</CfgFile> </Struts>

多语言中的Jsp写法如下：

示例：

<%@ include file="/common/globalHearder.jsp"%> <%@ page language="java" pageEncoding="UTF-8"%> Bean Message：<bean:message bundle="???" key="xxxx"/> Hello,Thsi my MyPlugin!!!

9.2采用hibernate操作数据库

在插件配置文件applicationPlugIn.xml中，更改其中的相关配置信息

示例：

<Hibernate>

<mapping resource="cn/mas/appplugin/mms/dao/MmsInfo.hbm.xml" /> <mapping resource="cn/mas/appplugin/mms/dao/MmsSmilInfo.hbm.xml" /> <mapping resource="cn/mas/appplugin/mms/dao/MmsRecv.hbm.xml" /> <mapping resource="cn/mas/appplugin/mms/dao/MmsRpt.hbm.xml" /> <mapping resource="cn/mas/appplugin/mms/dao/MmsFile.hbm.xml" />

</Hibernate>

10. 如何安装

安装请参考《Mas2.0简明安装手册（整合版本）》

11. 标注解释

① 开发库详见附件[3]，该类库规定了插件开发所必要的第三方包和Mas2.0基座的支撑包。对于内部插件而言不能使用不在附件[3]中提供的类库

② 测试是可通过配置相关设置忽略这部分，参考《Mas2.0简明安装手册（整合版本）》 ③ 其鉴权能力查看请参考《插件鉴权能力查看》

④ 详细的安装和新增插件的方法请参考《MAS2.0用户使用手册》 ⑤ 接口说明请参考附件[2]

MAS2.0内部插件开发手册

⑥ 如果开发的内部插件没有Web界面的话则可不需要。另：其支撑包也包括在附件[3]中 ⑦ 如何打包‘内部插件’请参考本手册章节9，同时附件[1]提供了打包Demo

12. 附 件

本文来源：https://www.bwwdw.com/article/mnmi.html