Overview
The WikiAPI provides a standard Java API to enable reading and writing to a wiki from within a Java Application. The Wiki API currently supports:
- MediaWiki
- MoinMoin Wiki
- TWiki
- Confluence Wiki due August 2007.
The API provides the ability to do the following, no matter which underlying wiki is selected:
- Get Page - Read the content of a Wiki page
- Set Page - Set (write) content to a Wiki page
- Get Page List - Read all pages within a wiki.
- Get Spaces - Read a list of namespaces, or web's within a wiki.
- Connect - Establish/Validate a connection with a wiki.
- Login - Sign-in for authenticated access to the wiki.
Along with the library are various utilities which demonstrate or facilitate its usage. Including a java console app to copy documents from one wiki to another.
Abstracted functionality
The WikiAPI defines a set of functions relevant to all wikis, so the software does not need to concern it self with what brand of wiki you are manipulating. Each plugin implements all or some of the following functionality.getPage( PageName ); setPage( PageName, Content ); getPageList (); getPageList (space); -- Retrieve all pages in a particular namespace/web getSpaces() -- Retrieve a list of all namespaces/webs connect ( URL ); -- Specify the base url and validate it login ( Username, Password ); -- Authenticate to allow page editing (and or viewing)
For full details refer to the class diagram.