jsimple.net

Class HttpResponse

java.lang.Object

jsimple.lang.AutoCloseable

jsimple.net.HttpResponse

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

JavaHttpResponse

public abstract class HttpResponse
extends AutoCloseable

This class handles http connectivity. It's based on a subset of the standard Java java.net.HttpURLConnection class, with some changes (to improve names, get rid of checked exceptions, etc.).

From the doc for java.net.HttpURLConnection: Each instance of this class is used to make a single request but the underlying network connection to the HTTP server may be transparently shared by other instances. Calling the close() methods on the InputStream or OutputStream of an HttpURLConnection after a request may free network resources associated with this instance but has no effect on any shared persistent connection. Calling the disconnect() method may close the underlying socket if a persistent connection is otherwise idle at that time.

This class is platform independent. Platforms (Java, C# for .Net, etc.) should define a subclass with the actual implementation.

Since:

10/6/12 12:58 AM

Constructor Summary

Constructors

Constructor and Description
HttpResponse()

Method Summary

Modifier and Type	Method and Description
abstract InputStream	getBodyStream() Returns an input stream that reads from this open connection.
abstract java.lang.String	getHeader(java.lang.String headerName) Get the value of the specified header or null if the header isn't present.
abstract int	getStatusCode() Gets the status code from an HTTP response message (e.g.
abstract java.lang.String	getStatusMessage() Gets the message from the HTTP response status line--the "reason phrase" (which is what the RFC calls it) describing the error that comes after the status code.

Methods inherited from class jsimple.lang.AutoCloseable

close

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponse

public HttpResponse()

Method Detail

getStatusCode

public abstract int getStatusCode()

Gets the status code from an HTTP response message (e.g. 200, 401, etc.). Returns -1 if no code can be discerned from the response (i.e., the response is not valid HTTP).

Returns:

the HTTP Status-Code, or -1

getStatusMessage

public abstract java.lang.String getStatusMessage()

Gets the message from the HTTP response status line--the "reason phrase" (which is what the RFC calls it) describing the error that comes after the status code.

Returns:

the HTTP reason phrase, from the status line

getBodyStream

public abstract InputStream getBodyStream()

Returns an input stream that reads from this open connection.

A SocketTimeoutException can be thrown when reading from the returned input stream if the read timeout expires before data is available for read.

Returns:

an input stream that reads from this open connection

Throws:

IOException - if an I/O error occurs while creating the input stream

getHeader

@Nullable
public abstract java.lang.String getHeader(java.lang.String headerName)

Get the value of the specified header or null if the header isn't present.

TODO: Handle multivalued headers by returning, in most cases, the first value--that's at least what the Scribe code does.

Parameters:

headerName - HTTP header name

Returns:

header value or null if not present