MockLowLevelHttpResponse

java.lang.Object
- com.google.api.client.http.LowLevelHttpResponse
- - com.google.api.client.testing.http.MockLowLevelHttpResponse

@Beta
public class MockLowLevelHttpResponse
extends LowLevelHttpResponse

Beta
Mock for LowLevelHttpResponse.

Implementation is not thread-safe.

Since:: 1.3

Constructor Summary

Constructors

Constructor and Description
`MockLowLevelHttpResponse()`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`MockLowLevelHttpResponse`	`addHeader(String name, String value)` Adds a header to the response.
`void`	`disconnect()` Default implementation does nothing, but subclasses may override to attempt to abort the connection or release allocated system resources for this connection.
`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.
`List<String>`	`getHeaderNames()` Returns the list of header names of HTTP response.
`String`	`getHeaderValue(int index)` Returns the HTTP response header value at the given zero-based index.
`List<String>`	`getHeaderValues()` Returns the list of header values of HTTP response.
`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.
`boolean`	`isDisconnected()` Returns whether `disconnect()` has been called.
`MockLowLevelHttpResponse`	`setContent(byte[] byteContent)` Sets the response content to the given byte array.
`MockLowLevelHttpResponse`	`setContent(InputStream content)` Sets the input stream content of HTTP response or `null` for none.
`MockLowLevelHttpResponse`	`setContent(String stringContent)` Sets the response content to the given content string.
`MockLowLevelHttpResponse`	`setContentEncoding(String contentEncoding)` Sets the content encoding or `null` for none.
`MockLowLevelHttpResponse`	`setContentLength(long contentLength)` Sets the content length or `-1` for unknown.
`MockLowLevelHttpResponse`	`setContentType(String contentType)` Sets the content type of HTTP response or `null` for none.
`MockLowLevelHttpResponse`	`setHeaderNames(List<String> headerNames)` Sets the list of header names of HTTP response.
`MockLowLevelHttpResponse`	`setHeaderValues(List<String> headerValues)` Sets the list of header values of HTTP response.
`MockLowLevelHttpResponse`	`setReasonPhrase(String reasonPhrase)` Sets the HTTP reason phrase or `null` for none.
`MockLowLevelHttpResponse`	`setStatusCode(int statusCode)` Sets the status code of HTTP response.
`MockLowLevelHttpResponse`	`setZeroContent()` Sets the content to `null` and the content length to 0.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - MockLowLevelHttpResponse
```
public MockLowLevelHttpResponse()
```
- Method Detail
  - addHeader
```
public MockLowLevelHttpResponse addHeader(String name,
                                          String value)
```
    Adds a header to the response.
    
    Parameters:
    
    name - header name
    
    value - header value
  - setContent
```
public MockLowLevelHttpResponse setContent(String stringContent)
```
    Sets the response content to the given content string.
    If the input string is null, it will set the content to null. Else, it will use TestableByteArrayInputStream with the UTF-8 encoded string content.
    
    Parameters:
    
    stringContent - content string or null for none
  - setContent
```
public MockLowLevelHttpResponse setContent(byte[] byteContent)
```
    Sets the response content to the given byte array.
    
    Parameters:
    
    byteContent - content byte array, or null for none.
    If the byte array is null, the method invokes setZeroContent(). Otherwise, byteContent is wrapped in a TestableByteArrayInputStream and becomes this MockLowLevelHttpResponse's contents.
    
    Since:
    
    1.18
  - setZeroContent
```
public MockLowLevelHttpResponse setZeroContent()
```
    Sets the content to null and the content length to 0. Note that the result will have a content length header whose value is 0.
    
    Since:
    
    1.18
  - getContent
```
public InputStream getContent()
                       throws IOException
```
    Description copied from class: LowLevelHttpResponse
    
    Returns the HTTP response content input stream or null for none.
    
    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.
  - getContentLength
```
public long getContentLength()
```
    Description copied from class: LowLevelHttpResponse
    
    Returns the content length or 0 for none.
  - getContentType
```
public final String getContentType()
```
    Description copied from class: LowLevelHttpResponse
    
    Returns the content type or null for none.
  - 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.
  - getHeaderName
```
public String getHeaderName(int index)
```
    Description copied from class: LowLevelHttpResponse
    
    Returns the HTTP response header name at the given zero-based index.
  - getHeaderValue
```
public String getHeaderValue(int index)
```
    Description copied from class: LowLevelHttpResponse
    
    Returns the HTTP response header value at the given zero-based index.
  - getReasonPhrase
```
public String getReasonPhrase()
```
    Description copied from class: LowLevelHttpResponse
    
    Returns the HTTP reason phrase or null for none.
  - getStatusCode
```
public int getStatusCode()
```
    Description copied from class: LowLevelHttpResponse
    
    Returns the response status code or <=0 for none.
  - getStatusLine
```
public String getStatusLine()
```
    Description copied from class: LowLevelHttpResponse
    
    Returns the response status line or null for none.
  - getHeaderNames
```
public final List<String> getHeaderNames()
```
    Returns the list of header names of HTTP response.
    
    Since:
    
    1.5
  - setHeaderNames
```
public MockLowLevelHttpResponse setHeaderNames(List<String> headerNames)
```
    Sets the list of header names of HTTP response.
    Default value is an empty list.
    
    Since:
    
    1.5
  - getHeaderValues
```
public final List<String> getHeaderValues()
```
    Returns the list of header values of HTTP response.
    Default value is an empty list.
    
    Since:
    
    1.5
  - setHeaderValues
```
public MockLowLevelHttpResponse setHeaderValues(List<String> headerValues)
```
    Sets the list of header values of HTTP response.
    
    Since:
    
    1.5
  - setContent
```
public MockLowLevelHttpResponse setContent(InputStream content)
```
    Sets the input stream content of HTTP response or null for none.
    
    Since:
    
    1.5
  - setContentType
```
public MockLowLevelHttpResponse setContentType(String contentType)
```
    Sets the content type of HTTP response or null for none.
    
    Since:
    
    1.5
  - setContentEncoding
```
public MockLowLevelHttpResponse setContentEncoding(String contentEncoding)
```
    Sets the content encoding or null for none.
    
    Since:
    
    1.5
  - setContentLength
```
public MockLowLevelHttpResponse setContentLength(long contentLength)
```
    Sets the content length or -1 for unknown.
    By default it is -1.
    
    Since:
    
    1.5
  - setStatusCode
```
public MockLowLevelHttpResponse setStatusCode(int statusCode)
```
    Sets the status code of HTTP response.
    Default value is 200.
    
    Since:
    
    1.5
  - setReasonPhrase
```
public MockLowLevelHttpResponse setReasonPhrase(String reasonPhrase)
```
    Sets the HTTP reason phrase or null for none.
    
    Since:
    
    1.6
  - disconnect
```
public void disconnect()
                throws IOException
```
    Description copied from class: LowLevelHttpResponse
    
    Default implementation does nothing, but subclasses may override to attempt to abort the connection or release allocated system resources for this connection.
    
    Overrides:
    
    disconnect in class LowLevelHttpResponse
    
    Throws:
    
    IOException - I/O exception
  - isDisconnected
```
public boolean isDisconnected()
```
    Returns whether disconnect() has been called.
    
    Since:
    
    1.14

Class MockLowLevelHttpResponse

Constructor Summary

Constructors

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockLowLevelHttpResponse

Method Detail

addHeader

setContent

setContent

setZeroContent

getContent

getContentEncoding

getContentLength

getContentType

getHeaderCount

getHeaderName

getHeaderValue

getReasonPhrase

getStatusCode

getStatusLine

getHeaderNames

setHeaderNames

getHeaderValues

setHeaderValues

setContent

setContentType

setContentEncoding

setContentLength

setStatusCode

setReasonPhrase

disconnect

isDisconnected