Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
ExportURLFactoryActionHandler | 37 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package com.xpn.xwiki.web; | |
21 | ||
22 | import java.net.URL; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | import org.xwiki.url.filesystem.FilesystemExportContext; | |
26 | ||
27 | import com.xpn.xwiki.XWikiContext; | |
28 | ||
29 | /** | |
30 | * Allows code to override how to handle creating URLs for specific Entity resource actions. Used by the | |
31 | * {@link com.xpn.xwiki.web.ExportURLFactory} class. | |
32 | * | |
33 | * @version $Id: 524cdd97b331948c6da0e83288f4d7168814df95 $ | |
34 | * @since 6.2RC1 | |
35 | */ | |
36 | @Role | |
37 | public interface ExportURLFactoryActionHandler | |
38 | { | |
39 | /** | |
40 | * @param spaces a serialized space reference which can contain one or several spaces (e.g. "space1.space2"). If | |
41 | * a space name contains a dot (".") it must be passed escaped as in "space1\.with\.dot.space2" | |
42 | * @param name the page name pointed to | |
43 | * @param queryString the optional query string | |
44 | * @param anchor the optional anchor | |
45 | * @param wikiId the wiki id pointed to | |
46 | * @param context the XWiki Context | |
47 | * @param exportContext the Context containing states of the export | |
48 | * @return the URL to generate at export | |
49 | * @throws Exception in case of an error | |
50 | * @since 7.2M1 | |
51 | */ | |
52 | URL createURL(String spaces, String name, String queryString, String anchor, String wikiId, | |
53 | XWikiContext context, FilesystemExportContext exportContext) throws Exception; | |
54 | } |