org.benow.web.wiki
Interface WikiService

All Superinterfaces:

org.benow.java.spec.Markup, org.benow.service.Service

All Known Implementing Classes:

WikiServiceImpl

public interface WikiService
extends org.benow.service.Service

Nested Class Summary

Nested classes/interfaces inherited from interface org.benow.java.spec.Markup

org.benow.java.spec.Markup.ParamName, org.benow.java.spec.Markup.ReturnDescription

Method Summary

WikiIndex	getIndex(java.lang.String path)
Sheet	getSheet(java.lang.String name)
java.io.InputStream	getSheetBody(java.lang.String name)
java.util.List<java.lang.String>	getSheetNames()
Sheet	getSheetQuiet(java.lang.String name)
void	mkdir(java.lang.String name)
java.util.List<java.lang.String>	searchWikis(java.lang.String terms)
void	updateWiki(java.lang.String name, java.lang.String body, java.lang.String permission)

Method Detail

getSheetNames

java.util.List<java.lang.String> getSheetNames()

getIndex

WikiIndex getIndex(java.lang.String path)
                   throws java.io.FileNotFoundException,
                          java.lang.SecurityException,
                          java.io.IOException

Parameters:

path -

Returns:

Throws:

java.io.FileNotFoundException - if path is not in wiki root

java.lang.SecurityException - if access denied to listing

java.io.IOException - if other error during read

searchWikis

java.util.List<java.lang.String> searchWikis(java.lang.String terms)

getSheet

Sheet getSheet(java.lang.String name)
               throws java.io.IOException,
                      RedirectException

Throws:

java.io.IOException

RedirectException

getSheetBody

java.io.InputStream getSheetBody(java.lang.String name)

getSheetQuiet

Sheet getSheetQuiet(java.lang.String name)

updateWiki

void updateWiki(java.lang.String name,
                java.lang.String body,
                java.lang.String permission)
                throws java.io.IOException

Throws:

java.io.IOException

mkdir

void mkdir(java.lang.String name)
           throws java.io.IOException,
                  RedirectException

Throws:

java.io.IOException

RedirectException