Package org.bonitasoft.web.extension.rest

Class RestApiResponse

java.lang.Object

org.bonitasoft.web.extension.rest.RestApiResponse

public class RestApiResponse
extends Object

A Wrapper of an HTTP Response describe by its:

• Status
• Headers
• Body
• Charset
• Media type
• Cookies

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CHARACTER_SET	default character set
static final String	DEFAULT_MEDIA_TYPE	default media type
static final int	DEFAULT_STATUS	default http status code

Constructor Summary

Constructors

Constructor	Description
RestApiResponse(Serializable response, int httpStatus, Map<String,String> additionalHeaders, List<javax.servlet.http.Cookie> additionalCookies, String mediaType, String characterSet)

Method Summary

Modifier and Type	Method	Description
List<javax.servlet.http.Cookie>	getAdditionalCookies()
Map<String,String>	getAdditionalHeaders()
String	getCharacterSet()
int	getHttpStatus()
String	getMediaType()
Serializable	getResponse()

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_STATUS

public static final int DEFAULT_STATUS

default http status code

See Also:

• Constant Field Values

DEFAULT_CHARACTER_SET

public static final String DEFAULT_CHARACTER_SET

default character set

DEFAULT_MEDIA_TYPE

public static final String DEFAULT_MEDIA_TYPE

default media type

See Also:

• Constant Field Values

Constructor Details

RestApiResponse

public RestApiResponse(Serializable response,
 int httpStatus,
 Map<String,String> additionalHeaders,
 List<javax.servlet.http.Cookie> additionalCookies,
 String mediaType,
 String characterSet)

Method Details

getResponse

public Serializable getResponse()

getHttpStatus

public int getHttpStatus()

getAdditionalHeaders

public Map<String,String> getAdditionalHeaders()

getAdditionalCookies

public List<javax.servlet.http.Cookie> getAdditionalCookies()

getCharacterSet

public String getCharacterSet()

getMediaType

public String getMediaType()