Package org.bonitasoft.web.extension.rest

Class RestApiResponse

java.lang.Object

org.bonitasoft.web.extension.rest.RestApiResponse

public class RestApiResponse
extends java.lang.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 java.lang.String	DEFAULT_CHARACTER_SET	default character set
static java.lang.String	DEFAULT_MEDIA_TYPE	default media type
static int	DEFAULT_STATUS	default http status code

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_STATUS

public static final int DEFAULT_STATUS

default http status code

See Also:

Constant Field Values

DEFAULT_CHARACTER_SET

public static final java.lang.String DEFAULT_CHARACTER_SET

default character set

DEFAULT_MEDIA_TYPE

public static final java.lang.String DEFAULT_MEDIA_TYPE

default media type

See Also:

Constant Field Values

Constructor Detail

RestApiResponse

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

Method Detail

getResponse

public java.io.Serializable getResponse()

getHttpStatus

public int getHttpStatus()

getAdditionalHeaders

public java.util.Map<java.lang.String,java.lang.String> getAdditionalHeaders()

getAdditionalCookies

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

getCharacterSet

public java.lang.String getCharacterSet()

getMediaType

public java.lang.String getMediaType()