org.archive.io

Class ReplayInputStream

java.lang.Object

java.io.InputStream

org.archive.io.SeekInputStream

org.archive.io.ReplayInputStream

All Implemented Interfaces:

it.unimi.dsi.fastutil.io.RepositionableStream, java.io.Closeable, java.lang.AutoCloseable

public class ReplayInputStream
extends SeekInputStream

Replays the bytes recorded from a RecordingInputStream or RecordingOutputStream. This InputStream supports mark and reset.

Author:

gojomo

Field Summary

Fields

Modifier and Type	Field and Description
protected java.io.File	backingFile
protected long	responseBodyStart Where the response body starts, if marked

Constructor Summary

Constructors

Constructor and Description
ReplayInputStream(byte[] buffer, long size, long responseBodyStart, java.lang.String backingFilename) Constructor.
ReplayInputStream(byte[] buffer, long size, java.lang.String backingFilename) Constructor.
ReplayInputStream(java.io.InputStream fillStream) Create a ReplayInputStream from the given source stream.

Method Summary

Modifier and Type	Method and Description
void	close()
void	destroy() Close & destroy any internally-generated temporary files.
protected byte[]	getBuffer()
long	getContentSize() Total size of content.
long	getHeaderSize() Total size of header.
long	getSize() Total size of stream content.
long	position()
void	position(long p) Reposition the stream.
int	read()
int	read(byte[] b, int off, int len)
void	readContentTo(java.io.OutputStream os)
void	readContentTo(java.io.OutputStream os, long maxSize) Convenience method to copy content out to target stream.
static void	readFullyTo(java.io.InputStream in, java.io.OutputStream os)
void	readFullyTo(java.io.OutputStream os)
void	readHeaderTo(java.io.OutputStream os)
long	remaining()
long	setToResponseBodyStart()
protected void	setupDiskStream(java.io.File backingFile)

Methods inherited from class org.archive.io.SeekInputStream

mark, markSupported, reset

Methods inherited from class java.io.InputStream

available, read, skip

Methods inherited from class java.lang.Object

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

Field Detail

responseBodyStart

protected long responseBodyStart

Where the response body starts, if marked

backingFile

protected java.io.File backingFile

Constructor Detail

ReplayInputStream

public ReplayInputStream(byte[] buffer,
                         long size,
                         long responseBodyStart,
                         java.lang.String backingFilename)
                  throws java.io.IOException

Constructor.

Parameters:

buffer - Buffer to read from.

size - Size of data to replay.

responseBodyStart - Start of the response body.

backingFilename - Backing file that sits behind the buffer. If size > than buffer then we go to backing file to read data that is beyond buffer.length.

Throws:

java.io.IOException - If we fail to open an input stream on backing file.

ReplayInputStream

public ReplayInputStream(byte[] buffer,
                         long size,
                         java.lang.String backingFilename)
                  throws java.io.IOException

Constructor.

Parameters:

buffer - Buffer to read from.

size - Size of data to replay.

backingFilename - Backing file that sits behind the buffer. If size > than buffer then we go to backing file to read data that is beyond buffer.length.

Throws:

java.io.IOException - If we fail to open an input stream on backing file.

ReplayInputStream

public ReplayInputStream(java.io.InputStream fillStream)
                  throws java.io.IOException

Create a ReplayInputStream from the given source stream. Requires reading the entire stream (and possibly overflowing to a temporary file). Primary reason for doing so would be to have a repositionable version of the original stream's contents. If created via this constructor, use the destroy() method to ensure prompt deletion of any associated tmp file when done.

Parameters:

fillStream -

Throws:

java.io.IOException

Method Detail

setupDiskStream

protected void setupDiskStream(java.io.File backingFile)
                        throws java.io.IOException

Throws:

java.io.IOException

destroy

public void destroy()

Close & destroy any internally-generated temporary files.

setToResponseBodyStart

public long setToResponseBodyStart()
                            throws java.io.IOException

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Specified by:

read in class java.io.InputStream

Throws:

java.io.IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws java.io.IOException

Overrides:

read in class java.io.InputStream

Throws:

java.io.IOException

readFullyTo

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

Throws:

java.io.IOException

readFullyTo

public static void readFullyTo(java.io.InputStream in,
                               java.io.OutputStream os)
                        throws java.io.IOException

Throws:

java.io.IOException

readHeaderTo

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

Throws:

java.io.IOException

readContentTo

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

Throws:

java.io.IOException

readContentTo

public void readContentTo(java.io.OutputStream os,
                          long maxSize)
                   throws java.io.IOException

Convenience method to copy content out to target stream.

Parameters:

os - stream to write content to

maxSize - maximum count of bytes to copy

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

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

getSize

public long getSize()

Total size of stream content.

Returns:

Returns the size.

getHeaderSize

public long getHeaderSize()

Total size of header.

Returns:

the size of the header.

getContentSize

public long getContentSize()

Total size of content.

Returns:

the size of the content.

remaining

public long remaining()

Returns:

Amount THEORETICALLY remaining (TODO: Its not theoretical seemingly. The class implemetentation depends on it being exact).

position

public void position(long p)
              throws java.io.IOException

Reposition the stream.

Parameters:

p - the new position for this stream

Throws:

java.io.IOException - if an IO error occurs

position

public long position()
              throws java.io.IOException

Throws:

java.io.IOException

getBuffer

protected byte[] getBuffer()