topic Use of CMIS web scripts in Alfresco Archive

Use of CMIS web scripts

lakshya — Wed, 07 Jan 2009 11:42:40 GMT

I got the link for using CMIS web script.I want to create document / folder by hitting the URL provided by http://wiki.alfresco.com/wiki/CMIS_Web_Scripts_Reference#Create_folder_or_document_.28createDocument.2C_createFolder.29_2 The URL provided for it is http://localhost:8080/alfresco/service/api/p

Re: Use of CMIS web scripts

mrogers — Wed, 07 Jan 2009 12:16:19 GMT

In general you will need to find and use a POST script to create content. And you will specify your content within the content of your posted data.

Re: Use of CMIS web scripts

lakshya — Wed, 07 Jan 2009 12:27:18 GMT

Can you please clarify it little more.
Because we are hitting the url given as POST only.

POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants
POST /alfresco/service/api/path/{store_type}/{store_id}/{id}/descendants

Re: Use of CMIS web scripts

mrogers — Wed, 07 Jan 2009 12:46:06 GMT

In a RESTful API resources are identified by URIs and HTTP commands operate upon those resources.   The http commands are GET, PUT, POST, and DELETE messages which (very roughly) correspond to read, update, create and delete.

Each web script will negotiate the format of data it will accept and the format of data it will return.   In this particular case your decision is easy since this particular resource will only accept ATOM and will only return ATOM.

So to create a new folder you will need to POST appropriate atom content to the correct URI.

One useful trick that may help you is to look at the java script implementation, in this case descendants.post.atom.js.   You may also find unit tests calling this script.

Re: Use of CMIS web scripts

lakshya — Wed, 07 Jan 2009 14:21:53 GMT

Can you please give an example for like delete content

because when i hit URL provided by
DELETE /alfresco/service/api/node/{store_type}/{store_id}/{id}?includeChildren={includeChildren?}
DELETE /alfresco/service/api/path/{store_type}/{store_id}/{id}?includeChildren={includeChildren?}

given on http://wiki.alfresco.com/wiki/CMIS_Web_Scripts_Reference#Delete_item_.28deleteObject.29

it browses as
 http://localhost:8080/alfresco/service/api/node/workspace/SpacesStore/{id}?includeChildren={includeChildren?}

it gives the list of children.

I have
item.delete.desc.xml
<webscript>
<shortname>Delete item (deleteObject)</shortname>
<description>
<![CDATA[
Deletes specified object 
 
Inputs: 
 
ID objectId 
 
Notes: 
 
If the object is a Folder with at least one child, throw ConstraintViolationException. 
If the object is the Root Folder, throw OperationNotSupportedException. 
When a filed object is deleted, it is removed from all folders it is filed in. 
This service deletes a specific version of a document object. To delete all versions, use deleteAllVersions() 
Deletion of a private working copy (checked out version) is the same as to cancel checkout. 
]]>
</description>
<url>/api/node/{store_type}/{store_id}/{id}?includeChildren={includeChildren?}</url>
<url>/api/path/{store_type}/{store_id}/{id}?includeChildren={includeChildren?}</url>
<authentication>user</authentication>
<format default="html"/>
<family>CMIS</family>
</webscript>

and item.delete.js

script:
{
 // locate node
 var pathSegments = url.match.split("/");
 var reference = [ url.templateArgs.store_type, url.templateArgs.store_id ].concat(url.templateArgs.id.split("/"));
 var node = cmis.findNode(pathSegments[2], reference);
 if (node === null)
 {
 status.code = 404;
 status.message = "Repository " + pathSegments[2] + " " + reference.join("/") + " not found";
 status.redirect = true;
 break script;
 }

 if (!node.hasPermission("Delete"))
 {
 status.code = 403;
 status.message = "Permission to delete is denied";
 status.redirect = true;
 break script;
 }

 // if deleting a folder, only delete when the folder is empty or
 // a force delete has been specified
 // NOTE: force delete is not part of CMIS specification
 if (node.isFolder)
 {
 if (node.children.length > 0 && !args.includeChildren)
 {
 status.code = 403;
 status.message = "Cannot delete folder " + pathSegments[2] + " " + reference.join("/") + " as it's not empty";
 status.redirect = true;
 break script;
 }
 }

 // Note: checked-out documents are automatically unlocked if a private working copy is deleted
 if (!node.remove())
 {
 status.code = 500;
 status.message = "Failed to delete node " + pathSegments[2] + " " + reference.join("/");
 status.redirect = true;
 break script;
 }

 status.code = 204; // Success, but no response content
 status.redirect = true;
}

Can u please let me know that how http DELETE comand is getting fired by URL
http://localhost:8080/alfresco/service/api/node/workspace/SpacesStore/{id}?includeChildren={includeChildren?}

Thanks in advance…

Re: Use of CMIS web scripts

mrogers — Wed, 07 Jan 2009 15:06:03 GMT

If you are seeing a list of children then you are issuing a GET rather than a DELETE.

For example if you simply typing a URL into firefox. Then you are doing GET.

What you need to use is some sort of HTTP client.

Here's a popular one for Java Script.
[[http://en.wikipedia.org/wiki/XMLHttpRequest]]

And if you are using Java then take a look at classes like HttpURLConnection.

Also here's a link to the Alfresco wiki that may be relevant.
[[http://wiki.alfresco.com/wiki/Web_Scripts#Tunneling_HTTP_Methods]]

Re: Use of CMIS web scripts

lakshya — Fri, 09 Jan 2009 08:47:25 GMT

Thanks a lot for your reply.

Now I am using HttpClient and hiiting the URL for GET and DELETE. I am getting the proper result.
But in case of POST i am getting error.

The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

I am trying to create folder / document by hitting the URL
"http://localhost:8080/alfresco/service/api/path/workspace/SpacesStore/Company Home/descendants/"

Do I need to pass method name like createFolder or createDocument in it. If yes, how?

How will I pass folder / document name that is to be created?

Can you explain it?

Thanks.

Re: Use of CMIS web scripts

lakshya — Fri, 16 Jan 2009 13:54:03 GMT

Can anyone answer my question?

I am using PostMethod of apache common to create doc / folder in alfresco.

The code snippet is :
               String url = "http://localhost:8080/alfresco/service/api/path/workspace/SpacesStore/Company%20Home/descendants/";
      String creds = "admin" + ":" + "admin";
      HttpClient httpClient = new HttpClient();
      PostMethod method = new PostMethod(url);
      method.setRequestHeader("Authorization", "Basic "
            + new String(Base64.encodeBase64(creds.getBytes())));
      String filePath = "C:/temp/test.txt";
      String contentType = "text/plain";
      File upload = new File(filePath);
      method.setRequestHeader("name", upload.getName());
      method.setRequestHeader("Content-type", contentType);
      method.setRequestBody(new FileInputStream(upload));
      httpClient.executeMethod(method);
      System.out.println(method.getResponseBodyAsString());

But I am getting error :
Script url /api/path/workspace/SpacesStore/Company Home/descendants/ does not support the method POST

And when I Post URL = "http://localhost:8080/alfresco/service/api/path/workspace/SpacesStore/Company%20Home/descendants"; (without ending by /)

Can anyone tell me how to use REStClient for PostMethod in Alfresco.

Regards.

Re: Use of CMIS web scripts

lakshya — Mon, 19 Jan 2009 08:19:29 GMT

Can anyone answer this question please . . . . .

I am stuck :roll:

Re: Use of CMIS web scripts

mrogers — Mon, 19 Jan 2009 09:41:32 GMT

I don't have the answer to hand but I do note that you are posting a content type of text/plain.

This script will require some sort of atom format rather than plain text.

Re: Use of CMIS web scripts

lakshya — Mon, 19 Jan 2009 12:20:43 GMT

Sorry,
Please read these two lines
String filePath = "C:/temp/test.txt";
String contentType = "text/plain";

as

String filePath = "C:/temp/test.xml";
String contentType = "application/atom+xml";

My xml file is :
 <?xml version='1.0' encoding='utf-8'?>
 <entry xmlns='http://www.w3.org/2005/Atom' xmlns:cmis='http://www.cmis.org/2008/05'>
 <title>Mytitle</title>
 <summary>Mysummary</summary>
 <cmisbject>
 <cmisroperties>
 <cmisropertyString cmis:name='ObjectTypeId'><cmis:value>document</cmis:value></cmisropertyString>
 </cmisroperties>
 </cmisbject>
 </entry>

Can u now give some pointer, I am still getting same error.

I am doing this from the reference of
http://wiki.alfresco.com/wiki/CMIS_Web_Scripts_Reference#Create_folder_or_document_.28createDocument.2C_createFolder.29

I am using Alfresco Labs 3 B Release.

Re: Use of CMIS web scripts

mikeh — Mon, 19 Jan 2009 13:20:10 GMT

/alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants

"Company Home" is not an {id}. You need the GUID part of the node reference in it's place.

Mike

Re: Use of CMIS web scripts

lakshya — Mon, 19 Jan 2009 13:24:07 GMT

We can use either
http://localhost:8080/alfresco/service/api/node/workspace/SpacesStore/7018a7e3-d366-4389-84c6-bd79d793c270/children/

or
http://localhost:8080/alfresco/service/api/path/workspace/SpacesStore/Company%20Home/children/

both are correct ways . .

But now, as per your suggestion I am using
http://localhost:8080/alfresco/service/api/node/workspace/SpacesStore/7018a7e3-d366-4389-84c6-bd79d793c270/children/

Still no hopes

Re: Use of CMIS web scripts

lakshya — Tue, 20 Jan 2009 08:39:29 GMT

Can anyone give me one example code for calling
POST /alfresco/service/api/node/{store_type}/{store_id}/{id}/descendants

RestApi directly through HttpClient

I am doing it in this way :
String URL = "http://localhost:8080/alfresco/service/api/node/workspace/SpacesStore/7018a7e3-d366-4389-84c6-bd79d793c270/descendants";
PostMethod post = new PostMethod(URL);
NameValuePair[] data = { new NameValuePair("typeId", "folder") };
post.setRequestBody(data);
int statusCode1 = client.executeMethod(post);

It gives me 400 error code i.e. Bad request

An when I give (/ at last of URL)
String URL = "http://localhost:8080/alfresco/service/api/node/workspace/SpacesStore/7018a7e3-d366-4389-84c6-bd79d793c270/descendants/";

It gives 405 - Method Not Allowed

I am using alfresco Lab 3 (http://wiki.alfresco.com/wiki/Alfresco_Labs_3#Alfresco_Draft_CMIS_Implementation)

RestApi bindings - http://wiki.alfresco.com/wiki/CMIS#REST_API_Binding

and call to restApi is taken from http://wiki.alfresco.com/wiki/CMIS_Web_Scripts_Reference#Create_folder_or_document_.28createDocument.2C_createFolder.29_2

Am i not taking correct version or something is missing in the code ?

I am not able to call all the POST methods. But GET and DELETE from the same link is working properly.

I would be great if someone will share the code snippet to call cmis RestApi fo ALfresco.

Thanks in advance.

Re: Use of CMIS web scripts

lakshya — Tue, 20 Jan 2009 09:22:14 GMT

Please Please Please . . .
I am stuck from long time :<

can anyone reply with code snippet . ..

Re: Use of CMIS web scripts

lakshya — Wed, 21 Jan 2009 12:12:24 GMT

Can anyone help me out

Re: Use of CMIS web scripts

lakshya — Tue, 27 Jan 2009 09:54:51 GMT

I got the solution
http://forums.alfresco.com/en/viewtopic.php?f=36&t=15438#p54330

Re: Use of CMIS web scripts

jpotts — Tue, 10 Feb 2009 14:48:03 GMT

I know this is an old thread but I thought it might help someone else looking for the answer. If you go look at the "children" web scripts, which are located in $TOMCAT_HOME/webapps/alfresco/WEB-INF/classes/alfresco/templates/webscripts/org/alfresco/repository/store, you'll notice there are two controllers. One is called children.post.js. The other is called children.post.atom.js. The web script framework is selecting the controller based on the mime type of the content being posted. If you look at the children.post.js, you'll see that it immediately returns an error 400 whereas the children.post.atom.js actually does the work of creating a new node based on the ATOM entry.

Long story short: Change the mime type of the data you are posting to "application/atom+xml" and it should work.

Re: Use of CMIS web scripts

ianjamesmorgan — Fri, 27 Feb 2009 03:07:50 GMT

I thinks it because your content type is still not correct

should be "application/atom+xml;type=entry"

see this alternative post on the forum - http://forums.alfresco.com/en/viewtopic.php?f=36&t=15438

It worked for me - full Java code is:

import java.io.File;
import java.io.FileInputStream;

import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.methods.PostMethod;
import org.bouncycastle.util.encoders.Base64;

public class PostToAlfresco {

public static void main (String[] args) {

 try {
 String url = "http://localhost:8080/alfresco/service/api/path/workspace/SpacesStore/Company%20Home/children";
 String creds = "admin" + ":" + "admin";
 HttpClient httpClient = new HttpClient();
 PostMethod method = new PostMethod(url);
 method.setRequestHeader("Authorization", "Basic "
 + new String(Base64.encode(creds.getBytes())));

 String filePath = "D:\\devtools\\AlfrescoSDK\\samples\\FirstWebServiceClient\\source\\testDoc.xml";
 String contentType = "application/atom+xml;type=entry";
 File upload = new File(filePath);
 method.setRequestHeader("name", upload.getName());
 method.setRequestHeader("Content-type", contentType);
 method.setRequestBody(new FileInputStream(upload));
 httpClient.executeMethod(method);
 System.out.println(method.getResponseBodyAsString());
 } catch (Exception e) {
 e.printStackTrace();
 }
}
}

the file is

<?xml version='1.0' encoding='utf-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:cmis='http://www.cmis.org/2008/05'>
<title>REST doc example2</title>
<summary>Summary</summary>
<content type="text">this is some data</content>
<cmisbject>
<cmisroperties>
<cmisropertyString cmis:name='ObjectTypeId'><cmis:value>document</cmis:value></cmisropertyString>

</cmisroperties>
</cmisbject>
</entry>

Re: Use of CMIS web scripts

erictice — Thu, 28 May 2009 16:16:13 GMT

Did anyone answer this for you? If not let me know.