net.degreedays.api.processing

Interface HttpRequestDispatcher

public interface HttpRequestDispatcher

Sends an HttpRequest to the API servers and returns a stream containing the response.

Implementations of this interface may choose to handle compressed responses by adding an Accept-Encoding header to the request sent to the server, and by ensuring that the InputStream returned by dispatch(HttpRequest) has been inflated. This is all done automatically by the default implementation of HttpRequestDispatcher that comes with this client library.

Thread safety: any general-purpose implementation of this interface must be safe for use by multiple concurrent threads. However, thread safety is not necessary if you're making your own implementation and can be sure that any code that uses it (including any code that uses a RequestProcessor that uses it) will only be called from a single thread.

Method Summary

Modifier and Type	Method and Description
HttpResponseStream	dispatch(HttpRequest request) Calling code is responsible for closing the stream that this returns.

Method Detail

dispatch

HttpResponseStream dispatch(HttpRequest request)
                     throws TransportException

Calling code is responsible for closing the stream that this returns. The stream returned by this should contain the uncompressed XML response.

Throws:

TransportException