org.xwiki.rendering.internal.parser.xwiki20
Class XWiki20LinkReferenceParser

java.lang.Object
  org.xwiki.rendering.internal.parser.reference.GenericLinkReferenceParser
      org.xwiki.rendering.internal.parser.xwiki20.XWiki20LinkReferenceParser

All Implemented Interfaces:

ResourceReferenceParser

@Component
@Named(value="xwiki/2.0/link")
@Singleton
public class XWiki20LinkReferenceParser
extends GenericLinkReferenceParser

Parses the content of XWiki 2.0 resource references. The supported generic format is as follows: (link)(@interWikiAlias)?, where:

• link: The full link reference using the following syntax: (reference)(#anchor)?(?queryString)?, where:
  • reference: The link reference. This can be either a URI in the form protocol:path (example: "http://xwiki.org", "mailto:john@smith.com) or a wiki page name (example: "wiki:Space.WebHome"). Note that in the case of a wiki page name the character "\" is used as the escape character (for example if you wish to have "#" or "?" in your page name you'll need to write "\#" and "\?").
  • anchor: An optional anchor name pointing to an anchor defined in the referenced link. Note that in XWiki anchors are automatically created for titles. Example: "TableOfContentAnchor".
  • queryString: An optional query string for specifying parameters that will be used in the rendered URL. Example: "mydata1=5&mydata2=Hello".
  The link element is mandatory.
• interWikiAlias: An optional Inter Wiki alias as defined in the InterWiki Map. Example: "wikipedia"

Examples of valid wiki links:

• Hello World
• http://myserver.com/HelloWorld
• HelloWorld#Anchor
• Hello World@Wikipedia
• mywiki:HelloWorld
• Hello World?param1=1¶m2=2

Note that allowed URIs are URLs of the form http://, mailto:, image: and attach:.

Since:

2.5RC1

Version:

$Id$

Field Summary

static java.util.List<java.lang.String>

URI_PREFIXES The list of recognized URL prefixes.

Fields inherited from class org.xwiki.rendering.internal.parser.reference.GenericLinkReferenceParser

ESCAPE_CHAR, SEPARATOR_ANCHOR, SEPARATOR_INTERWIKI, SEPARATOR_QUERYSTRING

Constructor Summary

XWiki20LinkReferenceParser()

Method Summary

protected java.util.List<java.lang.String>

getAllowedURIPrefixes()

Methods inherited from class org.xwiki.rendering.internal.parser.reference.GenericLinkReferenceParser

parse, parseElementAfterString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

URI_PREFIXES

public static final java.util.List<java.lang.String> URI_PREFIXES

The list of recognized URL prefixes.

Constructor Detail

XWiki20LinkReferenceParser

public XWiki20LinkReferenceParser()

Method Detail

getAllowedURIPrefixes

protected java.util.List<java.lang.String> getAllowedURIPrefixes()

Overrides:

getAllowedURIPrefixes in class GenericLinkReferenceParser

Returns:

the list of URI prefixes the link parser recognizes