Description of how to use the toolkit and examples

Since this project is mainly aimed at building a general purpose Web Archiving Toolkit these packages do not contain any applications, instead they are intended to be used as building blocks.

Used as a Maven Dependency

If you want to use JWAT from any build environment that supports artifacts the following can be used.

  <dependencies>
    <dependency>
      <groupId>org.jwat</groupId>
      <artifactId>jwat-common</artifactId>
      <version>0.8.1-SNAPSHOT</version>
    </dependency>
    <dependency>
      <groupId>org.jwat</groupId>
      <artifactId>jwat-gzip</artifactId>
      <version>0.8.1-SNAPSHOT</version>
    </dependency>
    <dependency>
      <groupId>org.jwat</groupId>
      <artifactId>jwat-arc</artifactId>
      <version>0.8.1-SNAPSHOT</version>
    </dependency>
    <dependency>
      <groupId>org.jwat</groupId>
      <artifactId>jwat-warc</artifactId>
      <version>0.8.1-SNAPSHOT</version>
    </dependency>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.10</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

Used as jars.

If you want to use the jars by themselves you can just download them and place them in the classpath.

You should be able to find them on the Sonatype Maven Repository. Search for "jwat".

Sequential or Random Access usage:

The WARC reader can be used to read either all the records in a file sequentially or select records in random order.

Both scenarios are supported by the various factory and reader methods.

Compression:

The ARC/WARC factory and reader methods support both compressed and uncompressed files in varying combinations.
Basicly you can create a reader for compressed or uncompressed files, but the factory also includes an auto-detection mechanism which can determine the correct reader on a per file basis.

GZip compression is only supported on ARC/WARC files where each record is compressed individually and concatenated into one file and not the case where the whole ARC/WARC file and all it's records are GZip'ed as a whole. The later mostly because this makes random access to individual record highly ineffective.