Filter XML module

Last modified by Admin on 2024/04/25 16:20

cogFilter stream extension to read and write any filter event as XML
Developed by

XWiki Development Team

0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard

Installable with the Extension Manager


This module introduce a generic XML based syntax to write (and read) and filter event as XML. The first need was unit test for other syntaxes but it can be used internally as a serialization format for filter events.

The syntax identifier is filter+xml. It does not contain any version because its structure is not meant to be stable over time which mean it should be written and read with the same version of the module.

Here is an example:

 <wiki name="wiki">
   <wikiSpace name="space">
     <wikiDocument name="page">
           <wikiObject name="[0]">
               <wikiClassProperty name="prop1" type="com.xpn.xwiki.objects.classes.NumberClass">
                 <wikiClassPropertyField name="disabled" value="0"></wikiClassPropertyField>
                 <wikiClassPropertyField name="name" value="prop1"></wikiClassPropertyField>
                 <wikiClassPropertyField name="number" value="1"></wikiClassPropertyField>
                 <wikiClassPropertyField name="numberType" value="long"></wikiClassPropertyField>
                 <wikiClassPropertyField name="prettyName" value="Prop1"></wikiClassPropertyField>
                 <wikiClassPropertyField name="size" value="30"></wikiClassPropertyField>
                 <wikiClassPropertyField name="unmodifiable" value="0"></wikiClassPropertyField>
             <wikiObjectProperty name="prop1" value="1"/>
             <wikiObjectProperty name="unexisting" value="value"/>

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 for this extension (org.xwiki.commons:xwiki-commons-filter-stream-xml 16.2.0):

  • org.xwiki.commons:xwiki-commons-filter-xml 16.2.0

Get Connected