HttpResponse Class

Package:

com.microsoft.azure.sdk.iot.deps.transport.http

Maven Artifact:

com.microsoft.azure.sdk.iot:iot-deps:0.12.0

• java.lang.Object
• • com.microsoft.azure.sdk.iot.deps.transport.http.HttpResponse

public class HttpResponse

An HTTPS response. Contains the status code, body, header fields, and error reason (if any).

Field Summary

Modifier and Type	Field and Description
protected final byte[]	body
protected final byte[]	errorReason
protected final java.util.Map<java.lang.String,java.lang.String>	headerFields
protected final int	status

Constructor Summary

Modifier	Constructor	Description
protected	HttpResponse()
	HttpResponse(int status, byte[] body, Map<String,List<String>> headerFields, byte[] errorReason)	Constructor.

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	canonicalizeFieldName(String field)
protected static java.lang.String	flattenValuesList(List<String> values)
byte[]	getBody() Getter for the response body.
byte[]	getErrorReason() Getter for the error reason.
java.lang.String	getHeaderField(String field) Getter for a header field.
java.util.Map<java.lang.String,java.lang.String>	getHeaderFields() Getter for the header fields.
int	getStatus() Getter for the HTTPS status code.
boolean	isFieldAvailable(String field)

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Field Details

body

protected final byte[] body

errorReason

protected final byte[] errorReason

headerFields

protected final Map headerFields

status

protected final int status

Constructor Details

HttpResponse

protected HttpResponse()

HttpResponse

public HttpResponse(int status, byte[] body, Map> headerFields, byte[] errorReason)

Constructor.

Parameters:

status - The HTTPS status code.

body - The response body.

headerFields - The map of header field names and the values associated with the field name.

errorReason - The error reason.

Method Details

canonicalizeFieldName

protected static String canonicalizeFieldName(String field)

Parameters:

field

flattenValuesList

protected static String flattenValuesList(List values)

Parameters:

values

getBody

public byte[] getBody()

Getter for the response body.

Returns:

The response body.

getErrorReason

public byte[] getErrorReason()

Getter for the error reason.

Returns:

The error reason.

getHeaderField

public String getHeaderField(String field)

Getter for a header field.

Parameters:

field - the header field name.

Returns:

the header field value. If multiple values are present, they are returned as a comma-separated list according to RFC2616.

getHeaderFields

public Map getHeaderFields()

Getter for the header fields.

Returns:

The copy of the header fields for this response.

getStatus

public int getStatus()

Getter for the HTTPS status code.

Returns:

The HTTPS status code.

isFieldAvailable

public boolean isFieldAvailable(String field)

Parameters:

field