org.xwiki.xmlrpc
Interface XWikiXmlRpcApi

public interface XWikiXmlRpcApi

The XWiki XML RPC API.

Version:

$Id: 703fcd3160403a4681b52d67401dc97972c4b445 $

Method Summary

Map	addAttachment(String token, Integer contentId, Map attachmentMap, byte[] attachmentData)
Map	addComment(String token, Map commentMap)
Map	addSpace(String token, Map spaceMap)
String	convert(String token, String source, String initialSyntaxId, String targetSyntaxId)
byte[]	getAttachmentData(String token, String pageId, String fileName, String versionNumber)
List	getAttachments(String token, String pageId)
Map	getClass(String token, String className)
List	getClasses(String token)
Map	getComment(String token, String commentId)
List	getComments(String token, String pageId)
List<String>	getInputSyntaxes(String token)
List	getModifiedPagesHistory(String token, Date date, int numberOfResults, int start, boolean fromLatest)
Map	getObject(String token, String pageId, String guid)
Map	getObject(String token, String pageId, String className, Integer id)
List	getObjects(String token, String pageId)
List<String>	getOutputSyntaxes(String token)
Map	getPage(String token, String pageId)
List	getPageHistory(String token, String pageId)
List	getPages(String token, String spaceKey)
String	getRenderedContent(String token, String pageId, String syntaxId)
Map	getServerInfo(String token)
Map	getSpace(String token, String spaceKey)
List	getSpaces(String token)
String	login(String username, String password)
Boolean	logout(String token)
Boolean	removeAttachment(String token, String pageId, String fileName)
Boolean	removeComment(String token, String commentId)
Boolean	removeObject(String token, String pageId, String className, Integer id)
Boolean	removePage(String token, String pageId)
Boolean	removeSpace(String token, String spaceKey)
String	renderContent(String token, String space, String pageId, String content)
String	renderPageContent(String token, String pageId, String content, String sourceSyntaxId, String targetSyntaxId)
List	search(String token, String query, int maxResults)
Map	storeObject(String token, Map objectMap)
Map	storeObject(String token, Map objectMap, boolean checkVersion)
Map	storePage(String token, Map pageMap)
Map	storePage(String token, Map pageMap, boolean checkVersion)

Method Detail

login

String login(String username,
             String password)
             throws Exception

Throws:

Exception

logout

Boolean logout(String token)
               throws Exception

Throws:

Exception

getServerInfo

Map getServerInfo(String token)
                  throws Exception

Throws:

Exception

getSpaces

List getSpaces(String token)
               throws Exception

Throws:

Exception

getSpace

Map getSpace(String token,
             String spaceKey)
             throws Exception

Throws:

Exception

addSpace

Map addSpace(String token,
             Map spaceMap)
             throws Exception

Throws:

Exception

removeSpace

Boolean removeSpace(String token,
                    String spaceKey)
                    throws Exception

Throws:

Exception

getPages

List getPages(String token,
              String spaceKey)
              throws Exception

Throws:

Exception

getPage

Map getPage(String token,
            String pageId)
            throws Exception

Throws:

Exception

storePage

Map storePage(String token,
              Map pageMap)
              throws Exception

Throws:

Exception

storePage

Map storePage(String token,
              Map pageMap,
              boolean checkVersion)
              throws Exception

Throws:

Exception

removePage

Boolean removePage(String token,
                   String pageId)
                   throws Exception

Throws:

Exception

getPageHistory

List getPageHistory(String token,
                    String pageId)
                    throws Exception

Throws:

Exception

renderContent

String renderContent(String token,
                     String space,
                     String pageId,
                     String content)
                     throws Exception

Throws:

Exception

renderPageContent

String renderPageContent(String token,
                         String pageId,
                         String content,
                         String sourceSyntaxId,
                         String targetSyntaxId)
                         throws Exception

Throws:

Exception

getRenderedContent

String getRenderedContent(String token,
                          String pageId,
                          String syntaxId)
                          throws Exception

Throws:

Exception

convert

String convert(String token,
               String source,
               String initialSyntaxId,
               String targetSyntaxId)
               throws Exception

Throws:

Exception

getInputSyntaxes

List<String> getInputSyntaxes(String token)
                              throws Exception

Throws:

Exception

getOutputSyntaxes

List<String> getOutputSyntaxes(String token)
                               throws Exception

Throws:

Exception

getComments

List getComments(String token,
                 String pageId)
                 throws Exception

Throws:

Exception

getComment

Map getComment(String token,
               String commentId)
               throws Exception

Throws:

Exception

addComment

Map addComment(String token,
               Map commentMap)
               throws Exception

Throws:

Exception

removeComment

Boolean removeComment(String token,
                      String commentId)
                      throws Exception

Throws:

Exception

getAttachments

List getAttachments(String token,
                    String pageId)
                    throws Exception

Throws:

Exception

addAttachment

Map addAttachment(String token,
                  Integer contentId,
                  Map attachmentMap,
                  byte[] attachmentData)
                  throws Exception

Throws:

Exception

getAttachmentData

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

Throws:

Exception

removeAttachment

Boolean removeAttachment(String token,
                         String pageId,
                         String fileName)
                         throws Exception

Throws:

Exception

getClasses

List getClasses(String token)
                throws Exception

Throws:

Exception

getClass

Map getClass(String token,
             String className)
             throws Exception

Throws:

Exception

getObjects

List getObjects(String token,
                String pageId)
                throws Exception

Throws:

Exception

getObject

Map getObject(String token,
              String pageId,
              String className,
              Integer id)
              throws Exception

Throws:

Exception

getObject

Map getObject(String token,
              String pageId,
              String guid)
              throws Exception

Throws:

Exception

storeObject

Map storeObject(String token,
                Map objectMap)
                throws Exception

Throws:

Exception

storeObject

Map storeObject(String token,
                Map objectMap,
                boolean checkVersion)
                throws Exception

Throws:

Exception

removeObject

Boolean removeObject(String token,
                     String pageId,
                     String className,
                     Integer id)
                     throws Exception

Throws:

Exception

search

List search(String token,
            String query,
            int maxResults)
            throws Exception

Throws:

Exception

getModifiedPagesHistory

List getModifiedPagesHistory(String token,
                             Date date,
                             int numberOfResults,
                             int start,
                             boolean fromLatest)
                             throws Exception

Throws:

Exception