org.xwiki.vfs.script

Class VfsScriptService

java.lang.Object

org.xwiki.vfs.script.VfsScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
 @Named(value="vfs")
 @Singleton
public class VfsScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Offers scripting APIs for the VFS module.

Since:

7.4M2

Version:

$Id: e986ffb45ffd8b62fef3a27a7da4aa9c92a7afa3 $

Constructor Summary

Constructors

Constructor and Description
VfsScriptService()

Method Summary

Modifier and Type	Method and Description
String	url(VfsResourceReference reference) Generate a relative VFS URL to access a resource inside an archive.
String	url(VfsResourceReference reference, String contentType) Generate a relative VFS URL to access a resource inside an archive.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VfsScriptService

public VfsScriptService()

Method Detail

url

public String url(VfsResourceReference reference)

Generate a relative VFS URL to access a resource inside an archive.

Parameters:

reference - the reference to a file inside a an archive. For example attach:space.page@my.zip/path/to/file.

Returns:

a relative URL that can be used to access the content of a file inside an archive (ZIP, EAR, TAR.GZ, etc) or null if the URL couldn't be constructed

url

@Unstable
public String url(VfsResourceReference reference,
                            String contentType)

Generate a relative VFS URL to access a resource inside an archive.

Parameters:

reference - the reference to a file inside a an archive. For example attach:space.page@my.zip/path/to/file.

contentType - the Content-Type to return with the response

Returns:

a relative URL that can be used to access the content of a file inside an archive (ZIP, EAR, TAR.GZ, etc) or null if the URL couldn't be constructed

Since:

12.3RC1