com.inedo.http

Class HttpEasyReader

java.lang.Object

com.inedo.http.HttpEasyReader

public class HttpEasyReader
extends java.lang.Object

Response reader for HTTP requests, can parse JSON and XML and download files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpEasyReader.Family An enumeration representing the class of an http response status code.

Constructor Summary

Constructors

Constructor and Description
HttpEasyReader(java.net.HttpURLConnection connection, HttpEasy request) Create new HttpEasyReader.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	asString()
java.io.File	downloadFile(java.lang.String saveDir) Download a file from the response.
java.net.HttpURLConnection	getConnection() Returns the underlying connection object in the event that the exposed methods don't provide the information you are after.
JsonReader	getJsonReader()
int	getResponseCode() Gets the status code from an HTTP response message, see HttpURLConnection.getResponseCode().
HttpEasyReader.Family	getResponseCodeFamily() Gets the family of the status code from an HTTP response message, see HttpEasyReader.Family.
java.lang.String	getResponseHeaderField(java.lang.String name) Response header field.
java.util.List<java.lang.String>	getResponseHeaderFields(java.lang.String name) Response header field.
XmlReader	getXmlReader()
static java.lang.String	parseForAttribute(java.lang.String attribute, java.lang.String parseString) Parses a string looking for a attribute-value pair, and returns the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpEasyReader

public HttpEasyReader(java.net.HttpURLConnection connection,
              HttpEasy request)
               throws HttpResponseException,
                      java.io.IOException

Create new HttpEasyReader.

Parameters:

connection - HttpURLConnection

request - Request that is creating this reader

Throws:

HttpResponseException - if request failed

java.io.IOException - for connection errors

Method Detail

getConnection

public java.net.HttpURLConnection getConnection()

Returns the underlying connection object in the event that the exposed methods don't provide the information you are after.

Returns:

A HttpURLConnection

getResponseCode

public int getResponseCode()
                    throws java.io.IOException

Gets the status code from an HTTP response message, see HttpURLConnection.getResponseCode().

Returns:

Response code

Throws:

java.io.IOException

getResponseCodeFamily

public HttpEasyReader.Family getResponseCodeFamily()
                                            throws java.io.IOException

Gets the family of the status code from an HTTP response message, see HttpEasyReader.Family.

Returns:

Response family

Throws:

java.io.IOException

asString

public java.lang.String asString()
                          throws java.io.IOException

Returns:

The response as a string, makes no attempt to determine the content type

Throws:

java.io.IOException - If unable to read the response

getJsonReader

public JsonReader getJsonReader()
                         throws java.io.IOException

Returns:

A JsonReader to handle a json response.

Throws:

java.io.IOException - If unable to read the response

getXmlReader

public XmlReader getXmlReader()
                       throws javax.xml.parsers.ParserConfigurationException,
                              org.xml.sax.SAXException,
                              java.io.IOException

Returns:

An XmlReader to handle an xml response.

Throws:

org.xml.sax.SAXException

javax.xml.parsers.ParserConfigurationException

java.io.IOException - If unable to read the response

downloadFile

public java.io.File downloadFile(java.lang.String saveDir)
                          throws java.io.IOException

Download a file from the response.

Parameters:

saveDir - Location to place the file, the file name is gotten from the response headers

Returns:

File object

Throws:

java.io.IOException - If unable to write the file

parseForAttribute

public static java.lang.String parseForAttribute(java.lang.String attribute,
                                 java.lang.String parseString)

Parses a string looking for a attribute-value pair, and returns the value. For example:

      String parseString = "Content-Disposition: filename=\"bob\" name=\"jack\"";
      MultipartIterator.parseForAttribute(parseString, "name");
 

That will return "bob".

Parameters:

attribute - The name of the attribute you're trying to get

parseString - The string to retrieve the value from

Returns:

The value of the attribute, or null if none could be found

getResponseHeaderField

public java.lang.String getResponseHeaderField(java.lang.String name)

Response header field. If called on a connection that sets the same header multiple times with possibly different values, only the last value is returned. See getResponseHeaderFields(String).

Parameters:

name - Field name

Returns:

Field value

getResponseHeaderFields

public java.util.List<java.lang.String> getResponseHeaderFields(java.lang.String name)

Response header field. If called on a connection that sets the same header multiple times then all values are returned in a list.

Parameters:

name - Field name

Returns:

Field value