fmancinelli (SVN) wrote:

Author: fmancinelli Date: 2008-12-20 22:13:33 +0100 (Sat, 20 Dec 2008) New Revision: 14895

Added: platform/core/trunk/xwiki-xmlrpc/xwiki-xmlrpc-model/src/main/java/org/xwiki/xmlrpc/XWikiXmlRpcApi.java Modified: platform/core/trunk/xwiki-xmlrpc/xwiki-xmlrpc-model/src/main/java/org/xwiki/xmlrpc/model/Utils.java platform/core/trunk/xwiki-xmlrpc/xwiki-xmlrpc-model/src/main/java/org/xwiki/xmlrpc/model/XWikiClass.java platform/core/trunk/xwiki-xmlrpc/xwiki-xmlrpc-model/src/main/java/org/xwiki/xmlrpc/model/XWikiClassSummary.java platform/core/trunk/xwiki-xmlrpc/xwiki-xmlrpc-model/src/main/java/org/xwiki/xmlrpc/model/XWikiExtendedId.java platform/core/trunk/xwiki-xmlrpc/xwiki-xmlrpc-model/src/main/java/org/xwiki/xmlrpc/model/XWikiObject.java platform/core/trunk/xwiki-xmlrpc/xwiki-xmlrpc-model/src/main/java/org/xwiki/xmlrpc/model/XWikiObjectSummary.java platform/core/trunk/xwiki-xmlrpc/xwiki-xmlrpc-model/src/main/java/org/xwiki/xmlrpc/model/XWikiPage.java platform/core/trunk/xwiki-xmlrpc/xwiki-xmlrpc-model/src/main/java/org/xwiki/xmlrpc/model/XWikiPageHistorySummary.java platform/core/trunk/xwiki-xmlrpc/xwiki-xmlrpc-model/src/main/java/org/xwiki/xmlrpc/model/XWikiPageSummary.java Log: XWIKI-3028: XMLRPC Subsystem refactoring/improvement XWIKI-3029: XMLRPC getObject() does not return any information about DBList, DBTreeList, etc. values.

(XWIKI-3028) Definition of the XmlRpcApi.

(XWIKI-3029) The XWikiObject class has been extended with a mechanism for retrieving metadata associated to properties. This is necessary for attaching to a property which is a DBList, for example, the list of the allowed values. Meta-properties are stored as normal object properties but they have a special suffix. The getProperties method does not return these meta-properties. In order to access to meta-properties additional methods are provided.

Added: platform/core/trunk/xwiki-xmlrpc/xwiki-xmlrpc-model/src/main/java/org/xwiki/xmlrpc/XWikiXmlRpcApi.java =================================================================== +public interface XWikiXmlRpcApi +{ + /* Authentication */ + public String login(String username, String password) throws Exception; + + public Boolean logout(String token) throws Exception; + + /* General */ + public Map/* ServerInfo */getServerInfo(String token) throws Exception; + + /* Spaces */ + public List/* List<SpaceSummary> */getSpaces(String token) throws Exception; + + public Map/* Space */getSpace(String token, String spaceKey) throws Exception; + + public Map/* Space */addSpace(String token, Map spaceMap) throws Exception; + + public Boolean removeSpace(String token, String spaceKey) throws Exception; + + /* Pages */ + public List/* List<PageSummary> */getPages(String token, String spaceKey) throws Exception; + + public Map/* XWikiPage */getPage(String token, String pageId) throws Exception; + + public Map/* XWikiPage */storePage(String token, Map pageMap) throws Exception; + + public Map/* XWikiPage */storePage(String token, Map pageMap, boolean checkVersion) throws Exception; + + public Boolean removePage(String token, String pageId) throws Exception; + + public List/* List<XWikiPageHistorySummary> */getPageHistory(String token, String pageId) throws Exception; + + public String renderContent(String token, String space, String pageId, String content) throws Exception;

Why is there a "String space" parameter?

+ /* Comments */ + public List/* List<Comment> */getComments(String token, String pageId) throws Exception; + + public Map/* Comment */getComment(String token, String commentId) throws Exception; + + public Map/* Comment */addComment(String token, Map commentMap) throws Exception; + + public Boolean removeComment(String token, String commentId) throws Exception; + + /* Attachments */ + public List/* List<Attachment> */getAttachments(String token, String pageId) throws Exception; + + public Map/* Attachmnent */addAttachment(String token, Integer contentId, Map attachmentMap, byte[] attachmentData) + throws Exception;

What is the contentId?

+ public byte[] getAttachmentData(String token, String pageId, String fileName, String versionNumber) + throws Exception;

How do I find out the possible version numbers?

+ public Boolean removeAttachment(String token, String pageId, String fileName) throws Exception; + + /* Classes */ + public List/* List<XWikiClassSummary> */getClasses(String token) throws Exception; + + public Map/* XWikiClass */getClass(String token, String className) throws Exception; + + /* Objects */ + public List/* List<XWikiObjectSummary> */getObjects(String token, String pageId) throws Exception; + + public Map/* XWikiObject */getObject(String token, String pageId, String className, Integer id) throws Exception; + + public Map/* XWikiObject */storeObject(String token, Map objectMap) throws Exception; + + public Map/* XWikiObject */storeObject(String token, Map objectMap, boolean checkVersion) throws Exception;

Where is the original version stored? In XWiki, objects don't have versions.

+ public Boolean removeObject(String token, String pageId, String className, Integer id) throws Exception; + + /* Search */ + public List/* List<SerarchResult> */search(String token, String query, int maxResults) throws Exception; + + public List/* List<XWikiPageHistorySummary> */getModifiedPagesHistory(String token, Date date, int numberOfResults, + int start, boolean fromLatest) throws Exception; + +}

-- Sergiu Dumitriu http://purl.org/net/sergiu/