cogXWiki Platform - Resource API
TypeJAR
Category
Developed by

XWiki Development Team

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise

Installable with the Extension Manager

Description

A resource in XWiki represents anything that can be accessed through a XWiki URL. For example: Entities, Templates, Skin files, Files on the filesystem.

It can be viewed as a URI or as an abstraction of an XWiki URL.

The following classes/interfaces are available:

  • Resource: represents a Resource. EntityResource represent a resource to an XWiki Entity (document, space, page, wiki, etc).
  • ResourceFactory: A component role type to create a resource out of something. For example the URL module provides a StandardResourceFactory to create a Resource out of an URL.
  • ResourceSerializer: A component role type to convert a Resource into something else. For example the URL module will provide in the future a serialized to convert a Resource into an URL.
  • ResourceManager: Provides a getResource() method to access the current resource being processed (located in the Execution Context).

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.

Dependencies

Dependencies for this extension (org.xwiki.platform:xwiki-platform-resource 5.3-milestone-1):

Tags:
    

Get Connected