Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.xwiki.xmlrpc
Interface XWikiXmlRpcApi

public interface XWikiXmlRpcApi

The XWiki XML RPC API.

Version:
$Id$

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

Method Detail

login

java.lang.String login(java.lang.String username,
                       java.lang.String password)
                       throws java.lang.Exception
Throws:
java.lang.Exception

logout

java.lang.Boolean logout(java.lang.String token)
                         throws java.lang.Exception
Throws:
java.lang.Exception

getServerInfo

java.util.Map getServerInfo(java.lang.String token)
                            throws java.lang.Exception
Throws:
java.lang.Exception

getSpaces

java.util.List getSpaces(java.lang.String token)
                         throws java.lang.Exception
Throws:
java.lang.Exception

getSpace

java.util.Map getSpace(java.lang.String token,
                       java.lang.String spaceKey)
                       throws java.lang.Exception
Throws:
java.lang.Exception

addSpace

java.util.Map addSpace(java.lang.String token,
                       java.util.Map spaceMap)
                       throws java.lang.Exception
Throws:
java.lang.Exception

removeSpace

java.lang.Boolean removeSpace(java.lang.String token,
                              java.lang.String spaceKey)
                              throws java.lang.Exception
Throws:
java.lang.Exception

getPages

java.util.List getPages(java.lang.String token,
                        java.lang.String spaceKey)
                        throws java.lang.Exception
Throws:
java.lang.Exception

getPage

java.util.Map getPage(java.lang.String token,
                      java.lang.String pageId)
                      throws java.lang.Exception
Throws:
java.lang.Exception

storePage

java.util.Map storePage(java.lang.String token,
                        java.util.Map pageMap)
                        throws java.lang.Exception
Throws:
java.lang.Exception

storePage

java.util.Map storePage(java.lang.String token,
                        java.util.Map pageMap,
                        boolean checkVersion)
                        throws java.lang.Exception
Throws:
java.lang.Exception

removePage

java.lang.Boolean removePage(java.lang.String token,
                             java.lang.String pageId)
                             throws java.lang.Exception
Throws:
java.lang.Exception

getPageHistory

java.util.List getPageHistory(java.lang.String token,
                              java.lang.String pageId)
                              throws java.lang.Exception
Throws:
java.lang.Exception

renderContent

java.lang.String renderContent(java.lang.String token,
                               java.lang.String space,
                               java.lang.String pageId,
                               java.lang.String content)
                               throws java.lang.Exception
Throws:
java.lang.Exception

renderPageContent

java.lang.String renderPageContent(java.lang.String token,
                                   java.lang.String pageId,
                                   java.lang.String content,
                                   java.lang.String sourceSyntaxId,
                                   java.lang.String targetSyntaxId)
                                   throws java.lang.Exception
Throws:
java.lang.Exception

getRenderedContent

java.lang.String getRenderedContent(java.lang.String token,
                                    java.lang.String pageId,
                                    java.lang.String syntaxId)
                                    throws java.lang.Exception
Throws:
java.lang.Exception

convert

java.lang.String convert(java.lang.String token,
                         java.lang.String source,
                         java.lang.String initialSyntaxId,
                         java.lang.String targetSyntaxId)
                         throws java.lang.Exception
Throws:
java.lang.Exception

getInputSyntaxes

java.util.List<java.lang.String> getInputSyntaxes(java.lang.String token)
                                                  throws java.lang.Exception
Throws:
java.lang.Exception

getOutputSyntaxes

java.util.List<java.lang.String> getOutputSyntaxes(java.lang.String token)
                                                   throws java.lang.Exception
Throws:
java.lang.Exception

getComments

java.util.List getComments(java.lang.String token,
                           java.lang.String pageId)
                           throws java.lang.Exception
Throws:
java.lang.Exception

getComment

java.util.Map getComment(java.lang.String token,
                         java.lang.String commentId)
                         throws java.lang.Exception
Throws:
java.lang.Exception

addComment

java.util.Map addComment(java.lang.String token,
                         java.util.Map commentMap)
                         throws java.lang.Exception
Throws:
java.lang.Exception

removeComment

java.lang.Boolean removeComment(java.lang.String token,
                                java.lang.String commentId)
                                throws java.lang.Exception
Throws:
java.lang.Exception

getAttachments

java.util.List getAttachments(java.lang.String token,
                              java.lang.String pageId)
                              throws java.lang.Exception
Throws:
java.lang.Exception

addAttachment

java.util.Map addAttachment(java.lang.String token,
                            java.lang.Integer contentId,
                            java.util.Map attachmentMap,
                            byte[] attachmentData)
                            throws java.lang.Exception
Throws:
java.lang.Exception

getAttachmentData

byte[] getAttachmentData(java.lang.String token,
                         java.lang.String pageId,
                         java.lang.String fileName,
                         java.lang.String versionNumber)
                         throws java.lang.Exception
Throws:
java.lang.Exception

removeAttachment

java.lang.Boolean removeAttachment(java.lang.String token,
                                   java.lang.String pageId,
                                   java.lang.String fileName)
                                   throws java.lang.Exception
Throws:
java.lang.Exception

getClasses

java.util.List getClasses(java.lang.String token)
                          throws java.lang.Exception
Throws:
java.lang.Exception

getClass

java.util.Map getClass(java.lang.String token,
                       java.lang.String className)
                       throws java.lang.Exception
Throws:
java.lang.Exception

getObjects

java.util.List getObjects(java.lang.String token,
                          java.lang.String pageId)
                          throws java.lang.Exception
Throws:
java.lang.Exception

getObject

java.util.Map getObject(java.lang.String token,
                        java.lang.String pageId,
                        java.lang.String className,
                        java.lang.Integer id)
                        throws java.lang.Exception
Throws:
java.lang.Exception

getObject

java.util.Map getObject(java.lang.String token,
                        java.lang.String pageId,
                        java.lang.String guid)
                        throws java.lang.Exception
Throws:
java.lang.Exception

storeObject

java.util.Map storeObject(java.lang.String token,
                          java.util.Map objectMap)
                          throws java.lang.Exception
Throws:
java.lang.Exception

storeObject

java.util.Map storeObject(java.lang.String token,
                          java.util.Map objectMap,
                          boolean checkVersion)
                          throws java.lang.Exception
Throws:
java.lang.Exception

removeObject

java.lang.Boolean removeObject(java.lang.String token,
                               java.lang.String pageId,
                               java.lang.String className,
                               java.lang.Integer id)
                               throws java.lang.Exception
Throws:
java.lang.Exception

search

java.util.List search(java.lang.String token,
                      java.lang.String query,
                      int maxResults)
                      throws java.lang.Exception
Throws:
java.lang.Exception

getModifiedPagesHistory

java.util.List getModifiedPagesHistory(java.lang.String token,
                                       java.util.Date date,
                                       int numberOfResults,
                                       int start,
                                       boolean fromLatest)
                                       throws java.lang.Exception
Throws:
java.lang.Exception
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2004-2011 XWiki. All Rights Reserved.