[Osr-101] Cyclone protocol [Fwd: Re: Yulup.org]

[Michael Wechner]

Hi

Roman from Cyclone sent me some information re the protocol which 
Cyclone is using (please see below),
whereas he told me that they would like to support WebDAV in the future.

Cheers

Michael

-------- Original Message --------
Subject: 	Re: Yulup.org
Date: 	Sat, 19 May 2007 13:42:45 +0200
From: 	Roman Fordinal <roman.fordinal at comsultia.com>
To: 	cyclone3-devel at lists.sourceforge.net
CC: 	Michael Wechner <michael.wechner at wyona.com>
References: 	<464DB60D.4040206 at comsultia.com> <464EA7A9.9000304 at wyona.com>



> 
> What is Cyclone using? Resp. is there some documentation re the protocol 
> Cyclone is using?

Current state of Cyclone3 documentation is not very usable, but XML 
protocol to communicate with Cyclone3 backend is very simple.

Cyclone3 XULadmin is a XUL frontend, and Cyclone3 Framework is a 
framework running on GNU/Linux server. Configured domain service can 
communicate with Cyclone3 XULadmin using XML protocol to manage another 
domain service (webpage typically).

Authentification is described in .htacces and SSL protocol is supported.

All requests to back-end is sended using standard GET and POST method. 
All variables is unencrypted, none XML protocol in request is used.

Responses is in XML, and here is a example of list:

<response IDapp="a400" type="list" code="DD7s7DQ9">
  <setup>
   ...
  </setup>
  <header>
   ...
  </header>
  <item IDitem="1">
   ...
  </item>
  <item IDitem="2">
   ...
  </item>
</response>

or response after action:

<response IDapp="a400" type="active" IDitem="1" result="0">
 <result>0</result>
 <reason>
   Not enough information to act. Missing parameter 'db_active'
 </reason>
</response>


XML protocol is application oriented, also every application (articles, 
polls, site-map, forums,...) can handle actions by own way.

Because we changed architecture from application oriented to add-ons 
oriented (add-ons can be applications and extension) the new way how-to 
create response in new developed add-ons is to inform about add-on:

request: http://cyclone.example.tld/?type=a401_article_cat_list
('type' is a name of 'type of service' in 'domain service')

<response
 addon="a401"
 addon_type="article_cat"
 type="list"
 required_status=""
 code="QDiSXNd8"
 required_ID="">
 <location>/</location>
 <item IDitem="1">
  <ID>1</ID>
  <ID_entity>1</ID_entity>
  <IDparent></IDparent>
  <name>test</name>
  <name_url>test</name_url>
  <path></path>
  <datetime_create>2007-04-27 23:16:16</datetime_create>
  <lng>en</lng>
  <status>Y</status>
  <folder>Y</folder>
 </item>
 <item IDitem="2">
  <ID>2</ID>
  <ID_entity>2</ID_entity>
  <IDparent></IDparent>
  <name>Root article</name>
  <name_url>Root-article</name_url>
  <path></path>
  <datetime_create>2007-04-29 21:47:34</datetime_create>
  <lng>en</lng>
  <status>Y</status>
  <folder></folder>
 </item>
</response>




-- 
Michael Wechner
Wyona      -   Open Source Content Management   -    Apache Lenya
http://www.wyona.com                      http://lenya.apache.org
michael.wechner at wyona.com                        michi at apache.org
+41 44 272 91 61