AQWebResponse (OpenAPI)

```
public interface AQWebResponse
```
The AQWebResponse interface maintains the data returned from a successfully processed AQWebRequest via the AQWebClient interface.
The status of a submitted request can be checked by one of these methods:
The response headers can be retrieved via one the following methods:
The entire response body can be retrieved by calling one of these methods:
- getContentString() - as a string
- getContentBytes() - as an array of bytes
- getContent() - as a java Object
The response body can also be saved to a file by calling the saveContent(String fileName) method.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAcceptRangesHeader()` Returns the value of the `Accept-Ranges` response header.
`java.lang.String`	`getAgeHeader()` Returns the value of the `Age` response header.
`java.lang.String`	`getAllowHeader()` Returns the value of the `Allow` entity header.
`java.lang.String`	`getCacheControlHeader()` Returns the value of the `Cache-Control` general header.
`java.lang.String`	`getConnectionHeader()` Returns the value of the `Connection` general header.
`java.lang.Object`	`getContent()` Returns the response body as an object.
`byte[]`	`getContentBytes()` Returns the response body as an array of bytes.
`java.lang.String`	`getContentEncodingHeader()` Returns the value of the `Content-Encoding` entity header.
`java.lang.String`	`getContentLanguageHeader()` Returns the value of the `Content-Language` entity header.
`int`	`getContentLengthHeader()` Returns the value of the `Content-Length` entity header.
`java.lang.String`	`getContentLocationHeader()` Returns the value of the `Content-Location` entity header.
`java.lang.String`	`getContentMD5Header()` Returns the value of the `Content-MD5` entity header.
`java.lang.String`	`getContentRangeHeader()` Returns the value of the `Content-Range` entity header.
`java.lang.String`	`getContentString()` Returns the response body as a string.
`java.lang.String`	`getContentTypeHeader()` Returns the value of the `Content-Type` entity header.
`java.lang.String`	`getDateHeader()` Returns the value of the `Date` general header.
`java.lang.String`	`getETagHeader()` Returns the value of the `ETag` response header.
`java.lang.String`	`getExpiresHeader()` Returns the value of the `Expires` entity header.
`java.lang.String`	`getHeaderField(java.lang.String name)` Returns the header value associated with the given header name.
`java.util.List<java.lang.String>`	`getHeaderFields(java.lang.String name)` Returns the header values associated with the given header name.
`java.util.Map<java.lang.String,java.util.List<java.lang.String>>`	`getHeaderMap()` Returns all of headers this response currently has.
`java.lang.String`	`getLastModifiedHeader()` Returns the value of the `Last-Modified` entity header.
`java.lang.String`	`getLocationHeader()` Returns the value of the `Location` response header.
`java.lang.String`	`getPragmaHeader()` Returns the value of the `Pragma` general header.
`java.lang.String`	`getProxyAuthenticateHeader()` Returns the value of the `Proxy-Authenticate` response header.
`AQWebRequest`	`getRequest()` Returns the request object that produces this response.
`java.lang.String`	`getRetryAfterHeader()` Returns the value of the `Retry-After` response header.
`java.lang.String`	`getServerHeader()` Returns the value of the `Server` response header.
`int`	`getStatusCode()` Returns the response status code.
`java.lang.String`	`getStatusLine()` Returns the response status line.
`java.lang.String`	`getStatusText()` Returns the response status text.
`java.lang.String`	`getTrailerHeader()` Returns the value of the `Trailer` general header.
`java.lang.String`	`getTransferEncodingHeader()` Returns the value of the `Transfer-Encoding` general header.
`java.lang.String`	`getUpgradeHeader()` Returns the value of the `Upgrade` general header.
`java.lang.String`	`getVaryHeader()` Returns the value of the `Vary` response header.
`java.lang.String`	`getViaHeader()` Returns the value of the `Via` general header.
`java.lang.String`	`getWarningHeader()` Returns the value of the `Warning` general header.
`java.lang.String`	`getWWWAuthenticateHeader()` Returns the value of the `WWW-Authenticate` response header.
`void`	`saveContent(java.lang.String fileName)` Saves the response body to a file.
`java.lang.String`	`toString(boolean showDetail)` Returns a string representation of this object.

- Method Detail
  - getRequest
```
AQWebRequest getRequest()
```
    Returns the request object that produces this response.
    
    Returns:
    
    the request object that produces this response.
  - getStatusCode
```
int getStatusCode()
```
    Returns the response status code.
    
    Returns:
    
    the response status code
  - getStatusText
```
java.lang.String getStatusText()
```
    Returns the response status text.
    
    Returns:
    
    the response status text
  - getStatusLine
```
java.lang.String getStatusLine()
```
    Returns the response status line.
    
    Returns:
    
    the response status line
  - getContent
```
java.lang.Object getContent()
```
    Returns the response body as an object.
    
    Returns:
    
    the response body
  - getContentString
```
java.lang.String getContentString()
```
    Returns the response body as a string.
    
    Returns:
    
    the response body
  - getContentBytes
```
byte[] getContentBytes()
```
    Returns the response body as an array of bytes.
    
    Returns:
    
    the response body
  - saveContent
```
void saveContent(java.lang.String fileName)
          throws java.lang.Exception
```
    Saves the response body to a file.
    
    Parameters:
    
    fileName - the name of the file where response body to be saved
    
    Throws:
    
    java.lang.Exception - if fileName is null or cannot be accessed
  - getHeaderMap
```
java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaderMap()
```
    Returns all of headers this response currently has. The key of the map entry is the header name and corresponding entry value is a list of possible header values.
    
    Returns:
    
    a map containing all of response headers
  - getHeaderFields
```
java.util.List<java.lang.String> getHeaderFields(java.lang.String name)
```
    Returns the header values associated with the given header name.
    
    Parameters:
    
    name - the name of the header
    
    Returns:
    
    a list of zero or more values
  - getHeaderField
```
java.lang.String getHeaderField(java.lang.String name)
```
    Returns the header value associated with the given header name. If multiple values are found, only the last value is returned.
    
    Parameters:
    
    name - the name of the header
    
    Returns:
    
    the header value or null if header name is not defined
  - getCacheControlHeader
```
java.lang.String getCacheControlHeader()
```
    Returns the value of the Cache-Control general header.
    
    Returns:
    
    the header value or null if the Cache-Control header is not defined
  - getConnectionHeader
```
java.lang.String getConnectionHeader()
```
    Returns the value of the Connection general header.
    
    Returns:
    
    the header value or null if the Connection header is not defined
  - getDateHeader
```
java.lang.String getDateHeader()
```
    Returns the value of the Date general header.
    
    Returns:
    
    the header value or null if the Date header is not defined
  - getPragmaHeader
```
java.lang.String getPragmaHeader()
```
    Returns the value of the Pragma general header.
    
    Returns:
    
    the header value or null if the Pragma header is not defined
  - getTrailerHeader
```
java.lang.String getTrailerHeader()
```
    Returns the value of the Trailer general header.
    
    Returns:
    
    the header value or null if the Trailer header is not defined
  - getTransferEncodingHeader
```
java.lang.String getTransferEncodingHeader()
```
    Returns the value of the Transfer-Encoding general header.
    
    Returns:
    
    the header value or null if the Transfer-Encoding header is not defined
  - getUpgradeHeader
```
java.lang.String getUpgradeHeader()
```
    Returns the value of the Upgrade general header.
    
    Returns:
    
    the header value or null if the Upgrade header is not defined
  - getViaHeader
```
java.lang.String getViaHeader()
```
    Returns the value of the Via general header.
    
    Returns:
    
    the header value or null if the Via header is not defined
  - getWarningHeader
```
java.lang.String getWarningHeader()
```
    Returns the value of the Warning general header.
    
    Returns:
    
    the header value or null if the Warning header is not defined
  - getAllowHeader
```
java.lang.String getAllowHeader()
```
    Returns the value of the Allow entity header.
    
    Returns:
    
    the header value or null if the Allow header is not defined
  - getContentEncodingHeader
```
java.lang.String getContentEncodingHeader()
```
    Returns the value of the Content-Encoding entity header.
    
    Returns:
    
    the header value or null if the Content-Encoding header is not defined
  - getContentLanguageHeader
```
java.lang.String getContentLanguageHeader()
```
    Returns the value of the Content-Language entity header.
    
    Returns:
    
    the header value or null if the Content-Language header is not defined
  - getContentLengthHeader
```
int getContentLengthHeader()
```
    Returns the value of the Content-Length entity header.
    
    Returns:
    
    the header value or null if the Content-Length header is not defined
  - getContentLocationHeader
```
java.lang.String getContentLocationHeader()
```
    Returns the value of the Content-Location entity header.
    
    Returns:
    
    the header value or null if the Content-Location header is not defined
  - getContentMD5Header
```
java.lang.String getContentMD5Header()
```
    Returns the value of the Content-MD5 entity header.
    
    Returns:
    
    the header value or null if the Content-MD5 header is not defined
  - getContentRangeHeader
```
java.lang.String getContentRangeHeader()
```
    Returns the value of the Content-Range entity header.
    
    Returns:
    
    the header value or null if the Content-Range header is not defined
  - getContentTypeHeader
```
java.lang.String getContentTypeHeader()
```
    Returns the value of the Content-Type entity header.
    
    Returns:
    
    the header value or null if the Content-Type header is not defined
  - getExpiresHeader
```
java.lang.String getExpiresHeader()
```
    Returns the value of the Expires entity header.
    
    Returns:
    
    the header value or null if the Expires header is not defined
  - getLastModifiedHeader
```
java.lang.String getLastModifiedHeader()
```
    Returns the value of the Last-Modified entity header.
    
    Returns:
    
    the header value or null if the Last-Modified header is not defined
  - getAcceptRangesHeader
```
java.lang.String getAcceptRangesHeader()
```
    Returns the value of the Accept-Ranges response header.
    
    Returns:
    
    the header value or null if the Accept-Ranges header is not defined
  - getAgeHeader
```
java.lang.String getAgeHeader()
```
    Returns the value of the Age response header.
    
    Returns:
    
    the header value or null if the Age header is not defined
  - getETagHeader
```
java.lang.String getETagHeader()
```
    Returns the value of the ETag response header.
    
    Returns:
    
    the header value or null if the ETag header is not defined
  - getLocationHeader
```
java.lang.String getLocationHeader()
```
    Returns the value of the Location response header.
    
    Returns:
    
    the header value or null if the Location header is not defined
  - getProxyAuthenticateHeader
```
java.lang.String getProxyAuthenticateHeader()
```
    Returns the value of the Proxy-Authenticate response header.
    
    Returns:
    
    the header value or null if the Proxy-Authenticate header is not defined
  - getRetryAfterHeader
```
java.lang.String getRetryAfterHeader()
```
    Returns the value of the Retry-After response header.
    
    Returns:
    
    the header value or null if the Retry-After header is not defined
  - getServerHeader
```
java.lang.String getServerHeader()
```
    Returns the value of the Server response header.
    
    Returns:
    
    the header value or null if the Server header is not defined
  - getVaryHeader
```
java.lang.String getVaryHeader()
```
    Returns the value of the Vary response header.
    
    Returns:
    
    the header value or null if the Vary header is not defined
  - getWWWAuthenticateHeader
```
java.lang.String getWWWAuthenticateHeader()
```
    Returns the value of the WWW-Authenticate response header.
    
    Returns:
    
    the header value or null if the WWW-Authenticate header is not defined
  - toString
```
java.lang.String toString(boolean showDetail)
```
    Returns a string representation of this object.
    
    Parameters:
    
    showDetail - include response body content if set to true
    
    Returns:
    
    a string representation of this object

Interface AQWebResponse

Method Summary

Method Detail

getRequest

getStatusCode

getStatusText

getStatusLine

getContent

getContentString

getContentBytes

saveContent

getHeaderMap

getHeaderFields

getHeaderField

getCacheControlHeader

getConnectionHeader

getDateHeader

getPragmaHeader

getTrailerHeader

getTransferEncodingHeader

getUpgradeHeader

getViaHeader

getWarningHeader

getAllowHeader

getContentEncodingHeader

getContentLanguageHeader

getContentLengthHeader

getContentLocationHeader

getContentMD5Header

getContentRangeHeader

getContentTypeHeader

getExpiresHeader

getLastModifiedHeader

getAcceptRangesHeader

getAgeHeader

getETagHeader

getLocationHeader

getProxyAuthenticateHeader

getRetryAfterHeader

getServerHeader

getVaryHeader

getWWWAuthenticateHeader

toString