com.google.api.client.http
Class LowLevelHttpResponse

java.lang.Object
  extended by com.google.api.client.http.LowLevelHttpResponse
Direct Known Subclasses:
MockLowLevelHttpResponse

public abstract class LowLevelHttpResponse
extends Object

Low-level HTTP response.

This allows providing a different implementation of the HTTP response that is more compatible with the Java environment used.

Implementation has no fields and therefore thread-safe, but sub-classes are not necessarily thread-safe.

Since:
1.0
Author:
Yaniv Inbar

Constructor Summary
LowLevelHttpResponse()
           
 
Method Summary
 void disconnect()
          Default implementation does nothing, but subclasses may override to attempt to abort the connection or release allocated system resources for this connection.
abstract  InputStream getContent()
          Returns the HTTP response content input stream or null for none.
abstract  String getContentEncoding()
          Returns the content encoding (for example "gzip") or null for none.
abstract  long getContentLength()
          Returns the content length or 0 for none.
abstract  String getContentType()
          Returns the content type or null for none.
abstract  int getHeaderCount()
          Returns the number of HTTP response headers.
abstract  String getHeaderName(int index)
          Returns the HTTP response header name at the given zero-based index.
abstract  String getHeaderValue(int index)
          Returns the HTTP response header value at the given zero-based index.
abstract  String getReasonPhrase()
          Returns the HTTP reason phrase or null for none.
abstract  int getStatusCode()
          Returns the response status code or 0 for none.
abstract  String getStatusLine()
          Returns the response status line or null for none.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LowLevelHttpResponse

public LowLevelHttpResponse()
Method Detail

getContent

public abstract InputStream getContent()
                                throws IOException
Returns the HTTP response content input stream or null for none.

Throws:
IOException - I/O exception

getContentEncoding

public abstract String getContentEncoding()
Returns the content encoding (for example "gzip") or null for none.


getContentLength

public abstract long getContentLength()
Returns the content length or 0 for none.


getContentType

public abstract String getContentType()
Returns the content type or null for none.


getStatusLine

public abstract String getStatusLine()
Returns the response status line or null for none.


getStatusCode

public abstract int getStatusCode()
Returns the response status code or 0 for none.


getReasonPhrase

public abstract String getReasonPhrase()
Returns the HTTP reason phrase or null for none.


getHeaderCount

public abstract int getHeaderCount()
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.


getHeaderName

public abstract String getHeaderName(int index)
Returns the HTTP response header name at the given zero-based index.


getHeaderValue

public abstract String getHeaderValue(int index)
Returns the HTTP response header value at the given zero-based index.


disconnect

public void disconnect()
                throws IOException
Default implementation does nothing, but subclasses may override to attempt to abort the connection or release allocated system resources for this connection.

Throws:
IOException - I/O exception
Since:
1.4


Copyright © 2011-2012 Google. All Rights Reserved.