software.amazon.awssdk.core.http

Class HttpResponse

java.lang.Object

software.amazon.awssdk.core.http.HttpResponse

All Implemented Interfaces:

Abortable

public final class HttpResponse
extends Object
implements Abortable

Represents an HTTP response returned by an AWS service in response to a service request.

Constructor Summary

Constructors

Constructor and Description
HttpResponse(SdkHttpFullRequest request) Constructs a new HttpResponse associated with the specified request.
HttpResponse(SdkHttpFullRequest request, Abortable abortable)

Method Summary

Modifier and Type	Method and Description
void	abort()
void	addHeader(String name, String value) Adds an HTTP header to the set associated with this response.
InputStream	getContent() Returns the input stream containing the response content.
String	getHeader(String headerName) Looks up a header by name and returns it's value.
Map<String,String>	getHeaders() Returns the HTTP headers returned with this response.
SdkHttpFullRequest	getRequest() Returns the original request associated with this response.
int	getStatusCode() Returns the HTTP status code (ex: 200, 404, etc) associated with this response.
String	getStatusText() Returns the HTTP status text associated with this response.
boolean	isSuccessful() If we get back any 2xx status code, then we know we should treat the service call as successful.
void	setContent(InputStream content) Sets the input stream containing the response content.
void	setStatusCode(int statusCode) Sets the HTTP status code that was returned with this response.
void	setStatusText(String statusText) Sets the HTTP status text returned with this response.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponse

public HttpResponse(SdkHttpFullRequest request)

Constructs a new HttpResponse associated with the specified request.

Parameters:

request - The associated request that generated this response.

HttpResponse

public HttpResponse(SdkHttpFullRequest request,
                    Abortable abortable)

Method Detail

getRequest

public SdkHttpFullRequest getRequest()

Returns the original request associated with this response.

Returns:

The original request associated with this response.

getHeaders

public Map<String,String> getHeaders()

Returns the HTTP headers returned with this response.

Returns:

The set of HTTP headers returned with this HTTP response.

getHeader

public String getHeader(String headerName)

Looks up a header by name and returns it's value. Does case insensitive comparison.

Parameters:

headerName - Name of header to get value for.

Returns:

The header value of the given header. Null if header is not present.

addHeader

public void addHeader(String name,
                      String value)

Adds an HTTP header to the set associated with this response.

Parameters:

name - The name of the HTTP header.

value - The value of the HTTP header.

getContent

public InputStream getContent()

Returns the input stream containing the response content.

Returns:

The input stream containing the response content.

setContent

public void setContent(InputStream content)

Sets the input stream containing the response content.

Parameters:

content - The input stream containing the response content.

getStatusText

public String getStatusText()

Returns the HTTP status text associated with this response.

Returns:

The HTTP status text associated with this response.

setStatusText

public void setStatusText(String statusText)

Sets the HTTP status text returned with this response.

Parameters:

statusText - The HTTP status text (ex: "Not found") returned with this response.

getStatusCode

public int getStatusCode()

Returns the HTTP status code (ex: 200, 404, etc) associated with this response.

Returns:

The HTTP status code associated with this response.

setStatusCode

public void setStatusCode(int statusCode)

Sets the HTTP status code that was returned with this response.

Parameters:

statusCode - The HTTP status code (ex: 200, 404, etc) associated with this response.

isSuccessful

public boolean isSuccessful()

If we get back any 2xx status code, then we know we should treat the service call as successful.

abort

public void abort()

Specified by:

abort in interface Abortable