python通过webservice连接cmdbuild

cmdbuild的部署可以查看文章：http://20988902.blog.51cto.com/805922/1541289

部署成功后，访问http://192.168.1.1:8080/cmdbuild/services/soap/ 就能看到所有的webservice方法，证明server这边已经ready了

cmdbuild webservice官方说明文档：http://download.csdn.net/detail/siding159/7888309

下面是使用python开发webservice client的方法：

1.模块

python的webservice模块有很多，这里使用suds来进行连接

可以通过 easy_install suds来安装suds，十分方便

suds官方文档：https://fedorahosted.org/suds/wiki/Documentation

2.日志

suds是通过logging来实现日志的，所以配置logging后，就可以看到soap连接过程中的所有数据

import logging
logging.basicConfig(level=logging.DEBUG, filename='myapp.log')



logging.getLogger('suds.client').setLevel(logging.DEBUG)
# logging.getLogger('suds.transport').setLevel(logging.DEBUG)
# logging.getLogger('suds.xsd.schema').setLevel(logging.DEBUG)
# logging.getLogger('suds.wsdl').setLevel(logging.DEBUG)

suds提供了四种日志类型，可以根据需要来配置

3.连接

from suds.client import Client

url = 'http://192.168.8.190:8080/cmdbuild/services/soap/Private?wsdl'
client = Client(url)
print client
r=client.service.getCard('Cabinet',2336)

实例化Client后，可以print client来输出次webservice提供的接口，也就是wsdl文件的说明

通过r=client.service.getCard('Cabinet',2336)来调用webservice的getCard接口，并输入参数，print client的输出结果会有每个接口需要输入的参数说明

但是这样连接后，会报错：suds.WebFault: Server raised fault: 'An error was discovered processing the <wsse:Security> header'

因为cmdbuild需要wsse安全验证

4.wsse安全验证

为client实例设置wsse参数

from suds.wsse import *
from suds.client import Client

url = 'http://192.168.8.190:8080/cmdbuild/services/soap/Private?wsdl'
client = Client(url)

security = Security()
token = UsernameToken('admin', 'admin')
security.tokens.append(token)
client.set_options(wsse=security)
r=client.service.getCard('Cabinet',2336)

UsernameToken的参数是访问的账号和密码

继续运行程序后，可能会报错：suds.WebFault: Server raised fault: 'The security token could not be authenticated or authorized'‘
解决方法是，把cmdb的auth配置文件的force.ws.password.digest参数设置为false，并重启tomcat，auth.conf路径 tomcat/webapps/WEB-INI/conf/auth.conf

5.处理返回来的xml

继续运行，会报错：xml.sax._exceptions.SAXParseException: <unknown>:2:0: syntax error

原因是程序在解析返回的xml文件的时候出错了，通过日志，我们可以看到返回来的body是这样的

--uuid:b16cf808-f566-4bad-a92c-a7d303d33211
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml";
Content-Transfer-Encoding: binary
Content-ID: <root.message@cxf.apache.org>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns2:getCardResponse xmlns:ns2="http://soap.services.cmdbuild.org"><ns2:return><ns2:attributeList><ns2:name>User</ns2:name><ns2:value>admin</ns2:value></ns2:attributeList><ns2:attributeList><ns2:code>6084</ns2:code><ns2:name>CabinetStatus</ns2:name><ns2:value>终止</ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>RentalAmount</ns2:name><ns2:value>9000.00</ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>Description</ns2:name><ns2:value>机房 Room 1 D14</ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>BeginDate</ns2:name><ns2:value>12/08/14 18:03:17</ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>Contract</ns2:name><ns2:value></ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>Code</ns2:name><ns2:value>D14</ns2:value></ns2:attributeList><ns2:attributeList><ns2:code>168</ns2:code><ns2:name>Trusteeship</ns2:name><ns2:value>科技有限公司</ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>Notes</ns2:name><ns2:value></ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>Status</ns2:name><ns2:value>N</ns2:value></ns2:attributeList><ns2:attributeList><ns2:code>2325</ns2:code><ns2:name>Room</ns2:name><ns2:value>机房Room 1</ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>StartDate</ns2:name><ns2:value>23/09/10</ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>Id</ns2:name><ns2:value>2336</ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>Capacity</ns2:name><ns2:value>0</ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>NoUsed</ns2:name><ns2:value>0</ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>IdClass</ns2:name><ns2:value>42216</ns2:value></ns2:attributeList><ns2:attributeList><ns2:name>CibinetNUm</ns2:name><ns2:value>15</ns2:value></ns2:attributeList><ns2:beginDate>2014-08-12T18:03:17.839+08:00</ns2:beginDate><ns2:className>Cabinet</ns2:className><ns2:id>2336</ns2:id><ns2:metadata><ns2:key>runtime.privileges</ns2:key><ns2:value>write</ns2:value></ns2:metadata><ns2:user>admin</ns2:user></ns2:return></ns2:getCardResponse></soap:Body></soap:Envelope>
--uuid:b16cf808-f566-4bad-a92c-a7d303d33211--

发现在xml字符串之外还有很多没用的信息，所以我们需要在接受了返回之后，对返回结果进行处理（把它转化成标准的xml字符串）后，再进行xml的解析

import re
from suds.wsse import *
from suds.client import Client
from suds.plugin import MessagePlugin

url = 'http://192.168.8.190:8080/cmdbuild/services/soap/Private?wsdl'

class MyPlugin(MessagePlugin):
    def received(self, context):
        reply_new=re.findall("<soap:Envelope.+</soap:Envelope>",context.reply,re.DOTALL)[0]
        context.reply=reply_new

client = Client(url, plugins=[MyPlugin()])

security = Security()
token = UsernameToken('admin', 'admin')
security.tokens.append(token)
client.set_options(wsse=security)
r=client.service.getCard('Cabinet',2336)
print r

做法就是定义一个钩子（hook），在接收返回后，把需要的xml字符串抽取处理，由于xml中可能有换行符，所以加入了re.DOTALL

6.返回值

这样程序就能正常访问webservice了，返回值：

(card){
   attributeList[] = 
      (attribute){
         name = "User"
         value = "admin"
      },
      (attribute){
         code = "6084"
         name = "CabinetStatus"
         value = "合同"
      },
      (attribute){
         name = "RentalAmount"
         value = "9000.00"
      },
      (attribute){
         name = "Description"
         value = "机房Room 1 D14"
      },
      (attribute){
         name = "BeginDate"
         value = "12/08/14 18:03:17"
      },
      (attribute){
         name = "Contract"
         value = None
      },
      (attribute){
         name = "Code"
         value = "D14"
      },
      (attribute){
         code = "168"
         name = "Trusteeship"
         value = "科技有限公司"
      },
      (attribute){
         name = "Notes"
         value = None
      },
      (attribute){
         name = "Status"
         value = "N"
      },
      (attribute){
         code = "2325"
         name = "Room"
         value = "机房Room 1"
      },
      (attribute){
         name = "StartDate"
         value = "23/09/10"
      },
      (attribute){
         name = "Id"
         value = "2336"
      },
      (attribute){
         name = "Capacity"
         value = "0"
      },
      (attribute){
         name = "NoUsed"
         value = "0"
      },
      (attribute){
         name = "IdClass"
         value = "42216"
      },
      (attribute){
         name = "CibinetNUm"
         value = "15"
      },
   beginDate = 2014-08-12 18:03:17.000839
   className = "Cabinet"
   id = 2336
   metadata[] = 
      (metadata){
         key = "runtime.privileges"
         value = "write"
      },
   user = "admin"
 }

一看我就晕了，这是什么数据结构？type返回的类型是instance

不过我发现可以用列表的方式来访问它，例如输入r[0][1][2] 返回的是“合同”，不知道还有没有更好的返回结果解析方式

 后记：

url的说明：soap的url必须要加端口，例如8080，不然会返回 urllib2.URLError: <urlopen error [Errno 111] Connection refused>

CMDBuild更新后，请求接口的时候客户端报错：

xml.sax._exceptions.SAXParseException: <unknown>:1:0: syntax error

查看客户端的日志显示：

A security error was encountered when verifying the message

查看CMDBuild的日志，显示：

Caused by: org.apache.wss4j.common.ext.WSSecurityException: BSP:R4201: Any PASSWORD MUST specify a Type attribute

即任何密码都必须定义Type属性。

查了下相关的资料：http://www.ws-i.org/Profiles/BasicSecurityProfile-1.0-2005-01-20.html

发现需要在Password标签中设置属性：

Type='http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText'

再查看了suds的文档，发现可以通过设置Hook来修改suds发送到cmdbuild的请求数据：

class MyPlugin(MessagePlugin):
    def marshalled(self, context):
        pass_type = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText'
        password = context.envelope.getChild('Header').getChild('Security').getChild('UsernameToken').getChild(
            'Password')
        password.set('Type', pass_type)
 

marshalled方法会在suds发送数据给cmdbuild前执行。

 

 转载请带上我（http://i.cnblogs.com/EditPosts.aspx?postid=3963831）