Package org.restheart.exchange

Class ServiceRequest<T>

java.lang.Object

org.restheart.exchange.Exchange<T>

org.restheart.exchange.Request<T>

org.restheart.exchange.ServiceRequest<T>

Type Parameters:

T - generic type

Direct Known Subclasses:

BsonFromCsvRequest, BsonRequest, ByteArrayRequest, GraphQLRequest, JsonRequest, StringRequest, UninitializedRequest

public abstract class ServiceRequest<T>
extends Request<T>

Base class for Request implementations that can be used in service requests. Only one request object can be instantiated per exchage. The request object is instantiated by ServiceExchangeInitializer using the requestInitializer() function defined by the handling service

Author:

Andrea Di Cesare <andrea@softinstigate.com>

Field Summary

Fields

Modifier and Type	Field	Description
protected T	content
static final io.undertow.util.AttachmentKey<Boolean>	CONTENT_INJECTED	CONTENT_INJECTED is true if the request body has been already injected. calling setContent() and setFileInputStream() sets CONTENT_INJECTED to true.

Fields inherited from class org.restheart.exchange.Request

PATCH, PIPELINE_INFO_KEY, SLASH, UNDERSCORE

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

Method Summary

Modifier and Type	Method	Description
T	getContent()	Retrieves the content of the request.
final boolean	isContentInjected()
boolean	isHandledBy(String serviceName)
static ServiceRequest<?>	of(io.undertow.server.HttpServerExchange exchange)
static <R extends ServiceRequest<?>> R	of(io.undertow.server.HttpServerExchange exchange, Class<R> type)
abstract T	parseContent()	Parses the content from the exchange and converts it into an instance of the specified type T.
void	setContent(T content)
final void	setContentInjected(boolean value)

Methods inherited from class org.restheart.exchange.Request

addXForwardedHeader, blockForTooManyRequests, getAuthenticatedAccount, getContentType, getContentType, getCookie, getHeader, getHeaders, getMethod, getPath, getPathParam, getPathParams, getPipelineInfo, getPipelineInfo, getQueryParameterOfDefault, getQueryParameterOrDefault, getQueryParameters, getQueryString, getRequestContentLength, getStartTime, getURL, getXForwardedHeaders, isAuthenticated, isBlockForTooManyRequests, isDelete, isGet, isOptions, isPatch, isPost, isPut, pipelineInfo, setContentLength, setContentType, setContentTypeAsJson, setHeader, setHeader, setPipelineInfo, setPipelineInfo, setStartTime

Methods inherited from class org.restheart.exchange.Exchange

getExchange, getWrappedExchange, isAccountInRole, 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

Field Details

content

protected T content

CONTENT_INJECTED

public static final io.undertow.util.AttachmentKey<Boolean> CONTENT_INJECTED

CONTENT_INJECTED is true if the request body has been already injected. calling setContent() and setFileInputStream() sets CONTENT_INJECTED to true. calling getContent() or getFileInputStream() when CONTENT_INJECTED=false triggers content injection via MongoRequestContentInjector

Constructor Details

ServiceRequest

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

Method Details

of

public static ServiceRequest<?> of(io.undertow.server.HttpServerExchange exchange)

of

public static <R extends ServiceRequest<?>> R of(io.undertow.server.HttpServerExchange exchange,
 Class<R> type)

getContent

public T getContent()
             throws BadRequestException

Retrieves the content of the request. If the content has not been previously read, this method invokes parseContent() to parse and attach the content to the request. If an error occurs during the parsing of the content, the request is marked as errored, indicating that the content could not be successfully parsed and attached.

Returns:

the content of the request, which may be newly parsed or previously retrieved

Throws:

BadRequestException

setContent

public void setContent(T content)

parseContent

public abstract T parseContent()
                        throws IOException,
BadRequestException

Parses the content from the exchange and converts it into an instance of the specified type T. This method retrieves data from the exchange, interprets it according to the expected format, and attempts to convert this data into an object of type T.

Returns:

an instance of T representing the parsed content

Throws:

IOException - if an IO error occurs

BadRequestException - if the content does not match the expected format for type T

isHandledBy

public boolean isHandledBy(String serviceName)

Parameters:

serviceName -

Returns:

true if the request is handled by the specified Service

isContentInjected

public final boolean isContentInjected()

setContentInjected

public final void setContentInjected(boolean value)