Package org.xwiki.rest.resources.wikis

Interface WikiResource

public interface WikiResource

Resource for interacting with a specific wiki.

Version:

$Id: 3c3f588147b9a0cc376ffb72872950085ee6084b $

Method Summary

Modifier and Type	Method	Description
Wiki	get(String wikiName)	Get information about a wiki.
Wiki	importXAR(String wikiName, Boolean backup, String history, InputStream is)	Import a XAR into a given wiki.

Method Detail

get

Wiki get(String wikiName)
  throws XWikiRestException

Get information about a wiki.

Parameters:

wikiName - the wiki name.

Returns:

information about the wiki.

Throws:

XWikiRestException - if something goes wrong.

importXAR

Wiki importXAR(String wikiName,
               Boolean backup,
               String history,
               InputStream is)
        throws XWikiRestException

Import a XAR into a given wiki.

Parameters:

wikiName - the wiki name.

backup - whether this is a backup pack.

history - how to manage page version when importing pages.

is - the input stream containing XAR data (POSTed by the client)

Returns:

the information about the wiki.

Throws:

XWikiRestException - if there was an error during import.