cogAccess content of archives (Zip, Tar, Jar, GZip, etc)
Developed by

XWiki Development Team

Active Installs1
0 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager


Prior to version 7.4.6, 8.3 and 8.4RC1, there was an issue with authorization.

This API replaces the Zip Explorer Plugin. It's both more generic and uses the XWiki Component Architecture.

See also the VFS Tree Macro.


  • Generate an XWiki URL for accessing the content of a file located inside an archive attached to a wiki page. Examples:

    From Velocity:

    ## Get the URL to access the content of a file inside a zip:
    [[link to file in zip>>path:$services.vfs.url("attach:[email protected]/test.txt")]]

    ## Display inline an image from a zip attached to a wiki page:
    [[image:path:$services.vfs.url("attach:[email protected]/test.png")||width="100px"]]

    From Java:

    import org.xwiki.vfs.*;

    private VfsManager vfsManager;
    vfsManager.getURL(new VfsResourceReference(URI.create("attach:wiki:[email protected]"), "path/to/file"));
  • Access any supported VFS through the NIO2 API. See also the NIO Tool. Examples:

    From Velocity:

    ## Read the content of a file inside a zip attached to a page:
    Content of test.txt inside
    $stringtool.toString($niotool.readAllBytes("attach:[email protected]/test.txt"), "utf-8")

    ## List all entries inside a zip attached to a page:
    Content of
    #set ($dirStream = $niotool.newDirectoryStream("attach:[email protected]/"))
    #foreach ($entry in $dirStream)
      * {{{$entry}}} - $niotool.isDirectory($entry)

When executed the previous Velocity examples give:


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.

This extension must be installed on the Farm or it won't work (the VFS Type Resolver need to be found in the Root Extension Manager).


Dependencies for this extension (org.xwiki.platform:xwiki-platform-vfs-api 8.2.1):

  • org.xwiki.platform:xwiki-platform-resource-api 8.2.1
  • org.xwiki.platform:xwiki-platform-url-api 8.2.1
  • org.xwiki.platform:xwiki-platform-oldcore 8.2.1
  • org.xwiki.commons:xwiki-commons-script 8.2.1
  • 0.11.0
  • 0.11.0
  • 0.11.0
  • 0.11.0
  • 2.5.0
  • 0.11.0
  • 0.11.0
  • 0.11.0
  • 0.11.0
  • 0.11.0
  • 0.11.0
  • 0.11.0
  • 2.5.0

Get Connected