宽乐通信接口中间件部署说明书样本.doc

广东电信有限公司研究院
宽乐通信Web Service接口中间件
WebUCComapionV1.12布置阐明书

江洪
-6-7

本文描述WebUCCompanionV1.12版本在各种应用服务器布置流程。此外，对管理维护操作也作了一定阐明

目录
第1章 文档阐明 3
第2章 Uniportal服务器布置 3
2.1 安装uniportal平台 3
安装过程 3
2.2 安装WebUCComapionV1.12 6
安装过程 6
2.3 文献配备 7
第3章 Tomcat服务器布置 7
第4章 维护管理 8

第1章 文档阐明
宽乐通信Web Service接口中间件WebUCComapion是基于java开发布置于java应用服务器上中间件，它既可以集成于第三方应用中，也可以独立布置。本文档就宽乐通信Web Service接口中间件在已支持各种应用服务器布置作完整阐明。文档将按照不同服务器分别进行描述。
本文档是针对WebUCComapionV1.12版本做布置阐明。如果并非这个版本，请参照本文其她版本。

第2章 Uniportal服务器布置
WebUCComapionV1.12使用Uniportal服务器是华为提供uniportalv100r001d330版本平台。该平台包括jboss3.2.6版本将j2ee应用服务器，其Web Service模块使用。
由于第三方服务器应用普通不会使用uniportal平台作为宿主平台，因此布置在Uniportal平台上WebUCComapionV1.12是作为独立应用而布置。
WebUCComapionV1.12uniportal布置版本包括文献阐明如下：
文献名称
解释
uniportal_plt_ins.jar
uniportalv100r001d330平台运营期文献
serviceonly_ins.jar
WebUCComapionV1.12版本文献
jboss-net.sar
J模块
log4j.properties

日记配备文献
WebUCConfig.xml
WebUCComapionV1.12应用配备文献
布置流程为：安装uniportal平台――à安装WebUCComapionV1.12――à文献配备。
详细流程如下：
2.1 安装uniportal平台
在安装uniportal平台之前需要确认服务器上安装了JDK1.4.2版本，并且对的设立了环境变量。
环境变量设立完毕后，就可以安装Portal了。获取uniportal_plt_ins.jar包，在命令行方式下执行java –jar uniportal_plt_ins.jar安装Portal，
安装过程
D:\>java jar uniportal_plt_ins.jar

Please select the language you wish to use during installation:
1.default(zh)
2.en

################欢迎使用华为技术有限公司智能网Uni-Portal################
## 当前时间是：-10-19 17:47:04 ##
## 当前版本是：V100R001D300 ##
## 通用安装向导将引导您安装Uni-Portal ##
## 安装过程中需要向您询问某些参数. ##
## 提问时中括号内是推荐缺省值,直接键入回车键,表达使用推荐值. ##
####################################################################

选取安装类型,1--覆盖安装 2--升级安装:[1]
请输入安装目录[C:\Documents and Settings\z30607]d:/portal

提示:d:\portal目录不存在
输入Y-创立;输入N-重新选取安装目录;E-退出安装:[Y]

端标语设立

请输入HTTP端标语:[8080]

WebService端口:[8083]
JNDI端口:[1099]
RMI invoker端口:[4444]
JMX端口:[7888]
JMXHTML管理端口:[8889]
UIL2ServerILService 端口:[8092]
RMI Naming Service 端口:[1098]
pooled invoker 端口:[4445]
MC Https 端口:[7443]

与否安装安全证书？
输入Y-安装;输入N-不安装:[Y]

请输入HTTPS端标语:[8443]

请输入生成安全证书参数:
请输入您站点域名:[unknown]localhost
请输入您组织单位名称:[unknown]huawei
请输入您组织名称:[unknown]com
请输入您所在都市和区域名称:[ShenZhen]NanJing
请输入您所在洲或者省份名称:[GuangDong]JiangSu
请输入该单位两字国家代码:[CN]
请输入别名:[unknown]portal
请输入KeyStore密码:[uniportal-keystore-password]
请输入证书有效时间:[100]

请输入MCHTTP端标语:[7080]

与否安装为后台服务？
输入Y-安装;输入N-不安装:[N]

##########################安装参数设立如下：############################
## 安装途径:d:\portal ##
## 端标语设立： ##
## WebService端口:8083 ##
## JNDI端口:1099 ##
## RMI invoker端口:4444 ##
## OILServerILService端口:8090 ##
## UILServerILService端口:8091 ##
## JMX端口:7888 ##
## JMXHTML管理端口:8889 ##
## UIL2ServerILService 端口:8092 ##
## RMI Naming Service 端口:1098 ##
## pooled invoker 端口:4445 ##
## MC Https 端口:7443 ##
## HTTP端标语:8080 ##
## HTTPS端标语:8443 ##
## MCHTTP端标语:7080 ##
##################################

输入Y-使用上述参数进行安装;输入N-修改参数设立;E-退出安装:[Y]

开始安装...
.....................................................
Deploying servcies...Done!
Checking plugin...Done!

安装完毕!
在安装成功之后，顾客可以看到如下目录构造：
目录和文献
功能
bin
执行启动文献目录
conf
Portal系统配备文献目录
definition
Portal平台有关配备文献目录
deploy
布置文献目录
jboss
Jboss工作目录
lib
系统库文献目录
logs
日记目录
service
业务布置目录
work
系统工作目录

2.2 安装WebUCComapionV1.12
在安装完毕uniportal平台后，就可以开始业务安装。
在命令行方式下执行java –jar serviceonly_ins.jar即可安装业务。
安装过程
F:\>java -jar serviceonly_ins.jar
Prepare files needed while install,wait please...

...

Please select the language you wish to use during installation:
1.default(zh)
2.en

################欢迎使用华为技术有限公司智能网Uni-Portal#################
## 当前时间是:-10-27 15:12:56 ##
## 当前版本是:V100R001D311 ##
## 通用安装向导将引导您安装Uni-Portal ##
## 安装过程中需要向您询问某些参数. ##
## 提问时中括号内是推荐缺省值,直接键入回车键,表达使用推荐值. ##
####################################################################

选取安装类型,1--覆盖安装 2升级安装:[1]
在这里需要选取覆盖安装
输入安装目的目录:[C:\Documents and Settings\z31483]f:\ddd
目录不存在或你没有写权限！重新输入?Y--是，others-退出:[Y]

输入安装目的目录:[C:\Documents and Settings\z31483]f:\1_temp
目录不是一种uniportal目录!重新输入?Y--是，others-退出:[Y]

输入安装目的目录:[C:\Documents and Settings\z31483]f:\ttt
在这里选取安装目的目录是uniportal平台安装目录

###安装参数设立如下:#############################
## 安装途径:f:\ttt ##
####################################################################
输入Y-使用上述参数进行安装;输入N-修改参数设立;E-退出安装:[Y]

..............
Deploying servcies...Done!
Checking plugin...Done!

安装完毕!
在业务安装完毕后，需要运营业务布置命令，完毕业务布置，业务布置命令是
uniportal deploy（Window操作系统）
或
./uniportal.sh deploy（UNIX、Linux操作系统）。

2.3 文献配备
在业务布置完毕后来，就要进行业务文献配备。重要是安装模块，布置log4j.properties和WebUCConfig.xml两个配备文献。
安装模块就是将jboss-net.sar目录文献拷贝到%uniportal%/deploy目录下即可。
安装模块后，在将业务配备文献log4j.properties和WebUCConfig.xml拷贝到%uniportal%/jboss/bin目录下即可

通过以上操作，就完毕WebUCCompanionV1.12在uniportal平台上安装。安装完毕后，打开IE浏览器，键入http://ip:8080/testWS，应当可以看到本业务主页面，背面设立操作请参照第4章论述。

第3章 Tomcat服务器布置
在Tomcat上布置WebUCCompanion业务比较灵活，可以容易地实现与第三方平台应用整合。由于Tomcat服务器自身并不支持Web Service，因此WebUCCompanionTomcat版本包括了Axis1.4类库。
WebUCComapionV1.12Tomcat版本包括如下目录/文献：
目录/文献
阐明
WEB-INF\
存储WebUCComapnion业务运营所需要库文献
WEB-INF\web.xml
WebUCCompanion应用Tomcat服务器启动配备文献
WEB-INF\lib\
Axis平台文献和WebUCCompanion业务运营期文献
WEB-INF\jwsClasses\
WebUCCompanionWeb Service服务器端实现class文献
WebUCCompanion\
存储WebUCCompanion应用web文献、Web Service服务器端jws文献、配备文献存储目录和日记存储目录
布置比较简朴，只需要将上述文献拷贝到Tomcat服务器上相应目录下即可。下面详细简介文献拷贝布置过程。
一方面是拷贝本应用WEB-INF文献夹。如果本应用是作为独立应用布置，先在webapps目录下创立一种目录，这里以目录名称为testWS1为例进行论述，目录建好后，进入，将WEB-INF目录下所有内容拷贝进去。如果本应用作为第三方应用集成，那么将本应用WEB-INF目录下除web.xml文献以外其她文献拷贝到第三方应用WEB-INF目录。然后对本应用web.xml文献，将名为WebUCCompanionServletservlet标签所有内容拷贝到第三方应用web.xml文献中。
布置完本应用WEB-INF文献夹后，假设该WEB-INF文献夹被布置到名称为testWS1目录下面，接着，就需要修改web.xml。在web.xml中，找到WebUCCompanionServletservlet标签定义。WebUCCompanionServletservlet定义中有3个init-param标签参数定义，将第一种参数log4j config file path中webapps和WebUCCompanion中间目录名称改为testWS1。同理，修改第二个参数webUCCompanion config file pathwebapps和WebUCCompanion中间目录名称改成testWS1。第三个参数web application root dirWebUCCompanion前面目录名称testWS1。
接下来，将WebUCCompanion目录拷贝到testWS1目录下，进入到WebUCCompanion\conf下，打开log4j.properties文献，将log4j.appender.A2.File字段值中webapps和WebUCCompanion中间目录名称修改成testWS1。
至此，就完毕了WebUCCompanionV1.12在Tomcat服务器上布置。打开Web浏览器，输入http://ip:8080/%应用布置根目录名称%/WebUCCompanion，就会显示本应用主页界面。

第4章 Weblogic Server8.1平台布置
本版本发布文献包括两个，一种为testWebUCWAR.rar，另一种是WebUCCompanion.jar。testWebUCWAR.rar是本版本运营文献，WebUCCompanion.jar文献是用于提供第三方应用进行本中间件接口开发编译库文献。
本文档针对testWebUCWAR.rar文献解说其布置于Weblogic Server8.1上，并与第三方WEB应用整合过程。
4.1 布置过程
将发布文献testWebUCWAR.rar解压，得到解压文献目录构造如下：
目录/文献
阐明
WEB-INF\
存储WebUCComapnion业务运营所需要库文献与有关配备文献
WEB-INF\ classes
本中间件运营期class文献
WEB-INF\web.xml
本中间件WebUCCompanion应用需要配备web容器配备文献，重要用于服务器启动时初始化WebUCCompanion应用
WEB-INF\ weblogic.xml
Weblogic平台配备文献
WEB-INF\ web-services.xml
本中间件WebUCCompanion应用web service服务器端组件布置描述符文献
WEB-INF\lib\
本中间件WebUCCompanion应用运营期依赖库文献
WebUCCompanion\
存储WebUCCompanion应用web文献（jsp）、配备文献存储目录和日记存储目录

下面，需要分步将这些解压文献拷贝（上传）到wls服务器上第三方web应用有关目录中，并修改某些配备文献配备信息，详细环节如下：
1、 拷贝（上传）classes文献
解压目录WEB-INF\ classes中文献是本中间件重要运营期class文献。只需要将这个解压目录下面所有文献拷贝（上传）到wls服务器第三方web应用WAR目录中相应WEB-INF\ classes目录下即可。
2、 布置web-services.xml文献
解压文献WEB-INF\ web-services.xml是本中间件web service服务器端组件布置描述符文献，这个文献布置是将其拷贝（上传）到第三方web应用WAR目录WEB-INF目录下即可。
注意，如果第三方web应用WEB-INF目录下已有web-services.xml文献，那么不能直接将其覆盖，而是应当将解压文献WEB-INF\ web-services.xml中标签下内容拷贝到第三方web应用web-services.xml文献中。
3、 修改第三方web应用weblogic.xml文献
解压文献WEB-INF\weblogic.xml文献是weblogic服务器参数描述文献。布置时，将这个文献用文献编辑器打开，将其中标签下内容粘贴到服务器上原有weblogic.xml文献中就可以了。
注意，如果服务器上原有weblogic.xml文献中如果已经存在标签且其中内容与解压文献weblogic.xml中一致就不需要进行粘贴操作。
4、 修改第三方web应用web.xml文献
解压文献WEB-INF\web.xml是本中间件依赖文献，用于设定中间件初始化入口serlvet地址。但是，第三方web应用自身WAR目录中必定已经存在web.xml文献，因此不能直接将解压文献拷贝（上传）到第三方应用目录中覆盖其原有同名文献，只可以将解压文献web.xml文献中内容拷贝到第三方web应用web.xml文献中。
使用文献编辑工具分别打开解压web.xml文献和第三方web应用中web.xml文献。将解压web.xml文献中和标签下所有内容粘贴到第三方web应用中web.xml文献文献中。
粘贴操作完毕后，对第三方web应用web.xml文献进行修改。对于添加上来标签下${WEB_APPLICATION_WAR_DIR}修改成第三方web应用WAR目录绝对途径，将${WEB_APPLICATION_CONTEXT_ROOT}修改成第三方web应用application.xml中指定值。
至此，第三方应用web.xml文献修改完毕，保存到服务器即可。
5、 拷贝（上传）lib依赖库文献
将解压文献WEB-INF\lib\中所有文献到拷贝（上传）到第三方web应用WAR目录下WEB-INF\lib\目录即可。如果服务器上第三方应用WEB-INF目录下没有lib目录，可以新建这个目录再进行文献拷贝（上传）。
6、 拷贝（上传）WebUCCompanion目录

这一步是要将解压目录WebUCCompanion整个拷贝（上传）到第三方web应用WAR目录下即可。
拷贝（上传）完毕后进入到服务器上WebUCCompanion/conf目录中，用文献编辑器打开log4j.properties文献，将其中${WEB_APPLICATION_WAR_DIR}修改成第三方web应用WAR目录绝对途径。
7、 设定业务参数值
在上传到服务器解压目录WebUCCompanion\conf目录下，有一种ServiceParameters.properties文献。该文献是指定中间件使用几种必要web service组件URL地址，在平台重启之前，需要设定这些URL值。
其中，将其中代有${}符号参数按规定修改成地址值即可。修改完毕后在服务器上保存这个文献即可。
8、 重启Domain，检查布置有效性
以上所有环节都完毕后来，就可以重启第三方web应用所在Domain。
Domian启动完毕后，打开浏览器，输入URL地址：http://${服务器IP}/${Domain端口}/${ context-root }/WebUCCompanion，如果上述布置操作对的话，可以看到如下页面：

接着检查本中间件Web Service服务器端组件布置对的性。在浏览器上键入URL地址：http:// ${服务器IP}/${Domain端口}/${ context-root }/EventCallBackService，对的应当可以看到如下页面：

第5章 维护管理
5.1 基本配备文献信息
WebUCCompanion应用维护管理操作重要涉及配备文献修改，维护Web页面操作等。
配备文献管理
WebUCCompanion应用重要有3个配备文献，它们是：
Web.xml：应用服务器应用初始化文献。
Log4j.properties：日记配备文献
WebUCConfig.xml：应用配备文献

Web.xml
在本应用中，web.xml配备重要是为了使应用服务器在启动时候初始化本应用，其内容是在Web.xml中添加一种servlet标签，格式为：

WebUCCompanionServlet
WebUCCompanion Servlet

com.jiangh.webuc.servicemanager.ThirdPartyServerApp

log4j config file path
./../webapps/testWS1/WebUCCompanion/conf/log4j.properties

webUCCompanion config file pathe>
./../webapps/testWS1/WebUCCompanion/conf/WebUCConfig.xml

web application root dir
testWS1/WebUCCompanion

14

在这个配备文献中，重要需要关注参数是3个init-paramparam-value值。第一种init-param是log4j.properties配备文献位置。这个位置是指其对于应用服务器bin目录相对途径值。例如，如果本业务是布置Tomcat服务器上webapps/testWS1目录下话，那么这个参数值就设为./../webapps/testWS1/WebUCCompanion/conf/log4j.properties。
第二个init-param是业务配备文献WebUCConfig.xml对于Tomcat服务器bin目录相对途径值。例如，如果本业务是布置在Tomcat服务器上webapps/testWS1目录下话，那么这个参数值就设为./../webapps/testWS1/WebUCCompanion/conf/WebUCConfig.xml。
第三个init-param参数值是本应用自带Web应用目录。这个值是相对于WebUCCompanion应用根目录途径。例如，如果本业务是布置在testWS1目录下话，那么这个参数值就设为testWS1/WebUCCompanion。
Log4j.properties
这个文献是应用日记配备文献，内容比较简朴。重要关注是其中日记文献途径参数log4j.appender.A2.File，这个参数值应设立为对于应用服务器bin目录相对途径，例如：
log4j.appender.A2.File=./../webapps/testWS1/WebUCCompanion/logs/webuc.log
上述例子是当WebUCCompanion应用布置在Tomcat服务器webapps/testWS1目录下日记文献途径。
WebUCConfig.xml
这个文献是WebUCCompanion应用自身业务级配备文献，需要配备参数都是应用中需要读取重要参数。在应用布置时候，不需要修改该文献配备信息。关于该文献中配备参数信息，请直接参照该文本自身所提供配备阐明。
5.2 中间件管理
本中间件提供了基本管理页面用于减少第三方web应用开发量。第三方web应用在调用本中间件其她顾客接口进行服务时，必要进行中间件管理设立。
中间件管理分为两步，第一步是设立URL信息，页面如下：

上述各地址配备解释如下：
本地消息回调服务地址是设立本中间件相对于宽乐通信业务web service组件URL地址。中间件布置在不同平台上，这个URL格式也有所不同，详细为：
Uniportal/JBOSS平台：
http://${ip}:${port}/jboss-net/services/EventCallBackService
Tomcat平台：
http://${ip}:${port}/${context-root}/WebUCCompanion/EventCallBackService.jws
Weblogic8.1平台：
http://${ip}:${port}/${context-root}/WebUCCompanion/EventCallBackService?WSDL

其中，${ip}指集成本中间件第三方web应用服务器地址，${port}指服务器端口。注意，这里http://${ip}:${port}/ 必要是外网Internet可以访问得到IP及端口。如果web服务器有公网域名，可以用域名代替ip+port形式。
Tomcat平台和Weblogic8.1平台URL格式中${context-root}字段是指集成本中间件第三方web应用配备web应用根途径。

背面四个参数都是宽乐通信业务web service组件地址，这几种地址格式都是固定，不用修改。需要修改地方就是URL中IP地址和PORT。将默认IP地址和端口修改成为现网宽乐通信平台IP和PORT或者域名就可以了。

上面URL都设立好后来，点击“拟定”按钮就设立完毕。

URL地址设立完毕后来，就需要进行宽乐通信注册操作。宽乐通信注册操作页面如下：

这个页面比较简朴，只需要填入管理员宽乐账号及其密码，按拟定即可。这里管理员宽乐账号是用于在现网宽乐平台注册第三方应用，其性质就类似与短信SP代号之类。这个宽乐管理员账号需要各本地网向第三方web应用厂商分派。
点击了“拟定”按钮后来。中间件就执行向宽乐通信注册本第应用，如果执行成功，其返回成功代码是0，如下图所示：

注意，在后来每次第三方web应用服务器重启之后都要进行本操作。
在注册操作完毕后来，第三方web应用就可以通过顾客接口向顾客提供服务了。关于顾客接口使用，请参照文档《宽乐通信Web Service接口中间件接口阐明书V1.25_070608》。

5.3 Weblogic Server8.1布置问题解决
本中间件在Weblogic Server8.1服务器上布置时候也许会浮现某些与其她服务器布置时不同问题，对这些问题阐明如下。
1、 与Axis冲突问题
本中间件使用Axis1.4作为web service客户端实现解决方案，而如果Weblogic Server8.1平台自身安装在UNIX/Linux服务器上，则有也许发生weblogic服务器与Axis冲突问题。详细问题发生在当中间件做为web server客户端调用Axis1.4版本库文献类时，服务器抛出异常信息，如下：
Root cause of ServletException.
javax.xml.parsers.FactoryConfigurationError：Factory class is the wrong type
at javax.xml.parsers.DocumentBuilderFactory.newInstance(DocumentBuilderFactory.java:115)
at org.apache.axis.utils.XMLUtils.getDOMFactory(XMLUtils.java:221)
at org.apache.axis.utils.XMLUtils.(XMLUtils.java:83)
at org.apache.axis.configuration.FileProvider.configureEngine(FileProvider.java:179)
at org.apache.axis.AxisEngine.init(AxisEngine.java:172)
at org.apache.axis.AxisEngine.(AxisEngine.java:156)
at org.apache.axis.client.AxisClient.(AxisClient.java:52)
at org.apache.axis.client.Service.getAxisClient(Service.java:104)
at org.apache.axis.client.Service.(Service.java:113)
at com.jiangh.webuc.ucservice.client.RegisterServiceClient1.getRandNum(RegisterServiceClient1.java:107)
at com.jiangh.webuc.servicemanager.RegisterManager.RegToRemoteService(RegisterManager.java:50)
at com.jiangh.webuc.webclient.RegisterWebClient.registerToService(RegisterWebClient.java:36)
at jsp_servlet._webuccompanion._manager.__gogetcallbackaddr._jspService(__gogetcallbackaddr.java:174)