Package com.xpn.xwiki.web

Interface ExportURLFactoryActionHandler

@Role
public interface ExportURLFactoryActionHandler

Allows code to override how to handle creating URLs for specific Entity resource actions. Used by the ExportURLFactory class.

Since:

6.2RC1

Version:

$Id: 524cdd97b331948c6da0e83288f4d7168814df95 $

Method Summary

Modifier and Type	Method	Description
URL	createURL(String spaces, String name, String queryString, String anchor, String wikiId, XWikiContext context, FilesystemExportContext exportContext)

Method Detail

createURL

URL createURL(String spaces,
              String name,
              String queryString,
              String anchor,
              String wikiId,
              XWikiContext context,
              FilesystemExportContext exportContext)
       throws Exception

Parameters:

spaces - a serialized space reference which can contain one or several spaces (e.g. "space1.space2"). If a space name contains a dot (".") it must be passed escaped as in "space1\.with\.dot.space2"

name - the page name pointed to

queryString - the optional query string

anchor - the optional anchor

wikiId - the wiki id pointed to

context - the XWiki Context

exportContext - the Context containing states of the export

Returns:

the URL to generate at export

Throws:

Exception - in case of an error

Since:

7.2M1