Class NetHttpResponse

java.lang.Object

com.google.api.client.http.LowLevelHttpResponse

com.google.api.client.http.javanet.NetHttpResponse

final class NetHttpResponse
extends LowLevelHttpResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	NetHttpResponse.SizeValidatingInputStream	A wrapper arround the base InputStream that validates EOF returned by the read calls.

Field Summary

Fields

Modifier and Type	Field	Description
private final HttpURLConnection	connection
private final ArrayList<String>	headerNames
private final ArrayList<String>	headerValues
private final int	responseCode
private final String	responseMessage

Constructor Summary

Constructors

Constructor	Description
NetHttpResponse(HttpURLConnection connection)

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Closes the connection to the HTTP server.
InputStream	getContent()	Returns the HTTP response content input stream or null for none.
String	getContentEncoding()	Returns the content encoding (for example "gzip") or null for none.
long	getContentLength()	Returns the content length or 0 for none.
String	getContentType()	Returns the content type or null for none.
int	getHeaderCount()	Returns the number of HTTP response headers.
String	getHeaderName(int index)	Returns the HTTP response header name at the given zero-based index.
String	getHeaderValue(int index)	Returns the HTTP response header value at the given zero-based index.
String	getReasonPhrase()	Returns the HTTP reason phrase or null for none.
int	getStatusCode()	Returns the response status code or <=0 for none.
String	getStatusLine()	Returns the response status line or null for none.

Methods inherited from class Object

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

Field Details

connection

private final HttpURLConnection connection

responseCode

private final int responseCode

responseMessage

private final String responseMessage

headerNames

private final ArrayList<String> headerNames

headerValues

private final ArrayList<String> headerValues

Constructor Details

NetHttpResponse

NetHttpResponse(HttpURLConnection connection)
         throws IOException

Throws:

IOException

Method Details

getStatusCode

public int getStatusCode()

Description copied from class: LowLevelHttpResponse

Returns the response status code or <=0 for none.

Specified by:

getStatusCode in class LowLevelHttpResponse

getContent

public InputStream getContent()
                       throws IOException

Returns the HTTP response content input stream or null for none.

Returns URLConnection.getInputStream() when it doesn't throw IOException, otherwise it returns HttpURLConnection.getErrorStream().

Upgrade warning: in prior version 1.16 getContent() returned URLConnection.getInputStream() only when the status code was successful. Starting with version 1.17 it returns URLConnection.getInputStream() when it doesn't throw IOException, otherwise it returns HttpURLConnection.getErrorStream()

Upgrade warning: in versions prior to 1.20 getContent() returned URLConnection.getInputStream() or HttpURLConnection.getErrorStream(), both of which silently returned -1 for read() calls when the connection got closed in the middle of receiving a response. This is highly likely a bug from JDK's HttpURLConnection. Since version 1.20, the bytes read off the wire will be checked and an IOException will be thrown if the response is not fully delivered when the connection is closed by server for whatever reason, e.g., server restarts. Note though that this is a best-effort check: when the response is chunk encoded, we have to rely on the underlying HTTP library to behave correctly.

Specified by:

getContent in class LowLevelHttpResponse

Throws:

IOException - I/O exception

getContentEncoding

public String getContentEncoding()

Description copied from class: LowLevelHttpResponse

Returns the content encoding (for example "gzip") or null for none.

Specified by:

getContentEncoding in class LowLevelHttpResponse

getContentLength

public long getContentLength()

Description copied from class: LowLevelHttpResponse

Returns the content length or 0 for none.

Specified by:

getContentLength in class LowLevelHttpResponse

getContentType

public String getContentType()

Description copied from class: LowLevelHttpResponse

Returns the content type or null for none.

Specified by:

getContentType in class LowLevelHttpResponse

getReasonPhrase

public String getReasonPhrase()

Description copied from class: LowLevelHttpResponse

Returns the HTTP reason phrase or null for none.

Specified by:

getReasonPhrase in class LowLevelHttpResponse

getStatusLine

public String getStatusLine()

Description copied from class: LowLevelHttpResponse

Returns the response status line or null for none.

Specified by:

getStatusLine in class LowLevelHttpResponse

getHeaderCount

public int getHeaderCount()

Description copied from class: LowLevelHttpResponse

Returns the number of HTTP response headers.

Note that multiple headers of the same name need to be supported, in which case each header value is treated as a separate header.

Specified by:

getHeaderCount in class LowLevelHttpResponse

getHeaderName

public String getHeaderName(int index)

Description copied from class: LowLevelHttpResponse

Returns the HTTP response header name at the given zero-based index.

Specified by:

getHeaderName in class LowLevelHttpResponse

getHeaderValue

public String getHeaderValue(int index)

Description copied from class: LowLevelHttpResponse

Returns the HTTP response header value at the given zero-based index.

Specified by:

getHeaderValue in class LowLevelHttpResponse

disconnect

public void disconnect()

Closes the connection to the HTTP server.

Overrides:

disconnect in class LowLevelHttpResponse

Since:

1.4