ArchiveRecord (webarchive-commons 1.1.9 API)

java.lang.Object
- java.io.InputStream
- - org.archive.io.ArchiveRecord

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

ARCRecord, HeaderedArchiveRecord, WARCRecord
```
public abstract class ArchiveRecord
extends java.io.InputStream
```
Archive file Record.

Version:

$Date$ $Version$

Author:

stack

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.security.MessageDigest`	`digest` Compute digest on what we read and add to metadata when done.
`protected boolean`	`eor` Set flag when we've reached the end-of-record.
`protected ArchiveRecordHeader`	`header`
`protected java.io.InputStream`	`in` Stream to read this record from.
`protected static long`	`MIN_HTTP_HEADER_LENGTH` Minimal http response or request header length.
`protected long`	`position` Position w/i the Record content, within `in`.
`protected boolean`	`strict`

Constructor Summary

Constructors
Constructor and Description
`ArchiveRecord(java.io.InputStream in)` Constructor.
`ArchiveRecord(java.io.InputStream in, ArchiveRecordHeader header)` Constructor.
`ArchiveRecord(java.io.InputStream in, ArchiveRecordHeader header, int bodyOffset, boolean digest, boolean strict)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`available()` This available is not the stream's available.
`void`	`close()` Calling close on a record skips us past this record to the next record in the stream.
`void`	`dump()` Writes output on STDOUT.
`void`	`dump(java.io.OutputStream os)` Writes output on passed `os`.
`protected java.lang.String`	`getDigest4Cdx(ArchiveRecordHeader h)`
`java.lang.String`	`getDigestStr()`
`ArchiveRecordHeader`	`getHeader()`
`protected java.io.InputStream`	`getIn()`
`protected java.lang.String`	`getIp4Cdx(ArchiveRecordHeader h)`
`protected java.lang.String`	`getMimetype4Cdx(ArchiveRecordHeader h)`
`long`	`getPosition()`
`protected java.lang.String`	`getStatusCode4Cdx(ArchiveRecordHeader h)`
`boolean`	`hasContentHeaders()` Is it likely that this record contains headers? This method will return true if the body is a http response that includes http response headers or the body is a http request that includes request headers, etc.
`protected void`	`incrementPosition()`
`protected void`	`incrementPosition(long incr)`
`protected boolean`	`isEor()`
`boolean`	`isStrict()`
`boolean`	`markSupported()`
`protected java.lang.String`	`outputCdx(java.lang.String strippedFileName)`
`int`	`read()`
`int`	`read(byte[] b, int offset, int length)`
`protected void`	`setBodyOffset(int bodyOffset)`
`protected void`	`setEor(boolean eor)`
`protected void`	`setHeader(ArchiveRecordHeader header)`
`void`	`setStrict(boolean strict)`
`protected void`	`skip()` Skip over this records content.
`long`	`skip(long n)`

Methods inherited from class java.io.InputStream
mark, read, reset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MIN_HTTP_HEADER_LENGTH
```
protected static final long MIN_HTTP_HEADER_LENGTH
```
    Minimal http response or request header length. I've seen in arcs content length of 1 with no header.
  - header
```
protected ArchiveRecordHeader header
```
  - in
```
protected java.io.InputStream in
```
    Stream to read this record from. Stream can only be read sequentially. Will only return this records' content returning a -1 if you try to read beyond the end of the current record.
    Streams can be markable or not. If they are, we'll be able to roll back when we've read too far. If not markable, assumption is that the underlying stream is managing our not reading too much (This pertains to the skipping over the end of the ARCRecord. See skip().
  - position
```
protected long position
```
    Position w/i the Record content, within in. This position is relative within this Record. Its not same as the Archive file position.
  - eor
```
protected boolean eor
```
    Set flag when we've reached the end-of-record.
  - digest
```
protected java.security.MessageDigest digest
```
    Compute digest on what we read and add to metadata when done. Currently hardcoded as sha-1. TODO: Remove when archive records digest or else, add a facility that allows the arc reader to compare the calculated digest to that which is recorded in the arc.
    Protected instead of private so subclasses can update and complete the digest.
  - strict
```
protected boolean strict
```
- Constructor Detail
  - ArchiveRecord
```
public ArchiveRecord(java.io.InputStream in)
              throws java.io.IOException
```
    Constructor.
    
    Parameters:
    
    in - Stream cue'd up to be at the start of the record this instance is to represent.
    
    Throws:
    
    java.io.IOException
  - ArchiveRecord
```
public ArchiveRecord(java.io.InputStream in,
                     ArchiveRecordHeader header)
              throws java.io.IOException
```
    Constructor.
    
    Parameters:
    
    in - Stream cue'd up to be at the start of the record this instance is to represent.
    
    header - Header data.
    
    Throws:
    
    java.io.IOException
  - ArchiveRecord
```
public ArchiveRecord(java.io.InputStream in,
                     ArchiveRecordHeader header,
                     int bodyOffset,
                     boolean digest,
                     boolean strict)
              throws java.io.IOException
```
    Constructor.
    
    Parameters:
    
    in - Stream cue'd up to be at the start of the record this instance is to represent.
    
    header - Header data.
    
    bodyOffset - Offset into the body. Usually 0.
    
    digest - True if we're to calculate digest for this record. Not digesting saves about ~15% of cpu during an ARC parse.
    
    strict - Be strict parsing (Parsing stops if ARC inproperly formatted).
    
    Throws:
    
    java.io.IOException
- Method Detail
  - markSupported
```
public boolean markSupported()
```
    Overrides:
    
    markSupported in class java.io.InputStream
  - getHeader
```
public ArchiveRecordHeader getHeader()
```
    Returns:
    
    Header data for this record.
  - setHeader
```
protected void setHeader(ArchiveRecordHeader header)
```
  - close
```
public void close()
           throws java.io.IOException
```
    Calling close on a record skips us past this record to the next record in the stream. It does not actually close the stream. The underlying steam is probably being used by the next arc record.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Overrides:
    
    close in class java.io.InputStream
    
    Throws:
    
    java.io.IOException
  - read
```
public int read()
         throws java.io.IOException
```
    Specified by:
    
    read in class java.io.InputStream
    
    Returns:
    
    Next character in this Record content else -1 if at EOR.
    
    Throws:
    
    java.io.IOException
  - read
```
public int read(byte[] b,
                int offset,
                int length)
         throws java.io.IOException
```
    Overrides:
    
    read in class java.io.InputStream
    
    Throws:
    
    java.io.IOException
  - available
```
public int available()
```
    This available is not the stream's available. Its an available based on what the stated Archive record length is minus what we've read to date.
    
    Overrides:
    
    available in class java.io.InputStream
    
    Returns:
    
    True if bytes remaining in record content.
  - skip
```
protected void skip()
             throws java.io.IOException
```
    Skip over this records content.
    
    Throws:
    
    java.io.IOException
  - skip
```
public long skip(long n)
          throws java.io.IOException
```
    Overrides:
    
    skip in class java.io.InputStream
    
    Throws:
    
    java.io.IOException
  - isStrict
```
public boolean isStrict()
```
    Returns:
    
    Returns the strict.
  - setStrict
```
public void setStrict(boolean strict)
```
    Parameters:
    
    strict - The strict to set.
  - getIn
```
protected java.io.InputStream getIn()
```
  - getDigestStr
```
public java.lang.String getDigestStr()
```
  - incrementPosition
```
protected void incrementPosition()
```
  - incrementPosition
```
protected void incrementPosition(long incr)
```
  - getPosition
```
public long getPosition()
```
  - isEor
```
protected boolean isEor()
```
  - setEor
```
protected void setEor(boolean eor)
```
  - getStatusCode4Cdx
```
protected java.lang.String getStatusCode4Cdx(ArchiveRecordHeader h)
```
  - getIp4Cdx
```
protected java.lang.String getIp4Cdx(ArchiveRecordHeader h)
```
  - getDigest4Cdx
```
protected java.lang.String getDigest4Cdx(ArchiveRecordHeader h)
```
  - getMimetype4Cdx
```
protected java.lang.String getMimetype4Cdx(ArchiveRecordHeader h)
```
  - outputCdx
```
protected java.lang.String outputCdx(java.lang.String strippedFileName)
                              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - dump
```
public void dump()
          throws java.io.IOException
```
    Writes output on STDOUT.
    
    Throws:
    
    java.io.IOException
  - dump
```
public void dump(java.io.OutputStream os)
          throws java.io.IOException
```
    Writes output on passed os.
    
    Throws:
    
    java.io.IOException
  - hasContentHeaders
```
public boolean hasContentHeaders()
```
    Is it likely that this record contains headers? This method will return true if the body is a http response that includes http response headers or the body is a http request that includes request headers, etc. Be aware that headers in content are distinct from ArchiveRecordHeader 'headers'.
    
    Returns:
    
    True if this Record's content has headers:
  - setBodyOffset
```
protected void setBodyOffset(int bodyOffset)
```

Class ArchiveRecord

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Field Detail

MIN_HTTP_HEADER_LENGTH

header

in

position

eor

digest

strict

Constructor Detail

ArchiveRecord

ArchiveRecord

ArchiveRecord

Method Detail

markSupported

getHeader

setHeader

close

read

read

available

skip

skip

isStrict

setStrict

getIn

getDigestStr

incrementPosition

incrementPosition

getPosition

isEor

setEor

getStatusCode4Cdx

getIp4Cdx

getDigest4Cdx

getMimetype4Cdx

outputCdx

dump

dump

hasContentHeaders

setBodyOffset