- 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.HttpMethodPropertyNested classes/interfaces inherited from interface org.refcodes.web.UrlAccessor
UrlAccessor.UrlBuilder, UrlAccessor.UrlMutator, UrlAccessor.UrlProperty -
Method Summary
Modifier and Type Method Description default HttpBodyMapgetRequest()Retrieves theHttpBodyMaprepresenting the request body.<REQ> REQgetRequest(Class<REQ> aRequestType)Retrieves the object representing the request body.Methods inherited from interface org.refcodes.web.HeaderFieldsAccessor
getHeaderFieldsMethods inherited from interface org.refcodes.web.HttpBodyAccessor
getHttpBodyMethods inherited from interface org.refcodes.web.HttpInputStreamAccessor
getHttpInputStreamMethods inherited from interface org.refcodes.web.HttpMethodAccessor
getHttpMethodMethods inherited from interface org.refcodes.web.UrlAccessor
getUrl
-
Method Details
-
getRequest
Retrieves the object representing the request body. TheHttpServerRequestImpl.getRequest(Class)supports theHttpBodyMapto unmarshal an HTTP Request-Body into anHttpBodyMapwhen providing theHttpBodyMapas 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
Retrieves theHttpBodyMaprepresenting the request body.- Returns:
- An instance of the
HttpBodyMaprepresenting the request. - Throws:
BadRequestException- thrown when unmarshaling / deserializing an object fails.
-