Extract data from the current XWiki instance

Description

This module provide input and output XWiki instance modules. In practice you can use those to read/write in a running XWiki instance.

The syntax id of both the OutputFilterStream and the InputFilterStream is xwiki+instance.

Input Filter Stream

What is used when the goal is to "export" data from a running XWiki instance.

Extend it

It's possible to extend it with custom extensions to handle custom data (for example data not stored in document or not in a generic way). Any implementation of org.xwiki.filter.instance.input.InstanceInputEventGenerator will be called by the top level Instance Input Filter before and and after each wiki, space, document model elements.

Existing custom Instance Input Event Generators:

• documents: generate standard model related events for XWiki documents

Output Filter Stream

What is used when the goal is to "import" data into a running XWiki instance.

The Filter indicates the target syntax in the RenderingContext during document content parsing.

Extend it

Any component can provide an extensions to handle custom data (for example data not stored in document or not in a generic way). Any implementation of org.xwiki.filter.instance.output.OutputInstanceFilterStreamFactory will automatically receive events sent to the top level Instance Output Filter.

Existing custom Output Instance Filters:

• xwiki+instance+document: generate XWiki documents from standard model related events
  • listen to the following events filters: all model related filters, org.xwiki.rendering.listener.Listener
• xwiki+instance+extension: register extensions
  • listen to the following events filters: org.xwiki.filter.event.extension.ExtensionFilter
• xwiki+instance+users: create XWiki users and groups
  • listen to the following events filters: org.xwiki.filter.event.user.UserFilter, org.xwiki.filter.event.user.GroupFilter, org.xwiki.filter.event.model.WikiFilter

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-filter-instance-api 16.3.1):

• org.xwiki.commons:xwiki-commons-filter-api 16.3.1
• org.xwiki.platform:xwiki-platform-filter-event-model 16.3.1
• org.xwiki.platform:xwiki-platform-model-api 16.3.1