edu.harvard.hul.ois.jhove.module

Class GzipModule

java.lang.Object

ModuleBase

edu.harvard.hul.ois.jhove.module.GzipModule

public class GzipModule
extends ModuleBase

JHOVE module for identifying, validating and characterizing GZIP files. Ported from the JHOVE2 GZIP module, created by lbihanic, selghissassi, nicl JHOVE2 GZip module. This module parses and validates GZip files in compliance with RFC 1952 (GZIP file format specification version 4.3) and supports multiple member GZIP files.

This is a non-recursive validation. It only validates the GZIP file format, not the actual content within the WARC records.

Author:

jolf@kb.dk

Constructor Summary

Constructors

Constructor and Description
GzipModule() Constructor.

Method Summary

Modifier and Type	Method and Description
int	parse(InputStream stream, RepInfo info, int parseIndex)
void	parse(RandomAccessFile file, RepInfo info)
protected void	parseRecords(GzipReader reader) Parse GZIP entries.
protected void	processEntry(GzipEntry entry) Process a GZIP entry.
void	resetParams() Reset parameter settings.

Methods inherited from class java.lang.Object

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

Constructor Detail

GzipModule

public GzipModule()

Constructor.

Method Detail

resetParams

public void resetParams()
                 throws Exception

Reset parameter settings. Returns to a default state without any parameters.

Throws:

Exception

parse

public void parse(RandomAccessFile file,
                  RepInfo info)
           throws IOException

Throws:

IOException

parse

public int parse(InputStream stream,
                 RepInfo info,
                 int parseIndex)
          throws IOException

Throws:

IOException

parseRecords

protected void parseRecords(GzipReader reader)
                     throws EOFException,
                            IOException,
                            JhoveException

Parse GZIP entries. Parsing should be straight forward with all records accessible through the same source.

Parameters:

reader - GZIP reader used to parse records

Throws:

EOFException - if EOF occurs prematurely

IOException - if an IO error occurs while processing

JHOVE2Exception - if a serious problem needs to be reported

JhoveException

processEntry

protected void processEntry(GzipEntry entry)
                     throws EOFException,
                            IOException,
                            JhoveException

Process a GZIP entry. Extracts all the properties of the entry into a map, and puts this map on the list.

Parameters:

entry - ZGIP entry from GZIP reader

Throws:

EOFException - if EOF occurs prematurely

IOException - if an IO error occurs while processing

JhoveException - if a serious problem needs to be reported