com.flyingspaniel.nava.request

Class Response

java.lang.Object

com.flyingspaniel.nava.request.Response

public class Response
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
Object	body
protected HttpURLConnection	connection
String	contentType
Map<String,List<String>>	headerFields
IOException	ioException
protected Request	request
int	responseCode
String	responseMessage
URL	url

Constructor Summary

Constructors

Constructor and Description
Response(Request request, HttpURLConnection connection, IOException ioe, int milestoneCode) Constructor when there was an IOException
Response(Request request, HttpURLConnection connection, Object body) Constructor for a success Reads various fields from the HttpURLConnection

Method Summary

Methods

Modifier and Type	Method and Description
static StringBuilder	formatHeaders(Map<String,List<String>> headers) Formats the HTTP headers nicely...
Object	getBody() The response data (generally taken from HttpURLConnection.getInputStream())
String	getContentType() Content-Type
Map<String,List<String>>	getHeaderFields() Return the Headers from the response
IOException	getIOException() If there was an IOException, return it here
String	getRedirect()
Request	getRequest() Get the request that triggered this response.
int	getResponseCode() Returns the positive HTTP status code, or else one of Request.Milestone.gerErrorCode() (which are negative)
String	getResponseMessage() Message corresponding to the HTTP status code, or else the message from the IOException
URL	getURL() The URL we talked to
int	responseGroup() Which "hundreds" the response was in, e.g.
void	throwIOException() If you like to throw the IOException
String	toString() Nicely formatted summary of the response...
boolean	wasSuccessful()

Methods inherited from class java.lang.Object

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

Field Detail

request

protected final Request request

connection

protected final HttpURLConnection connection

contentType

public final String contentType

headerFields

public final Map<String,List<String>> headerFields

url

public final URL url

body

public final Object body

responseCode

public final int responseCode

responseMessage

public final String responseMessage

ioException

public final IOException ioException

Constructor Detail

Response

public Response(Request request,
        HttpURLConnection connection,
        Object body)

Constructor for a success Reads various fields from the HttpURLConnection

Parameters:

request - the HTTP Request that initiated this response

connection - non-null

body - may be null (came from connection.getInputStream())

Response

public Response(Request request,
        HttpURLConnection connection,
        IOException ioe,
        int milestoneCode)

Constructor when there was an IOException

Parameters:

request - the HTTP Request that initiated this response

connection - may be null if connection failed to open.

ioe - the IOException (non-null)

milestoneCode - small negative number taken from Request.Milestone

Method Detail

getContentType

public String getContentType()

Content-Type

Returns:

String, null if the connection never opened

See Also:

URLConnection.getContentType()

getHeaderFields

public Map<String,List<String>> getHeaderFields()

Return the Headers from the response

Returns:

a Map>, null if the connection never opened

See Also:

URLConnection.getHeaderFields()

getResponseCode

public int getResponseCode()

Returns the positive HTTP status code, or else one of Request.Milestone.gerErrorCode() (which are negative)

Returns:

int HTTP code, e.g. 200

See Also:

HttpURLConnection.getResponseCode(), Request.Milestone.errorCode()

getResponseMessage

public String getResponseMessage()

Message corresponding to the HTTP status code, or else the message from the IOException

Returns:

e.g. "OK"

See Also:

HttpURLConnection.getResponseMessage()

getBody

public Object getBody()

The response data (generally taken from HttpURLConnection.getInputStream())

Returns:

Object, never null, but may be ""

getURL

public URL getURL()

The URL we talked to

Returns:

URL

See Also:

URLConnection.getURL()

getIOException

public IOException getIOException()

If there was an IOException, return it here

Returns:

the IOException (or null)

responseGroup

public int responseGroup()

Which "hundreds" the response was in, e.g. good responses are 200

Returns:

a multiple of 100

getRedirect

public String getRedirect()

throwIOException

public void throwIOException()
                      throws IOException

If you like to throw the IOException

Throws:

IOException

getRequest

public Request getRequest()

Get the request that triggered this response.

Returns:

never-null

wasSuccessful

public boolean wasSuccessful()

toString

public String toString()

Nicely formatted summary of the response...

Overrides:

toString in class Object

formatHeaders

public static StringBuilder formatHeaders(Map<String,List<String>> headers)

Formats the HTTP headers nicely...

Parameters:

headers -

Returns:

StringBuilder, never null but may be ""