com.whizzosoftware.hobson.api.plugin.http

Interface HttpResponse

All Known Implementing Classes:

NingHttpResponseAdapter

public interface HttpResponse

An interface representing an HTTP response.

Author:

Dan Noguerol

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBody() Returns the response body as a String.
java.io.InputStream	getBodyAsStream() Returns the response body as a stream.
java.util.Collection<Cookie>	getCookies() Returns all cookies present in the response.
java.util.Collection<java.lang.String>	getHeader(java.lang.String name) Returns a specific header in the response.
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	getHeaders() Returns all response headers.
int	getStatusCode() Returns the HTTP response code.
java.lang.String	getStatusText() Returns the HTTP response text.
boolean	hasCookies() Indicates whether cookies were present in the response
boolean	hasHeader(java.lang.String name) Indicates whether a header is present in the response.

Method Detail

getStatusCode

int getStatusCode()

Returns the HTTP response code.

Returns:

an int

getStatusText

java.lang.String getStatusText()

Returns the HTTP response text.

Returns:

a String

hasHeader

boolean hasHeader(java.lang.String name)

Indicates whether a header is present in the response.

Parameters:

name - the header name

Returns:

a boolean

getHeader

java.util.Collection<java.lang.String> getHeader(java.lang.String name)

Returns a specific header in the response.

Parameters:

name - the header name

Returns:

a Collection of String objects (or null if the header doesn't exist)

getHeaders

java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getHeaders()

Returns all response headers.

Returns:

a Map of header name to Collection of Strings

hasCookies

boolean hasCookies()

Indicates whether cookies were present in the response

Returns:

a boolean

getCookies

java.util.Collection<Cookie> getCookies()

Returns all cookies present in the response.

Returns:

a Collection of Cookie objects (or null if none exist)

getBody

java.lang.String getBody()
                  throws java.io.IOException

Returns the response body as a String.

Returns:

a String

Throws:

java.io.IOException - on failure

getBodyAsStream

java.io.InputStream getBodyAsStream()
                             throws java.io.IOException

Returns the response body as a stream.

Returns:

an InputStream

Throws:

java.io.IOException - on failure