Wiki source code of Standard URL Format

Version 27.1 by Thomas Mortagne on 2008/12/10

Show last authors
1 1 URLs resolution
2
3 #startfloatingbox()
4 *Content*
5 #toc("" "" "")
6 #endfloatingbox()
7
8 In a single instance of XWiki you have many sections and the URLs need to reflect all that. This documentation details the way URLs are parsed by XWiki and what means each part of it.
9
10 {image:url.png}
11
12 1.1 Protocol
13 By default "http" is used when generating an url in XWiki.
14
15 You can set "secure" parameter to true in a wiki descriptor to generate urls with "https" in place of "http". See [How to edit wiki descriptor>manager:AdminGuide.EditWiki].
16
17 1.1 Host
18 * The first thing XWiki do to find the right wiki the URL is pointing to is by trying to find <tt>wiki1.xwiki.org</tt> in the list of wiki descriptors. Comparing with the content of field <tt>server</tt> in objects of class XWiki.XWikiServerClass
19 * If no descriptor can be found:
20 ** if the host is an IP (127.0.0.1, 85.65.12.36, etc.) XWiki goes to main wiki
21 ** if the first part of the host name (what is before the first point) is "www" XWiki goes to main wiki
22 ** if the first part of the host name match a wiki identifier XWiki goes to this wiki
23
24 To configure the list of domain names alias to access a wiki, you have to go to the wiki's descriptor. See [How to edit wiki descriptor>manager:AdminGuide.EditWiki].
25
26 1.1 Application context (OPTIONAL)
27
28 See [platform:Main.ShortURLs#HApplicationname] for more details on how to remove this part of the url.
29
30 It's what the web container (jetty, tomcat, glassfish, etc.) use to find XWiki in all the web applications it contains. To remove it mainly depends on the possibilities and configuration of your web container.
31
32 1.1 Servlet mapping name (OPTIONAL)
33
34 See [platform:Main.ShortURLs#HServletmappingname] for more details on how to remove this part of the url.
35
36 This is used by the container to call the right servlet.
37
38 It can be:
39 * /bin/: this calls the Struts servlet which will calls the right action for the following part of the URL.
40 * /wiki/wikialias: call the same servlet but will be use to determine the subwiki to access if <tt>xwiki.virtiual.usepath</tt> is enabled in <tt>xwiki.cfg</tt>. Notes that you can change the "wiki" part with anything else using <tt>xwiki.virtual.usepath.servletpath</tt> and by modifying web.xml to reflect the new Struts action name.
41 ** XWiki tries to match a wiki descriptor with the provided <tt>wikialias</tt> like it was a domain name
42 ** then if it can't find any wiki descriptor it search for it with <tt>wikialias</tt> as the wiki name
43 * /xmlrpc/: call xmlrpc servlet. See [platform:Features.XMLRPC] for more details.
44 * /webdav/: call webdav servlet. See [dev:Drafts.WebDAV] for more details.
45
46
47
48 1.1 Struts action (OPTIONAL)
49
50 See [platform:Main.ShortURLs#HStrutsactionname] more more details on how to remove this part of the url.
51
52 When the servlet mapping name is <tt>bin</tt> or the value of <tt>xwiki.virtual.usepath.servletpath</tt>, XWiki use "action" identifiers to determine what is the goal of the user when going to a page.
53
54 For example if the action is "edit", XWiki will print an editor the user use to modify a page content but if the "view" action is used XWiki will execute the page content to print/render the content.
55
56 1.1 Space
57 All wiki pages are located in what is called a "space". XWiki support only one level of space but you can indicate a "parent space" for a space.
58
59 See [platform:Features.Spaces] for more details about spaces.
60
61 1.1 Page
62 The page is what contains wiki contents and objects/classes and attachments.
63
64 1.1 Attachment
65 This part indicate the attachment you want to download from a particular page.
66
67 See [platform:Features.Attachments] for more details about attachments.
68 1.1 Query string
69 Actions can use URL parameters to modify there action depending of there value.
70
71 For example you can make a velocity script that print the content of this value with:
72 {code}
73 The value of the parameter is: $request.param1
74 {code}
75 if you have a parameter "param1=Hello World" the result will be
76 {code}
77 The value of the parameter is: Hello World
78 {code}
79
80 See [platform:DevGuide.Scripting] for more details about scripting.

Get Connected