MAS2.0内部插件开发手册.doc

前言本手册是深圳嘉讯有限公司MAS系统内部插件的开发指导手册。本手册包括以下几方面内容：文档概述、开发环境、集成环境、如何集成、类关系图、接口说明、如何打包、如何安装。本手册由深圳嘉讯有限公司产品与解决方案部MAS组提出并归口。本手册由手册归口部门负责解释。本手册起草单位：深圳嘉讯有限公司本手册主要起草人：吴江1. 范 围本手册用于指导嘉讯MAS2.0平台上的内部应用插件开发，嘉讯公司以及嘉讯MAS2.0平台的使用产商共同使用。其阅读对象为需要采用中国移动代理服务器MAS2.0完成内部应用插件开发的技术人员。2. 引用文件下列文件中的条款通过本手册的引用而成为本手册所遵循的条款。1中国移动移动代理服务器（MAS）系统接口规范2.0.0中国移动通信有限公司2MAS2.0用户使用手册深圳嘉讯有限公司3Mas2.0简明安装手册（整合版本）深圳嘉讯有限公司4中国移动代理服务器(MAS)应用插件开发手册V1.0深圳嘉讯有限公司5插件鉴权能力查看深圳嘉讯有限公司3. 文档概述本手册详细描述了中国移动代理服务器MAS2.0内部应用插件开发原理及过程。用于指导利用中国移动代理服务器MAS2.0所提供的内部插件管理接口实现客户的二次开发需要，满足客户基于短信、彩信、WAP、USSD、LBS等移动信息化的应用开发。4. 开发环境l JDK：java5l 数据库：mysql5.0l 应用服务器：Tomcat5.5l 类库：嘉讯有限公司提供的插件开发库 l Struts：1.2.75. 集成环境l MAS2.0运行l MAS管理平台环境 l 符合规范的插件包 6. 如何集成1、 编写内部插件，确保格式正确，并正确打包 2、 MAS2.0启动3、 在MAS2.0管理平台上新建一个通信类型为Inner的插件，输入相对应的通信能力要求，并确保能通过鉴权 4、 然后安装，完成安装后重启MAS2.0平台 5、 重启MAS2.0管理平台后到配置中心/插件管理中启动该插件6、 如果该插件是有Web界面的话，请到应用中心中即可找到使用入口7. 类关系图图1图2l 图1反映的是与内部插件相关的类图集合，而这些关联类，会在插件集成到基座后，由基座的IOC容器自动装载，作为一个内部插件必须实现LocalPlugin接口，不同的内部插件可根据需要进行扩展。l 图2反映的是LocalPlugin的接口内容，不过为了方便开发我们提供了AbstractLocalPlugin抽象类，该类部分实现了LocalPlugin的接口内容，一般的情况下可直接继承它。8. 接口说明8.1 内部插件接口l 接口名称：LocalPlugin8.2系统用户接口l 接口名称：ISysUserService8.3通讯录接口l 接口名称：IContactService8.4号码文件服务接口l 接口名称：IMobileFileService8.5彩信模板服务接口l 接口名称：IMmsResService8.6常用短消息服务接口l 接口名称：ICommMsgService8.7 MO维护服务接口l 接口名称：IMOCommondService8.8短信过滤，黑白名单服务接口l 接口名称：IMsgFilterService8.9数据库连接接口服务接口l 接口名称：IDBConnService8.10通信接口l 短信下行接口：SmsAgentServicel 短信上行接口：com.jasson.mas.uca.sms.service.ISmsHandlerl 彩信下行接口：com.jasson.mas.uca.mms.service.IMmsAgentServicel 彩信上行接口：com.jasson.mas.uca.mms.service.IMmsHandlerl LBS下行接口：com.jasson.mas.uca.lbs.service.ILbsAgentServicel LBS上行接口：com.jasson.mas.uca.lbs.service.ILbsHandlerl USSD下行接口：com.jasson.mas.uca.ussd.service.IUssdAgentServicel USSD上行接口：com.jasson.mas.uca.ussd.service.IUssdHandler8.11数据接口l 应用插件DAO继承PlugDao即可访问数据库8.12其他接口l Js脚本：请参照$mas/js/pub.js和$mas/js/datapicker.jsl 翻页控件类：com.jasson.mas.web.sys.PageControll 选择用户：$mas /common/selectsysuser/selectSysUser.jsp：可以直接调用页面来选择系统用户l 选择通讯录用户：$mas /common/ selectaddressuser/selectAddressUser.jsp：选择通讯录用户9. 如何打包内部插件的目录结构如下：图3l 应用插件最终开发完后以zip压缩文件发布。l zip压缩文件由两个目录（ap与web-inf）和一个描述文件(applicationlugIn.xml。)组成。l 应用插件描述文件格式如下：（文件名为applicationPlugIn.xml）l ap目录存放应用插件的前台页面（如jsp文件、html文件以及图片文件等）WEB-INF存放后台classes文件以及配置文件信息。序号父元素元素名称约束必填类型长度描述取值说明1 Ap11根元素2APBaseInfo11插件基本信息2.1BaseInfoShow102.1.1ShowShortCut10Int1是否显示快捷图标0：不显示1：显示2.1.2ShowIcon10String100快捷图标images/icon/yhgl.gif2.1.3ShowDesktop10Int1是否桌面显示0：否1：是2.1.4ShowForward10String100应用的首页面ap/mms2.1.5ShowPosition10Int10插件的排序大的靠后2.2BaseInfoWeb10String要修改web.xml才有此项2.2.1Webfileter+02.2.2Webfilter-mapping+02.2.3Webservlet+02.2.4Webservlet-mapping+02.2.5Weblistener+02.3BaseInfoStruts10采用struts框架（才有此项）2.3.1StrutsCfgFile10String配置文件名称（多个请用英文逗号隔开）/WEB-INF/struts-cfg.xml2.3.2StrutsActionClass10String插件用到的Action（多个请用英文逗号隔开）com.jasson.mas.appplug.smssend.action.SmsSendAction;com.jasson.mas.appplug.smssend.action.ViewRptAction2.4BaseInfoHibernate10采用hibernate(若用数据库)2.4.1Hibernatemapping+0配置信息2.4.1.1mappingresource10StringMapping的属性2.5BaseInfoLocalPluginImpl11String9.1采用struts框架开发的页面l 增加配置文件struts-cfg-XXX.xml示例： !-补充该应用插件的form !-补充该应用插件的Action l 在插件配置文件applicationPlugIn.xml中，更改其中的相关配置信息示例：/WEB-INF/struts-cfg-?.xmll 多语言中的Jsp写法如下：示例：Bean Message：Hello,Thsi my MyPlugin!9.2采用hibernate操作数据库l 在插件配置文件applicationPlugIn.xml中，更改其中的相关配置信息示例：10. 如何安装安装请参考Mas2.0简明安装手册（整合版本）11. 标注解释 开发库详见附件3，该类库规定了插件开发所必要的第三方包和Mas2.0基座的支撑包。对于内部插件而言不能使用不在附件3中提供的类库 测试是可通过配置相关设置忽略这部分，参考Mas2.0简明安装手册（整合版本） 其鉴权能力查看请参考插件鉴权能力查看 详细的安装和新增插件的方法请参考MAS2.0用户使用手册 接口说明请参考附件2 如