Package org.restheart.exchange

Class Response<T>

java.lang.Object

org.restheart.exchange.Exchange<T>

org.restheart.exchange.Response<T>

Type Parameters:

T - generic type

Direct Known Subclasses:

ProxyResponse, ServiceResponse

public abstract class Response<T>
extends Exchange<T>

The root class for implementing a Response providing the implementation for common methods

Author:

Andrea Di Cesare <andrea@softinstigate.com>

Field Summary

Fields inherited from class org.restheart.exchange.Exchange

APPLICATION_PDF_TYPE, FORM_URLENCODED, HAL_JSON_MEDIA_TYPE, IN_ERROR_KEY, JSON_MEDIA_TYPE, MAX_BUFFERS, MAX_CONTENT_SIZE, MULTIPART, TEXT_PLAIN_CONTENT_TYPE, wrapped

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Response(io.undertow.server.HttpServerExchange exchange)

Method Summary

Modifier and Type	Method	Description
String	getContentType()
static String	getContentType(io.undertow.server.HttpServerExchange exchange)
String	getHeader(io.undertow.util.HttpString name)	note: an header can have multiple values.
String	getHeader(String name)	note: an header can have multiple values.
io.undertow.util.HeaderMap	getHeaders()
Map<String,String>	getMDCContext()	Logging MDC Context is bound to the thread.
int	getStatusCode()
static Response	of(io.undertow.server.HttpServerExchange exchange)
void	setContentType(String responseContentType)
void	setContentTypeAsJson()	sets Content-Type=application/json
void	setHeader(io.undertow.util.HttpString name, String value)	note: an header can have multiple values.
void	setHeader(String name, String value)	note: an header can have multiple values.
void	setInError(int code, String message)
abstract void	setInError(int code, String message, Throwable t)
void	setMDCContext(Map<String,String> mdcCtx)
void	setStatusCode(int responseStatusCode)

Methods inherited from class org.restheart.exchange.Exchange

getExchange, getWrappedExchange, isAccountInRole, isAuthenticated, isAuthenticated, isContentTypeFormOrMultipart, isContentTypeFormOrMultipart, isContentTypeJson, isContentTypeJson, isContentTypeText, isContentTypeXml, isInError, isInError, responseInterceptorsExecuted, setInError, setInError, setResponseInterceptorsExecuted, updateBufferSize

Methods inherited from class java.lang.Object

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

Constructor Details

Response

protected Response(io.undertow.server.HttpServerExchange exchange)

Method Details

of

public static Response of(io.undertow.server.HttpServerExchange exchange)

getContentType

public static String getContentType(io.undertow.server.HttpServerExchange exchange)

getContentType

public String getContentType()

Specified by:

getContentType in class Exchange<T>

Returns:

the responseContentType

setContentType

public void setContentType(String responseContentType)

Parameters:

responseContentType - the responseContentType to set

setContentTypeAsJson

public void setContentTypeAsJson()

sets Content-Type=application/json

getStatusCode

public int getStatusCode()

Returns:

the responseStatusCode of -1 if not set

setStatusCode

public void setStatusCode(int responseStatusCode)

Parameters:

responseStatusCode - the responseStatusCode to set

getHeaders

public io.undertow.util.HeaderMap getHeaders()

Returns:

the response headers

getHeader

public String getHeader(io.undertow.util.HttpString name)

note: an header can have multiple values. This only returns the first one. use getHeaders() to get all the header's values

Parameters:

name - the name of the header to return

Returns:

the first value of the response header

getHeader

public String getHeader(String name)

note: an header can have multiple values. This only returns the first one. use getHeaders() to get all the header's values

Parameters:

name - the name of the header to return

Returns:

the first value of the response header

setHeader

public void setHeader(io.undertow.util.HttpString name,
 String value)

note: an header can have multiple values. This sets the given value clearing existing ones. use getHeaders().add(value) to add the value without clearing.

Parameters:

name - the name of the header to return

setHeader

public void setHeader(String name,
 String value)

note: an header can have multiple values. This sets the given value clearing existing ones. use getHeaders().add(value) to add the value without clearing.

Parameters:

name - the name of the header to return

getMDCContext

public Map<String,String> getMDCContext()

Logging MDC Context is bound to the thread. In case of a thread switch it must be restored from response.getMDCContext() with MDC.setContextMap()

Returns:

the MDC Context

setMDCContext

public void setMDCContext(Map<String,String> mdcCtx)

setInError

public abstract void setInError(int code,
 String message,
 Throwable t)

Parameters:

code -

message -

t - can be null

setInError

public void setInError(int code,
 String message)

Parameters:

code -

message -