org.archive.io

Class HeaderedArchiveRecord

java.lang.Object

java.io.InputStream

org.archive.io.ArchiveRecord

org.archive.io.HeaderedArchiveRecord

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class HeaderedArchiveRecord
extends ArchiveRecord

An ArchiveRecord whose content has a preamble of RFC822-like headers: e.g. The ArchiveRecord is a http response that leads off with http response headers. Use this ArchiveRecord Decorator to get at the content headers and the header/content demarcation.

Author:

stack, Olaf Freyer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HeaderedArchiveRecord.UnexpectedStartLineIOException

Field Summary

Fields inherited from class org.archive.io.ArchiveRecord

digest, eor, header, in, MIN_HTTP_HEADER_LENGTH, position, strict

Constructor Summary

Constructors

Constructor and Description
HeaderedArchiveRecord(ArchiveRecord ar)
HeaderedArchiveRecord(ArchiveRecord ar, boolean readContentHeader)

Method Summary

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.
void	dumpHttpHeader()
void	dumpHttpHeader(java.io.PrintStream stream)
org.apache.commons.httpclient.Header[]	getContentHeaders()
int	getContentHeadersLength()
protected java.lang.String	getDigest4Cdx(ArchiveRecordHeader h)
java.lang.String	getDigestStr()
ArchiveRecordHeader	getHeader()
protected java.lang.String	getIp4Cdx(ArchiveRecordHeader h)
protected java.lang.String	getMimetype4Cdx(ArchiveRecordHeader h)
long	getPosition()
int	getStatusCode()
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	setEor(boolean eor)
protected void	setHeader(ArchiveRecordHeader header)
void	setStrict(boolean strict)
protected void	skip() Skip over this records content.
long	skip(long n)
void	skipHttpHeader() Skip over the the content headers if present.

Methods inherited from class org.archive.io.ArchiveRecord

getIn, setBodyOffset

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

Constructor Detail

HeaderedArchiveRecord

public HeaderedArchiveRecord(ArchiveRecord ar)
                      throws java.io.IOException

Throws:

java.io.IOException

HeaderedArchiveRecord

public HeaderedArchiveRecord(ArchiveRecord ar,
                             boolean readContentHeader)
                      throws java.io.IOException

Throws:

java.io.IOException

Method Detail

skipHttpHeader

public void skipHttpHeader()
                    throws java.io.IOException

Skip over the the content headers if present. Subsequent reads will get the body.

Calling this method in the midst of reading the header will make for strange results. Otherwise, safe to call at any time though before reading any of the record content is only time that it makes sense.

After calling this method, you can call getContentHeaders() to get the read http header.

Throws:

java.io.IOException

dumpHttpHeader

public void dumpHttpHeader()
                    throws java.io.IOException

Throws:

java.io.IOException

dumpHttpHeader

public void dumpHttpHeader(java.io.PrintStream stream)
                    throws java.io.IOException

Throws:

java.io.IOException

getStatusCode

public int getStatusCode()

Returns:

If headers are for a http response AND the headers have been read, return status code. Else return -1.

getContentHeadersLength

public int getContentHeadersLength()

Returns:

Returns length of content headers or -1 if headers have not yet been read.

getContentHeaders

public org.apache.commons.httpclient.Header[] getContentHeaders()

read

public int read()
         throws java.io.IOException

Overrides:

read in class ArchiveRecord

Returns:

Next character in this ARCRecord's content else -1 if at end of this record.

Throws:

java.io.IOException

read

public int read(byte[] b,
                int offset,
                int length)
         throws java.io.IOException

Overrides:

read in class ArchiveRecord

Throws:

java.io.IOException

available

public int available()

Description copied from class: ArchiveRecord

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 ArchiveRecord

Returns:

True if bytes remaining in record content.

close

public void close()
           throws java.io.IOException

Description copied from class: ArchiveRecord

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 ArchiveRecord

Throws:

java.io.IOException

dump

public void dump()
          throws java.io.IOException

Description copied from class: ArchiveRecord

Writes output on STDOUT.

Overrides:

dump in class ArchiveRecord

Throws:

java.io.IOException

dump

public void dump(java.io.OutputStream os)
          throws java.io.IOException

Description copied from class: ArchiveRecord

Writes output on passed os.

Overrides:

dump in class ArchiveRecord

Throws:

java.io.IOException

getDigest4Cdx

protected java.lang.String getDigest4Cdx(ArchiveRecordHeader h)

Overrides:

getDigest4Cdx in class ArchiveRecord

getDigestStr

public java.lang.String getDigestStr()

Overrides:

getDigestStr in class ArchiveRecord

getHeader

public ArchiveRecordHeader getHeader()

Overrides:

getHeader in class ArchiveRecord

Returns:

Header data for this record.

getIp4Cdx

protected java.lang.String getIp4Cdx(ArchiveRecordHeader h)

Overrides:

getIp4Cdx in class ArchiveRecord

getMimetype4Cdx

protected java.lang.String getMimetype4Cdx(ArchiveRecordHeader h)

Overrides:

getMimetype4Cdx in class ArchiveRecord

getPosition

public long getPosition()

Overrides:

getPosition in class ArchiveRecord

getStatusCode4Cdx

protected java.lang.String getStatusCode4Cdx(ArchiveRecordHeader h)

Overrides:

getStatusCode4Cdx in class ArchiveRecord

hasContentHeaders

public boolean hasContentHeaders()

Description copied from class: ArchiveRecord

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'.

Overrides:

hasContentHeaders in class ArchiveRecord

Returns:

True if this Record's content has headers:

incrementPosition

protected void incrementPosition()

Overrides:

incrementPosition in class ArchiveRecord

incrementPosition

protected void incrementPosition(long incr)

Overrides:

incrementPosition in class ArchiveRecord

isEor

protected boolean isEor()

Overrides:

isEor in class ArchiveRecord

isStrict

public boolean isStrict()

Overrides:

isStrict in class ArchiveRecord

Returns:

Returns the strict.

markSupported

public boolean markSupported()

Overrides:

markSupported in class ArchiveRecord

outputCdx

protected java.lang.String outputCdx(java.lang.String strippedFileName)
                              throws java.io.IOException

Overrides:

outputCdx in class ArchiveRecord

Throws:

java.io.IOException

setEor

protected void setEor(boolean eor)

Overrides:

setEor in class ArchiveRecord

setHeader

protected void setHeader(ArchiveRecordHeader header)

Overrides:

setHeader in class ArchiveRecord

setStrict

public void setStrict(boolean strict)

Overrides:

setStrict in class ArchiveRecord

Parameters:

strict - The strict to set.

skip

protected void skip()
             throws java.io.IOException

Description copied from class: ArchiveRecord

Skip over this records content.

Overrides:

skip in class ArchiveRecord

Throws:

java.io.IOException

skip

public long skip(long n)
          throws java.io.IOException

Overrides:

skip in class ArchiveRecord

Throws:

java.io.IOException