org.apache.clerezza.tools.offline

Class Generator

java.lang.Object

org.apache.clerezza.tools.offline.Generator

@Service(value=java.lang.Object.class)
@Property(name="javax.ws.rs",
          boolValue=true)
public class Generator
extends Object

This JAX-RS resource provides a method to retrieve a zip file containing an offline version of a site served by the clerezza instance

Author:

reto

Constructor Summary

Constructors

Constructor and Description
Generator()

Method Summary

Methods

Modifier and Type

Method and Description

javax.ws.rs.core.Response

download(String baseUri, String targetUri, String rootLinkPrefix, List<String> formatExtensions) The service takes the following argumens: - 1 base-uri: for all resources with a URI starting with this Uri creation of the specified target fomats is attempted - 1 target-uri: where base-uri appears in the representations it is replaces with target-uri - 0 or 1 root link prefix: prefix to be prepended to links with Uri reference starting with a slash - 1 - n target formats: the file- extensions represing the different formats to be produced, the extensions are added to the generated files where the file would not otherwise end with the extension.

Methods inherited from class java.lang.Object

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

Constructor Detail

Generator

public Generator()

Method Detail

download

public javax.ws.rs.core.Response download(String baseUri,
                                 String targetUri,
                                 String rootLinkPrefix,
                                 List<String> formatExtensions)
                                   throws IOException

The service takes the following argumens: - 1 base-uri: for all resources with a URI starting with this Uri creation of the specified target fomats is attempted - 1 target-uri: where base-uri appears in the representations it is replaces with target-uri - 0 or 1 root link prefix: prefix to be prepended to links with Uri reference starting with a slash - 1 - n target formats: the file- extensions represing the different formats to be produced, the extensions are added to the generated files where the file would not otherwise end with the extension. The service generates a zip containing a directory structure matching the subpaths from base-uri, the directories contains files for the individual representations, URIs ending with / are matched to a file called "index"+format extension within the respective directory.

Returns:

a zipped file

Throws:

IOException