Package org.xwiki.url

Offers APIs to convert URLs into XWiki URL objects and vice-versa.

See:
Description

Interface Summary

URLConfiguration	Configuration options for the URL module.
XWikiURL	Represents a XWiki URL.
XWikiURLFactory<T,U extends XWikiURL>	Transforms some representation of an XWiki URL into a XWikiURL instance.
XWikiURLManager	Allow getting the XWikiURL object from the Execution Context.
XWikiURLSerializer<T>	Transforms a XWiki URL instance into some other representation.

Class Summary

AbstractXWikiURL	Base XWikiURL implementation common to all extending classes.
XWikiEntityURL	Represents a XWiki URL pointing to an Entity (Document, Attachment, etc).

Enum Summary

XWikiURLType

Represents a type of XWiki URL (URL to an Entity, URL to a skin file, etc).

Exception Summary

UnsupportedURLException	Means the URL is of a type for which we don't have any parser.
URLCreationException	Means that an error occurred while trying to construct an XWikiURL object.

Package org.xwiki.url Description

Offers APIs to convert URLs into XWiki URL objects and vice-versa.

All XWiki modules should use this API when they need to manipulate URLs and should not manipualte the JDK's URL class. The reasons are:

• reduce bugs: this module is well-tested, handles escaping and encoding properly, and more. It's likely that manipulating URLs by yourself would lead to bugs, especially since there are limitations with the JDK's URL implementation.
• allows plugging different XWiki URL schemes without having to change any other part of the code.

The only places where it's allowed to see the JDK's URL class is in system boundary code, in code accepting an external URL and transforming it into a XWiki URL and in code generating a URL from a XWiki URL for outside processes.