KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > snipsnap > xmlrpc > WikiHandler


1 /*
2  * This file is part of "SnipSnap Wiki/Weblog".
3  *
4  * Copyright (c) 2002 Stephan J. Schmidt, Matthias L. Jugel
5  * All Rights Reserved.
6  *
7  * Please visit http://snipsnap.org/ for updates and contact.
8  *
9  * --LICENSE NOTICE--
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23  * --LICENSE NOTICE--
24  */
25
26
27 package org.snipsnap.xmlrpc;
28
29 /**
30  * Handles XML-RPC calls for the Wiki API
31  * http://www.ecyrd.com/JSPWiki/Wiki.jsp?page=WikiRPCInterface
32  *
33  * @author Stephan J. Schmidt
34  * @version $Id: WikiHandler.java 645 2003-01-09 09:49:12Z stephan $
35  */
36
37 public class WikiHandler {
38   /**
39    *
40    * array getRecentChanges( Date timestamp )
41    * int getRPCVersionSupported(): Returns 1 with this version of the JSPWiki API.
42    * base64 getPage( String pagename ): Get the raw Wiki text of page, latest version.
43    * base64 getPageVersion( String pagename, int version ): Get the raw Wiki text of page. Returns UTF-8, expects UTF-8 with URL encoding.
44    * base64 getPageHTML( String pagename ): Return page in rendered HTML. Returns UTF-8, expects UTF-8 with URL encoding.
45    * base64 getPageHTMLVersion( String pagename, int version ): Return page in rendered HTML, UTF-8.
46    * array getAllPages(): Returns a list of all pages. The result is an array of strings, again UTF-8 in URL encoding.
47    * struct getPageInfo( string pagename ) : returns a struct with elements
48    * struct getPageInfoVersion( string pagename, int version ) : returns a struct just like plain getPageInfo(), but this time for a specific version.
49    * array listLinks( string pagename ): Lists all links for a given page. The returned array contains structs, with the following elements:
50    **/
51 }
52
Popular Tags