Package org.jnetstream.capture.file

A capture file manipulation package.

See:
Description

Interface Summary

BlockRecord	A block record also sometimes refered to a file header in a capture file which uniquely identifies the file as certain type with a magic pattern or magic number.
DataRecord	Data record is a record in a capture file that belongs to one block record, a parent/child relationship, and contains some kind of data.
FileIndexer<G,S,R>	Provides indexing services to file based captures.
FileIterator<G,S,R>	An iterator that allows iteration over elements contained in a capture file.
FileModifier<S,R>	Interface which allows modifications on the underlying storage using a generic interface.
FileOptions	Various options for the capture file.
FilePacketFactory<T extends FilePacket>	A factory for file based packets.
Files.Factory	Factory interface that actually does all the work.
HeaderReader
IndexedFileModifier<S,R>	Interface which allows modifications on the underlying storage using a generic interface.
RawIndexer	An iterator that allows iteration over elements contained in a capture file.
RawIterator	An iterator that allows iteration over elements contained in a capture file.
Record	A record within a capture file.
Record.RecordHeaderField
RecordFilterTarget	Empty interface that has the additional requirement that the target be a record related entity.
RecordIndexer<T extends Record>	An indexer that allows direct access to records contained in a capture file.
RecordIterator<T extends Record>	An iterator that allows iteration over records contained in a capture file.
SeekPattern
TypeReader

Class Summary

FileCaptureInputStream
Files	Factory methods for working with the jNetStream packet package and individual packets.
RecordError	Holds any errors that have been encountered with any of the records within a capture file.

Enum Summary

FileOptions.FileProperty	Various properties that can be applied to capture files.
FileOptions.MemoryModel	Options for changing the memory model used by the implementation.
PacketCounterModel	Defines different types of models, or algorithms that can be used to count packets in a capture file.
RecordType	Generic record types found within capture files.

Exception Summary

BufferException
BufferFetchException

Package org.jnetstream.capture.file Description

A capture file manipulation package. There a number of capture file formats that are used to store captured packets inside a file. This package allows detailed access and traversal of the structure of each of these files.

The package provides a base set of interfaces for accessing the detailed structure of a capture file, further detail with supplied interfaces is supplied with the file definition itself in jnetpcap.file.type package. At this level within the API, some amount of knowledge about the file structure is needed. The amount is detail required is still small compared to the actual complexity of some of the file formats. The section below describes the abstracted representation of the capture file structure used by this package.

Representation of capture file structure

The structure of each capture file, as presented by this package is as follows:

• A capture file may contain 1 or more BlockRecords, sometimes also referred to as "file header". The BlockRecord usually contains information about the block such as unique ID field called the "Magic Pattern" or "Magic Number", block version information and some other meta information. For example Pcap and Snoop files contain only a single BlockRecord, but Nap file type usually contains more than one.
• A BlockRecord contains 0 or more DataRecords. BlockRecord is not of type DataRecord and thus may not be contained within another BlockRecord. The most common type of DataRecord is a PacketRecord, but other types exist as well for other formats.