edu.harvard.hul.ois.jhove.module

Class GzipModule

java.lang.Object

edu.harvard.hul.ois.jhove.ModuleBase

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

All Implemented Interfaces:

Module

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

Field Summary

Fields inherited from class edu.harvard.hul.ois.jhove.ModuleBase

_app, _bigEndian, _checksumFinished, _countStream, _coverage, _crc32, _date, _defaultParams, _features, _format, _init, _isRandomAccess, _je, _logger, _md5, _mimeType, _name, _nByte, _note, _param, _release, _repInfoNote, _rights, _sha1, _signature, _specification, _validityNote, _vendor, _verbosity, _wellFormedNote

Fields inherited from interface edu.harvard.hul.ois.jhove.Module

MAXIMUM_VERBOSITY, MINIMUM_VERBOSITY

Constructor Summary

Constructors

Constructor and Description
GzipModule() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkSignatures(File file, InputStream stream, RepInfo info)
void	checkSignatures(File file, RandomAccessFile raf, RepInfo info)
int	parse(InputStream stream, RepInfo info, int parseIndex)
void	parse(RandomAccessFile file, RepInfo info)
protected void	parseRecords(org.jwat.gzip.GzipReader reader) Parses GZIP entries.
protected void	processEntry(org.jwat.gzip.GzipEntry entry) Processes a GZIP entry.
void	resetParams() Resets parameter settings.

Methods inherited from class edu.harvard.hul.ois.jhove.ModuleBase

addIntegerProperty, addIntegerProperty, applyDefaultParams, calcRAChecksum, getApp, getBase, getBufferedDataStream, getCoverage, getCRC32, getDate, getDefaultParams, getFeatures, getFormat, getMimeType, getName, getNByte, getNote, getRelease, getRepInfoNote, getRights, getSignature, getSpecification, getValidityNote, getVendor, getWellFormedNote, hasFeature, init, initFeatures, initParse, isBigEndian, isRandomAccess, param, readByteBuf, readDouble, readDouble, readDouble, readFloat, readFloat, readSignedByte, readSignedByte, readSignedByte, readSignedInt, readSignedInt, readSignedInt, readSignedLong, readSignedRational, readSignedRational, readSignedShort, readSignedShort, readSignedShort, readUnsignedByte, readUnsignedByte, readUnsignedByte, readUnsignedInt, readUnsignedInt, readUnsignedInt, readUnsignedRational, readUnsignedRational, readUnsignedRational, readUnsignedShort, readUnsignedShort, readUnsignedShort, setApp, setBase, setChecksums, setCRC32, setDefaultParams, setMD5, setNByte, setSHA1, setValidityNote, setVerbosity, show, skipBytes, skipBytes, vectorToPropArray

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

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

Specified by:

resetParams in interface Module

Overrides:

resetParams in class ModuleBase

Throws:

Exception

checkSignatures

public void checkSignatures(File file,
                   InputStream stream,
                   RepInfo info)
                     throws IOException

Specified by:

checkSignatures in interface Module

Overrides:

checkSignatures in class ModuleBase

Throws:

IOException

checkSignatures

public void checkSignatures(File file,
                   RandomAccessFile raf,
                   RepInfo info)
                     throws IOException

Specified by:

checkSignatures in interface Module

Overrides:

checkSignatures in class ModuleBase

Throws:

IOException

parse

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

Specified by:

parse in interface Module

Overrides:

parse in class ModuleBase

Throws:

IOException

parse

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

Specified by:

parse in interface Module

Overrides:

parse in class ModuleBase

Throws:

IOException

parseRecords

protected void parseRecords(org.jwat.gzip.GzipReader reader)
                     throws EOFException,
                            IOException,
                            JhoveException

Parses 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

JhoveException - if a serious problem needs to be reported

processEntry

protected void processEntry(org.jwat.gzip.GzipEntry entry)
                     throws EOFException,
                            IOException,
                            JhoveException

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

Parameters:

entry - GZIP 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