Module org.refcodes.web

Package org.refcodes.web

Interface HttpServerRequest

All Superinterfaces:

HeaderFieldsAccessor<RequestHeaderFields>, HttpBodyAccessor, HttpInputStreamAccessor, HttpMethodAccessor, HttpRequest, UrlAccessor

All Known Implementing Classes:

HttpServerRequestImpl

public interface HttpServerRequest
extends HttpRequest, HttpBodyAccessor, HttpInputStreamAccessor

Defines a HttpServerRequest being the request as consumed by the server.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.web.HeaderFieldsAccessor

HeaderFieldsAccessor.HeaderFieldsBuilder<T extends HeaderFields<?,?>,B extends HeaderFieldsAccessor.HeaderFieldsBuilder<T,B>>, HeaderFieldsAccessor.HeaderFieldsMutator<T extends HeaderFields<?,?>>, HeaderFieldsAccessor.HeaderFieldsProperty<T extends HeaderFields<?,?>>

Nested classes/interfaces inherited from interface org.refcodes.web.HttpBodyAccessor

HttpBodyAccessor.HttpBodyBuilder<B extends HttpBodyAccessor.HttpBodyBuilder<B>>, HttpBodyAccessor.HttpBodyMutator, HttpBodyAccessor.HttpBodyProperty, HttpBodyAccessor.HttpBodyProvider<EXC extends Exception>

Nested classes/interfaces inherited from interface org.refcodes.web.HttpInputStreamAccessor

HttpInputStreamAccessor.HttpInputStreamBuilder<B extends HttpInputStreamAccessor.HttpInputStreamBuilder<B>>, HttpInputStreamAccessor.HttpInputStreamMutator, HttpInputStreamAccessor.HttpInputStreamProperty, HttpInputStreamAccessor.HttpInputStreamProvider<EXC extends Exception>

Nested classes/interfaces inherited from interface org.refcodes.web.HttpMethodAccessor

HttpMethodAccessor.HttpMethodBuilder<B extends HttpMethodAccessor.HttpMethodBuilder<B>>, HttpMethodAccessor.HttpMethodMutator, HttpMethodAccessor.HttpMethodProperty

Nested classes/interfaces inherited from interface org.refcodes.web.UrlAccessor

UrlAccessor.UrlBuilder, UrlAccessor.UrlMutator, UrlAccessor.UrlProperty

Method Summary

Modifier and Type	Method	Description
default HttpBodyMap	getRequest()	Retrieves the HttpBodyMap representing the request body.
<REQ> REQ	getRequest(Class<REQ> aRequestType)	Retrieves the object representing the request body.

Methods inherited from interface org.refcodes.web.HeaderFieldsAccessor

getHeaderFields

Methods inherited from interface org.refcodes.web.HttpBodyAccessor

getHttpBody

Methods inherited from interface org.refcodes.web.HttpInputStreamAccessor

getHttpInputStream

Methods inherited from interface org.refcodes.web.HttpMethodAccessor

getHttpMethod

Methods inherited from interface org.refcodes.web.UrlAccessor

getUrl

Method Details

getRequest

<REQ> REQ getRequest(Class<REQ> aRequestType)
              throws BadRequestException

Retrieves the object representing the request body. The HttpServerRequestImpl.getRequest(Class) supports the HttpBodyMap to unmarshal an HTTP Request-Body into an HttpBodyMap when providing the HttpBodyMap as request type.

Type Parameters:

REQ - the generic type

Parameters:

aRequestType - The type of which the request is expected to be.

Returns:

An instance of the type representing the request.

Throws:

BadRequestException - thrown when unmarshaling / deserializing an object fails.

getRequest

default HttpBodyMap getRequest()
                        throws BadRequestException

Retrieves the HttpBodyMap representing the request body.

Returns:

An instance of the HttpBodyMap representing the request.

Throws:

BadRequestException - thrown when unmarshaling / deserializing an object fails.