org.opencastproject.serviceregistry.api

Class RemoteBase.HttpClientClosingInputStream

java.lang.Object

java.io.InputStream

org.opencastproject.serviceregistry.api.RemoteBase.HttpClientClosingInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

Enclosing class:

RemoteBase

public class RemoteBase.HttpClientClosingInputStream
extends InputStream

A stream wrapper that closes the http response when the stream is closed. If a remote service proxy returns an inputstream, this implementation should be used to ensure that the http connection is closed properly.

Field Summary

Fields

Modifier and Type	Field and Description
protected InputStream	delegateStream The input stream delivering the actual data
protected org.apache.http.HttpResponse	httpResponse The http response to close when the stream is closed

Constructor Summary

Constructors

Constructor and Description
HttpClientClosingInputStream(org.apache.http.HttpResponse resp) Constructs an HttpClientClosingInputStream from a source stream and an http response.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

delegateStream

protected InputStream delegateStream

The input stream delivering the actual data

httpResponse

protected org.apache.http.HttpResponse httpResponse

The http response to close when the stream is closed

Constructor Detail

HttpClientClosingInputStream

public HttpClientClosingInputStream(org.apache.http.HttpResponse resp)
                             throws IllegalStateException,
                                    IOException

Constructs an HttpClientClosingInputStream from a source stream and an http response.

Throws:

IOException

IllegalStateException

Method Detail

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

See Also:

InputStream.read()

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

See Also:

InputStream.available()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

See Also:

InputStream.close()

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

Parameters:

readlimit -

See Also:

InputStream.mark(int)

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

Returns:

whether this stream supports marking

See Also:

InputStream.markSupported()

read

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

Overrides:

read in class InputStream

Parameters:

b - the buffer into which the data is read.

off - the start offset in array b at which the data is written.

len - the maximum number of bytes to read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

IOException - If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.

NullPointerException - If b is null.

IndexOutOfBoundsException - If off is negative, len is negative, or len is greater than b.length - off

See Also:

InputStream.read(byte[], int, int)

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Parameters:

b - the buffer into which the data is read.

Returns:

the total number of bytes read into the buffer, or -1 is there is no more data because the end of the stream has been reached.

Throws:

IOException - If the first byte cannot be read for any reason other than the end of the file, if the input stream has been closed, or if some other I/O error occurs.

NullPointerException - if b is null.

See Also:

InputStream.read(byte[])

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

See Also:

InputStream.reset()

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Parameters:

n - the number of bytes to be skipped.

Returns:

the actual number of bytes skipped.

Throws:

IOException - if the stream does not support seek, or if some other I/O error occurs.

See Also:

InputStream.skip(long)

toString

public String toString()

Overrides:

toString in class Object

Returns:

See Also:

Object.toString()