net.degreedays.api.processing

Class HttpResponseStream

java.lang.Object

net.degreedays.api.processing.HttpResponseStream

public class HttpResponseStream
extends java.lang.Object

A simple wrapper around the InputStream that comes as a response from the API servers.

This exists primarily for custom implementations of HttpRequestDispatcher that may wish to subclass this to perform extra cleanup when the stream is closed via the close() method (which can be overridden).

Constructor Summary

Constructors

Constructor and Description
HttpResponseStream(java.io.InputStream stream)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the stream(), wrapping any IOException in a TransportException.
java.io.InputStream	stream() Returns the non-null InputStream object that this HttpResponseStream object was created with.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponseStream

public HttpResponseStream(java.io.InputStream stream)

Method Detail

stream

public final java.io.InputStream stream()

Returns the non-null InputStream object that this HttpResponseStream object was created with.

You should not close the returned stream directly, instead call close() on this object when you're done with it (and the stream it holds).

close

public void close()
           throws TransportException

Closes the stream(), wrapping any IOException in a TransportException.

If your HttpRequestDispatcher needs to do any other cleanup, it should return a subclass of HttpResponseStream that overrides this method.

Throws:

TransportException