Package it.unimi.di.law.warc.records

Interface WarcRecord

All Known Implementing Classes:

AbstractWarcRecord, HttpRequestWarcRecord, HttpResponseWarcRecord, InfoWarcRecord

public interface WarcRecord

An interface describing a WARC record.

Required factory method: a concrete type T implementing this interface must provide a factory method with signature

public static T fromPayload(final HeaderGroup warcHeaders, final BoundSessionInputBuffer payloadBuffer) throws IOException;

and update the WarcRecord.Type enum.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	WarcRecord.Type	An enumeration of implemented record types.

Field Summary

Fields

Modifier and Type	Field	Description
static org.apache.http.ProtocolVersion	PROTOCOL_VERSION	The version of the supported format.

Method Summary

Modifier and Type	Method	Description
long	getWarcContentLength()	Returns the WARC Content-Length header.
java.util.Date	getWarcDate()	Returns the WARC-Date header.
org.apache.http.Header	getWarcHeader(WarcHeader.Name header)	Returns the specified WARC header.
org.apache.http.message.HeaderGroup	getWarcHeaders()	Returns the WARC headers.
java.util.UUID	getWarcRecordId()	Returns the WARC-Record-ID header.
java.net.URI	getWarcTargetURI()	Returns the WARC-Target-URI header as a URI.
WarcRecord.Type	getWarcType()	Returns the WARC-Type header.
void	write(java.io.OutputStream output, ByteArraySessionOutputBuffer buffer)	Writes the WARC record.

Field Detail

PROTOCOL_VERSION

static final org.apache.http.ProtocolVersion PROTOCOL_VERSION

The version of the supported format.

Method Detail

write

void write(java.io.OutputStream output,
           ByteArraySessionOutputBuffer buffer)
    throws java.io.IOException

Writes the WARC record.

Parameters:

output - the stream where to write the record.

buffer - a buffer that will be optionally used by the writer.

Throws:

java.io.IOException

getWarcHeaders

org.apache.http.message.HeaderGroup getWarcHeaders()

Returns the WARC headers.

Returns:

the WARC headers.

getWarcHeader

org.apache.http.Header getWarcHeader(WarcHeader.Name header)

Returns the specified WARC header.

Parameters:

header - the name of the header to return.

Returns:

the header, or null if the header is not present.

getWarcRecordId

java.util.UUID getWarcRecordId()

Returns the WARC-Record-ID header.

Returns:

the record UUID.

Throws:

java.lang.IllegalStateException - in case the header (which is mandatory) is not present.

getWarcType

WarcRecord.Type getWarcType()

Returns the WARC-Type header.

Returns:

the record type.

Throws:

java.lang.IllegalStateException - in case the header (which is mandatory) is not present.

getWarcDate

java.util.Date getWarcDate()

Returns the WARC-Date header.

Returns:

the record creation date.

Throws:

java.lang.IllegalStateException - in case the header (which is mandatory) is not present.

getWarcContentLength

long getWarcContentLength()

Returns the WARC Content-Length header.

Returns:

the record payload length.

Throws:

java.lang.IllegalStateException - in case the header (which is mandatory) is not present.

getWarcTargetURI

java.net.URI getWarcTargetURI()

Returns the WARC-Target-URI header as a URI.

Note that different implementations might be more or less strict with respect to parsing. See, for instance, AbstractWarcRecord.getWarcTargetURI().

Returns:

the record target URI.

Throws:

java.lang.IllegalStateException - if the header is not present.

java.lang.IllegalArgumentException - if the header value cannot be parsed into a URI.

See Also:

AbstractWarcRecord.getWarcTargetURI()