public interface XWikiURLFactory
Modifier and Type | Method and Description |
---|---|
URL |
createAttachmentRevisionURL(String filename,
String spaces,
String name,
String revision,
String querystring,
String xwikidb,
XWikiContext context) |
URL |
createAttachmentRevisionURL(String filename,
String spaces,
String name,
String revision,
String querystring,
XWikiContext context) |
URL |
createAttachmentURL(String filename,
String spaces,
String name,
String action,
String querystring,
String xwikidb,
XWikiContext context) |
URL |
createAttachmentURL(String filename,
String spaces,
String name,
String action,
String querystring,
XWikiContext context) |
URL |
createExternalURL(String spaces,
String name,
String action,
String querystring,
String anchor,
String xwikidb,
XWikiContext context) |
URL |
createExternalURL(String spaces,
String name,
String action,
String querystring,
String anchor,
XWikiContext context) |
URL |
createResourceURL(String filename,
boolean forceSkinAction,
XWikiContext context) |
URL |
createSkinURL(String filename,
String spaces,
String name,
String xwikidb,
XWikiContext context) |
URL |
createSkinURL(String filename,
String spaces,
String name,
XWikiContext context) |
URL |
createSkinURL(String filename,
String skin,
XWikiContext context) |
URL |
createURL(String spaces,
String name,
String action,
boolean redirect,
XWikiContext context) |
URL |
createURL(String spaces,
String name,
String action,
String querystring,
String anchor,
String xwikidb,
XWikiContext context) |
URL |
createURL(String spaces,
String name,
String action,
String querystring,
String anchor,
XWikiContext context) |
URL |
createURL(String spaces,
String name,
String action,
XWikiContext context) |
URL |
createURL(String spaces,
String name,
XWikiContext context) |
URL |
getRequestURL(XWikiContext context) |
URL |
getServerURL(XWikiContext context)
Generate the base external URL to access this server.
|
String |
getURL(URL url,
XWikiContext context)
Converts a URL to a string representation.
|
void |
init(XWikiContext context) |
void init(XWikiContext context)
URL createURL(String spaces, String name, XWikiContext context)
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"URL createURL(String spaces, String name, String action, XWikiContext context)
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"URL createURL(String spaces, String name, String action, boolean redirect, XWikiContext context)
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"URL createURL(String spaces, String name, String action, String querystring, String anchor, XWikiContext context)
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"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
exampleURL createExternalURL(String spaces, String name, String action, String querystring, String anchor, XWikiContext context)
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"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
exampleURL createURL(String spaces, String name, String action, String querystring, String anchor, String xwikidb, XWikiContext context)
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"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
exampleURL createExternalURL(String spaces, String name, String action, String querystring, String anchor, String xwikidb, XWikiContext context)
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"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
exampleURL createSkinURL(String filename, String skin, XWikiContext context)
URL createSkinURL(String filename, String spaces, String name, XWikiContext context)
URL createSkinURL(String filename, String spaces, String name, String xwikidb, XWikiContext context)
URL createResourceURL(String filename, boolean forceSkinAction, XWikiContext context)
URL createAttachmentURL(String filename, String spaces, String name, String action, String querystring, XWikiContext context)
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"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
exampleURL createAttachmentURL(String filename, String spaces, String name, String action, String querystring, String xwikidb, XWikiContext context)
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"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
exampleURL createAttachmentRevisionURL(String filename, String spaces, String name, String revision, String querystring, XWikiContext context)
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"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
exampleURL createAttachmentRevisionURL(String filename, String spaces, String name, String revision, String querystring, String xwikidb, XWikiContext context)
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"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
exampleURL getRequestURL(XWikiContext context)
String getURL(URL url, XWikiContext context)
url
- the URL to convertURL getServerURL(XWikiContext context) throws MalformedURLException
context
- the XWiki context.MalformedURLException
- error when creating the URL
.Copyright © 2004–2017 XWiki. All rights reserved.