Package org.restheart.exchange

Class MongoResponse

java.lang.Object

org.restheart.exchange.Exchange<org.bson.BsonValue>

org.restheart.exchange.Response<org.bson.BsonValue>

org.restheart.exchange.ServiceResponse<org.bson.BsonValue>

org.restheart.exchange.BsonResponse

org.restheart.exchange.MongoResponse

Direct Known Subclasses:

GraphQLResponse

public class MongoResponse
extends BsonResponse

Response implementation used by MongoService and backed by BsonValue that provides simplify methods to deal mongo response

Author:

Andrea Di Cesare <andrea@softinstigate.com>

Field Summary

Fields inherited from class org.restheart.exchange.ServiceResponse

content

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	MongoResponse(io.undertow.server.HttpServerExchange exchange)

Method Summary

Modifier and Type	Method	Description
void	addWarning(String warning)
long	getCount()
OperationResult	getDbOperationResult()
List<String>	getWarnings()
static MongoResponse	init(io.undertow.server.HttpServerExchange exchange)
static MongoResponse	of(io.undertow.server.HttpServerExchange exchange)
String	readContent()	Reads the content as a String.
void	rollback(com.mongodb.client.MongoClient mclient)	Helper method to restore a modified document. rollback() can be used when verifing a document after being updated to rollback changes.
void	setCount(long count)
void	setDbOperationResult(OperationResult dbOperationResult)
void	setInError(int code, String message, Throwable t)

Methods inherited from class org.restheart.exchange.BsonResponse

setContent, setContent

Methods inherited from class org.restheart.exchange.ServiceResponse

getContent, getCustomSender, of, setContent, setCustomSender

Methods inherited from class org.restheart.exchange.Response

getContentType, getContentType, getHeader, getHeader, getHeaders, getMDCContext, getStatusCode, setContentType, setContentTypeAsJson, setHeader, setHeader, setInError, setMDCContext, setStatusCode

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

MongoResponse

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

Method Details

init

public static MongoResponse init(io.undertow.server.HttpServerExchange exchange)

of

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

readContent

public String readContent()

Description copied from class: ServiceResponse

Reads the content as a String. This method is used by ResponseSender to generate the response content to send to the client.

Overrides:

readContent in class BsonResponse

Returns:

the content as string

getDbOperationResult

public OperationResult getDbOperationResult()

Returns:

the dbOperationResult

setDbOperationResult

public void setDbOperationResult(OperationResult dbOperationResult)

Parameters:

dbOperationResult - the dbOperationResult to set

getWarnings

public List<String> getWarnings()

Returns:

the warnings

addWarning

public void addWarning(String warning)

Parameters:

warning -

setInError

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

Overrides:

setInError in class BsonResponse

Parameters:

code -

message -

t -

getCount

public long getCount()

Returns:

the count

setCount

public void setCount(long count)

Parameters:

count - the count to set

rollback

public void rollback(com.mongodb.client.MongoClient mclient)
              throws Exception

Helper method to restore a modified document. rollback() can be used when verifing a document after being updated to rollback changes. A common use case is when the request body contains update operators and an Interceptor cannot verify it at InterceptPoint.REQUEST time; it can check it at InterceptPoint.RESPONSE time and restore data if the updated document doest not fullfil the required conditions. Note: rollback() does not support bulk updates.

Parameters:

mclient - the MongoClient instance

Throws:

Exception - in case of any error