com.adobe.granite.haf.api

Interface ApiResponse

public interface ApiResponse

An interface for providing the framework with custom values to be used in the response. An instance of ApiResponse is read only. To create an ApiResponse use ApiResponseBuilder.

Method Summary

Modifier and Type	Method and Description
Iterable<Modification>	getChanges()
Resource	getEntity() Get the entity to be used as the body in the response.
Map<String,String[]>	getHeaders() Get the HTTP headers to be added to the response.
Integer	getStatusCode() Get the HTTP status code to be used in the response.
String	getStatusMessage() Get the HTTP status message to be used in the response.

Method Detail

getStatusCode

Integer getStatusCode()

Get the HTTP status code to be used in the response.

Returns:

The HTTP status code

getStatusMessage

String getStatusMessage()

Get the HTTP status message to be used in the response.

Returns:

The HTTP status message

getHeaders

Map<String,String[]> getHeaders()

Get the HTTP headers to be added to the response.

Returns:

The HTTP headers

getEntity

Resource getEntity()

Get the entity to be used as the body in the response. The entity must be a Resource that can be understood by the HTTP API framework.

Returns:

The entity Resouce to be used as the response body.

getChanges

Iterable<Modification> getChanges()