topic Re: Using the Web services interface in Alfresco Archive

Using the Web services interface

ucorda — Tue, 16 Sep 2008 23:34:57 GMT

I have been trying to use the Web services interface, but I have encountered a few difficulties1) There is a mismatch between the implementation status as defined at http://wiki.alfresco.com/wiki/Alfresco_Draft_Implementation_Status and the actual operations made available via the WSDL files. For ex

Re: Using the Web services interface

ucorda — Wed, 17 Sep 2008 18:36:58 GMT

Thinking a little more about issue 2, it looks like your CMIS implementation for the WS interface expects a WS-Security header in the SOAP request.

If that is the case, it would really help if you guys could provide some documentation in this area, including which security tokens to use, examples, etc. This is particularly necessary given the fact that the CMIS spec does not address security and leaves that aspect to the various implementations.

Re: Using the Web services interface

davidc — Fri, 19 Sep 2008 17:44:28 GMT

Hi,

If you checkout the Labs from svn HEAD, you'll find a Java CMIS Web Service client.

It's located in projects/remote-api/source/sample/JavaCmisTest.

There's the source code and a build script for creating a stand-alone client.

Re: Using the Web services interface

ucorda — Fri, 19 Sep 2008 23:27:09 GMT

Thank you, David. That works fine.

Of course, I would like to get the same results with my own WS client. This is what I send out from my WS client:

POST /alfresco/cmis/RepositoryService HTTP/1.1
Host: localhost
Accept: application/soap+xml,multipart/related,text/*
User-Agent: IBM WebServices/1.0
Cache-Control: no-cache
Pragma: no-cache
SOAPAction: ""
Connection: Keep-Alive
Content-Type: text/xml; charset=utf-8
Content-Length: 747
Date: Fri, 19 Sep 2008 21:17:05 GMT

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header>
      <wsseecurity soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken>
            <wsse:Username>admin</wsse:Username>
            <wsseassword Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">admin</wsseassword>
         </wsse:UsernameToken>
      </wsseecurity>
   </soapenv:Header>
   <soapenv:Body>
      <p606:getRepositories xmlns606="http://www.cmis.org/2008/05'/>
   </soapenv:Body>
</soapenv:Envelope>

In response, I get this SOAP fault: "An error was discovered processing the <wsseecurity> header".

Is my SOAP request message incorrect? If it is, could you please show me what the correct request should look like?

Thank you,
Ugo Corda

Re: Using the Web services interface

davidc — Tue, 23 Sep 2008 09:52:05 GMT

The first message sent by the sample WS client is…

Encoding: UTF-8
Headers: {content-length=[1737], connection=[keep-alive], cache-control=[no-cache], host=[localhost:8080], user-agent=[Java/1.5.0_13], pragma=[no-cache], content-type=[text/xml; charset=UTF-8], accept=[*], soapaction=[""]}
Messages: 
Message:

Payload: 

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soap:mustUnderstand="1"><wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Timestamp-2802048"><wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2008-09-23T09:40:08.828Z</wsu:Created><wsu:Expires xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2008-09-23T09:45:08.828Z</wsu:Expires></wsu:Timestamp><wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="UsernameToken-826697"><wsse:Username xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">admin</wsse:Username><wsse:Password xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest">EPno7gYsqvt3H84BUfY/rJkPHuU=</wsse:Password><wsse:Nonce xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">mu6wI6ib1CNia+6mBWGFsA==</wsse:Nonce><wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2008-09-23T09:40:08.824Z</wsu:Created></wsse:UsernameToken></wsse:Security></soap:Header><soap:Body><ns1:getRepositories xmlns:ns1="http://www.cmis.org/2008/05" /></soap:Body></soap:Envelope>‍‍‍‍‍‍‍‍‍

The response is…

Encoding: UTF-8
Headers: {}
Messages: 
Payload: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"><wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="Timestamp-10854270"><wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2008-09-23T09:40:09.384Z</wsu:Created><wsu:Expires xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2008-09-23T09:45:09.384Z</wsu:Expires></wsu:Timestamp></wsse:Security></soap:Header><soap:Body><ns1:getRepositoriesResponse xmlns:ns1="http://www.cmis.org/2008/05"><ns1:repository><ns1:repositoryID>&lt;Unknown</ns1:repositoryID><ns1:repositoryName>Main Repository</ns1:repositoryName></ns1:repository></ns1:getRepositoriesResponse></soap:Body></soap:Envelope>
‍‍‍‍‍‍‍

It turned out to be more difficult than I thought to log this information. An update on HEAD makes this easier. I suggest updating at which point you can set the following log4j.properties value to trace in/out messages:

log4j.logger.org.apache.cxf=info

Re: Using the Web services interface

onewnan — Tue, 23 Sep 2008 22:02:23 GMT

Nice, I missed this code when I first installed the project. FYI to compile and debug JavaCmisTest under eclipse as it's own project I had to download a few libs:

opensaml-1.0.1.jar
velocity-1.4.jar
velocity-dep-1.4.jar

Re: Using the Web services interface

ucorda — Wed, 24 Sep 2008 17:01:29 GMT

Thank you, David. Now I see what the problem is. You guys expect a WSS UserName token which uses the PasswordDigest type of password, while I was using the PasswordText type.

I am creating the client using the IBM WebSphere/Rational set of tools, and they only support the PasswordText type of password.

I strongly suggest you guys also accept the PasswordType token, otherwise the basic reason for using the Web services interface, i.e. interoperability with various clients, would be nullified.

Thank you,
Ugo

Re: Using the Web services interface

ucorda — Wed, 24 Sep 2008 17:05:56 GMT

Sorry, I actually meant "I strongly suggest you guys also accept the PasswordText type of username token".

Re: Using the Web services interface

davidc — Wed, 24 Sep 2008 17:15:46 GMT

Thanks for the suggestion. We'll add that capability, hopefully, in the short term.

Re: Using the Web services interface

onewnan — Thu, 25 Sep 2008 19:26:03 GMT

Earlier in the thread the question was asked but not answered, how do we get the repositoryId to use as input for CMIS operations? It would seem we could get the information something like this


        GetRepositoryInfo parameteers = new GetRepositoryInfo();
        List<CmisRepositoryEntryType> entries = servicesPort.getRepositories();  // RepositoryServicePort
        defaultRepositoryId = entries.get(0).getRepositoryID();
        defaultRepositoryName = entries.get(0).getRepositoryName();
        parameteers.setRepositoryId(defaultRepositoryId);
‍‍‍‍‍‍‍

However, when using the resulting defaultRepositoryId or defaultRepositoryName as the repositoryId input to getProperties, the operation returns a SOAP fault indicating invalid repository ID. Where can we locate the correct ID for getProperties?

Re: Using the Web services interface

vinila — Thu, 05 Feb 2009 04:33:51 GMT

Hi,

I am trying some web service requests to the "getRepositories" service under the WSDL, http://localhost:8080/alfresco/cmis/RepositoryService using the soapUI tool.

The request is

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.cmis.org/2008/05">

<soapenv:Header>
   <wsseecurity xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" soapenv:mustUnderstand="1">
      <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsu:Created>2009-01-20T17:05:10.609Z</wsu:Created>
            <wsu:Expires>2010-01-20T20:05:22.609Z</wsu:Expires>
      </wsu:Timestamp>
      <wsse:UsernameToken xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
         <wsse:Username>vinila</wsse:Username>
         <wsseassword Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">TICKET_1c07c25b8dfae8e5746d877337c529aaa8b0ea7a</wsseassword>
      </wsse:UsernameToken>
   </wsseecurity>
</soapenv:Header>

<soapenv:Body>
   <ns:getRepositories/>
</soapenv:Body>

</soapenv:Envelope>

The response is

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Header>
      <wsseecurity xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsu:Timestamp wsu:Id="Timestamp-25511702" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsu:Created>2009-02-04T14:36:03.515Z</wsu:Created>
            <wsu:Expires>2009-02-04T14:41:03.515Z</wsu:Expires>
         </wsu:Timestamp>
      </wsseecurity>
   </soap:Header>
   <soap:Body>
      <soap:Fault>
         <faultcode>soaperver</faultcode>
         <faultstring>Incorrect password</faultstring>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

In the response, I get this SOAP fault: "Incorrect password".

The password used in the request was obtained from, http://localhost:8080/alfresco/service/api/login?u=admin&pw=admin.

Am i missing something here? Please let me know how to resolve this issue.

Thanks

Re: Using the Web services interface

eliseosoto — Wed, 11 Mar 2009 20:40:01 GMT

I'm also having problems using soapUI, I've done a lot of tests…
where do I get the password for WS-Security? What's the username I should use? Right now my configuration is using the default admin/admin.

Re: Using the Web services interface

shamabbas — Wed, 02 Sep 2009 11:23:34 GMT

Hi all and eliseosoto

I was also just trying to solve this problem. First i tried to configure it admin/admin username/password but wasn't working then I add authentication web service by adding this wsdl in the project "
http://localhost:8080/alfresco/wsdl/authentication-service.wsdl"
and then in its startsession with request 1 i pasted the following code

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.alfresco.org/ws/service/authentication/1.0">
   <soapenv:Header/>
   <soapenv:Body>
 <ns:startSession>
         <ns:username>admin</ns:username>
         <ns:password>admin</ns:password>
      </ns:startSession>
   </soapenv:Body>
</soapenv:Envelope>‍‍‍‍‍‍‍‍‍

and its response generated a ticket which I pasted into my ContentService requests against password and username i just used "admin" like this


<soapenv:Envelope xmlns:ns="http://www.alfresco.org/ws/service/content/1.0" xmlns:ns1="http://www.alfresco.org/ws/model/content/1.0" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
 
<soapenv:Header>
<requestFlow>
   <handler type="soapmonitor"/>
   <handler type="java:org.apache.ws.axis.security.WSDoAllReceiver">
     <parameter name="action" value="Signature Timestamp"/>
     <parameter name="signaturePropFile" value="server_crypto.properties" />
   </handler>
  </requestFlow>
 
  <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken-26993204" xmlns:wsu="http://docs.oasis-open.org/wss/2009/08/oasis-200908-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>admin</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordDigest"><ticket>TICKET_b03374c1f074a1cf48ff5da1554c69b8fc2ca5e3</ticket></wsse:Password>
            <wsse:Nonce>MW7JmYsaQIrM8DD63cdN3Q==</wsse:Nonce>
            <wsu:Created>2009-03-11T21:31:13.284Z</wsu:Created>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <ns:read xmlns="http://www.alfresco.org/ws/service/content/1.0">
         <ns:items>
            <!–You have a CHOICE of the next 2 items at this level–>
            <!–Zero or more repetitions:–>
            <ns1:nodes xmlns="http://www.alfresco.org/ws/model/content/1.0">
               <!–Optional:–>
               <ns1:store>
                  <!–Optional:–>
                  <ns1:scheme>workspace</ns1:scheme>
                   <ns1:address>SpacesStore</ns1:address>
               </ns1:store>
               <ns1:uuid>3d036088-e548-461f-ba9c-49497d3cf046</ns1:uuid>
                <ns1:path/>
            </ns1:nodes>
         </ns:items>
         <ns:property>{http://www.alfresco.org/model/content/1.0}content</ns:property>
      </ns:read>
   </soapenv:Body>
</soapenv:Envelope>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

My authentication process worked but I got other exception. Which was

"<faultstring>org.xml.sax.SAXParseException: Element or attribute do not match QName production: QName::=(NCName':')?NCName.</faultstring>"
" <ns1:stackTrace xmlns:ns1="http://xml.apache.org/axis/">org.xml.sax.SAXParseException: Element or attribute do not match QName production: QName::=(NCName':')?NCName. "

I'm looking for its solution now maybe you have already done this? If not then authentication process can be resolve like such and maybe you can help me too with the exception im getting?

Re: Using the Web services interface

eliseosoto — Wed, 02 Sep 2009 16:27:03 GMT

sorry, I'm not working with Alfresco anymore, I think the WS support is a bit immature at this point.

Re: Using the Web services interface

shamabbas — Thu, 03 Sep 2009 03:36:18 GMT

ok I got. I'm trying to use alfresco web services and APIs to work with my Flex developed simple application to retrieve and upload files in alfresco repositroy. If you can help me anyway please do so. How and what APIs should use etc..

Thanks for quick response.

Sham

Re: Using the Web services interface

samir_raut34 — Fri, 18 Dec 2009 09:53:08 GMT

I am using php to communicate with .NET web services and i am getting Invalid Security error.

<soap:Fault><faultcode xmlns:ns1="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">ns1:InvalidSecurity</faultcode><faultstring>An error was discovered processing the <wsseecurity> header</faultstring></soap:Fault>

Please can any one help me out