public class FileSystemURLFactory extends XWikiServletURLFactory
file:// links, and not as http:// links.contextPath, daemon, defaultURL, defaultURLs, originalURL| Constructor and Description |
|---|
FileSystemURLFactory() |
| Modifier and Type | Method and Description |
|---|---|
URL |
createAttachmentRevisionURL(String filename,
String spaces,
String name,
String revision,
String wiki,
XWikiContext context) |
URL |
createAttachmentURL(String filename,
String spaces,
String name,
String action,
String querystring,
String wiki,
XWikiContext context) |
URL |
createResourceURL(String filename,
boolean forceSkinAction,
XWikiContext context)
Create an URL for the file resource.
|
URL |
createSkinURL(String filename,
String skin,
XWikiContext context)
Create a skin URL for the given filename and skin directory.
|
String |
getURL(URL url,
XWikiContext context)
Converts a URL to a relative URL if it's a XWiki URL (keeping only the path + query string + anchor) and leave
the URL unchanged if it's an external URL.
|
addFileName, addFileName, createAttachmentRevisionURL, createAttachmentRevisionURL, createExternalURL, createResourceURL, createSkinURL, createSkinURL, createTemplateURL, createURL, createURL, findAttachmentForDocRevision, findDeletedAttachmentForDocRevision, getContextPath, getDefaultURL, getRequestURL, getServerURL, getServerURL, init, isContextDoc, normalizeURL, normalizeURL, setDefaultURLcreateAttachmentRevisionURL, createAttachmentURL, createExternalURL, createSkinURL, createSkinURL, createSkinURL, createURL, createURL, createURLpublic URL createAttachmentURL(String filename, String spaces, String name, String action, String querystring, String wiki, XWikiContext context)
createAttachmentURL in interface XWikiURLFactorycreateAttachmentURL in class XWikiServletURLFactoryspaces - 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"querystring - the URL-encoded Query String. It's important to realize that the implementation of this
method cannot encode it automatically since the Query String is passed as a String (and it's not possible
to differentiate between a '=' character that should be encoded and one that shouldn't. Imagine an input
of 'a=&b=c' which can be understood either as 'a' = '&b=c' or as 'a' = '' and 'b' = 'c'). Ideally
we would need an API signature that accepts a Map<String, String> for the Query String, for
examplepublic URL createAttachmentRevisionURL(String filename, String spaces, String name, String revision, String wiki, XWikiContext context)
createAttachmentRevisionURL in interface XWikiURLFactorycreateAttachmentRevisionURL in class XWikiDefaultURLFactoryspaces - 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"wiki - the URL-encoded Query String. It's important to realize that the implementation of this
method cannot encode it automatically since the Query String is passed as a String (and it's not possible
to differentiate between a '=' character that should be encoded and one that shouldn't. Imagine an input
of 'a=&b=c' which can be understood either as 'a' = '&b=c' or as 'a' = '' and 'b' = 'c'). Ideally
we would need an API signature that accepts a Map<String, String> for the Query String, for
examplepublic URL createSkinURL(String filename, String skin, XWikiContext context)
XWikiURLFactorycreateSkinURL in interface XWikiURLFactorycreateSkinURL in class XWikiDefaultURLFactoryfilename - the file to reach.skin - the skin where the file should be loadedcontext - current contextpublic URL createResourceURL(String filename, boolean forceSkinAction, XWikiContext context)
XWikiURLFactorycreateResourceURL in interface XWikiURLFactorycreateResourceURL in class XWikiDefaultURLFactoryfilename - the path of the file to load.forceSkinAction - if true specify the skin directory in the URL.context - the current context.public String getURL(URL url, XWikiContext context)
XWikiServletURLFactoryAn URL is considered to be external if its server component doesn't match the server of the current request URL. This means that URLs are made relative with respect to the current request URL rather than the current wiki set on the XWiki context. Let's take an example:
request URL: http://playground.xwiki.org/xwiki/bin/view/Sandbox/TestURL
current wiki: code (code.xwiki.org)
URL (1): http://code.xwiki.org/xwiki/bin/view/Main/WebHome
URL (2): http://playground.xwiki.org/xwiki/bin/view/Spage/Page
The result will be:
(1) http://code.xwiki.org/xwiki/bin/view/Main/WebHome
(2) /xwiki/bin/view/Spage/Page
getURL in interface XWikiURLFactorygetURL in class XWikiServletURLFactoryurl - the URL to convertXWikiDefaultURLFactory.getURL(java.net.URL, com.xpn.xwiki.XWikiContext)Copyright © 2004–2021 XWiki. All rights reserved.