org.archive.wayback.replay

Class RangeResource

java.lang.Object

java.io.InputStream

org.archive.wayback.core.Resource

org.archive.wayback.replay.RangeResource

All Implemented Interfaces:

Closeable, AutoCloseable

public class RangeResource
extends Resource

RangeResource decorates Resource to render partial content response to range request. After constructing with wrapped Resource and requested range, call parseRange() to prepare internal state for rendering. The method will throw RangeNotSatisfiableException if the requested byte ranges cannot be replayed with the base Resource. RangeResource currently only works with:

• A single-range request
• A 200 capture with Content-Length, or a valid 206 capture with single range (i.e. no support for multipart/byteranges)

See Also:

HttpHeaderOperation.parseRanges(String)

Constructor Summary

Constructors

Constructor and Description
RangeResource(Resource origResource, long[][] requestedRanges) Initialize with base Resource and requested ranges.

Method Summary

Modifier and Type	Method and Description
protected long[]	availableRange() Look at resource HTTP header fields and determine the byte range available.
void	close()
Map<String,String>	getHttpHeaders() Assumes an HTTP response - return the HTTP headers, not including the HTTP Message header
long	getRecordLength()
int	getStatusCode() Assumes an HTTP resource - return the HTTP response code
void	parseRange() Prepare response for requested range.

Methods inherited from class org.archive.wayback.core.Resource

available, getHeader, getRefersToDate, getRefersToTargetURI, mark, markSupported, parseHeaders, read, read, read, reset, setChunkedEncoding, setInputStream, skip

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RangeResource

public RangeResource(Resource origResource,
                     long[][] requestedRanges)

Initialize with base Resource and requested ranges.

Parameters:

origResource - base resource

requestedRanges - requested range

See Also:

HttpHeaderOperation.parseRanges(String)

Method Detail

parseRange

public void parseRange()
                throws RangeNotSatisfiableException,
                       IOException

Prepare response for requested range.

Throws:

RangeNotSatisfiableException - base Resource either does not have enough data to fulfill the request, or have invalid header field.

IOException

availableRange

protected long[] availableRange()

Look at resource HTTP header fields and determine the byte range available.

Returns:

array with three long values:

1. offset of first available byte,
2. offset of last available byte + 1,
3. instance-length

Note this method returns null for multipart/byteranges response.

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class Resource

Throws:

IOException

getHttpHeaders

public Map<String,String> getHttpHeaders()

Description copied from class: Resource

Assumes an HTTP response - return the HTTP headers, not including the HTTP Message header

Specified by:

getHttpHeaders in class Resource

Returns:

key-value Map of HTTP headers

getRecordLength

public long getRecordLength()

Specified by:

getRecordLength in class Resource

Returns:

the size in bytes of the record payload, including HTTP header

getStatusCode

public int getStatusCode()

Description copied from class: Resource

Assumes an HTTP resource - return the HTTP response code

Specified by:

getStatusCode in class Resource

Returns:

the HTTP response code from the HTTP message