io.muserver

Interface MuRequest

public interface MuRequest

Method Summary

Modifier and Type	Method and Description
Optional<String>	cookie(String name) Gets the value of the client-sent cookie with the given name
Set<Cookie>	cookies() Gets all the client-sent cookies
String	formValue(String name) Gets the form value with the given name, or empty string if there is no form value with that name.
List<String>	formValues(String name) Gets the form values with the given name, or empty list if there is no form value with that name.
Headers	headers()
Optional<InputStream>	inputStream() The input stream of the request, if there was a request body.
Method	method()
String	parameter(String name) Gets the querystring value with the given name, or empty string if there is no parameter with that name.
List<String>	parameters(String name) Gets all the querystring parameters with the given name, or an empty list if none are found.
String	readBodyAsString() Returns the request body as a string.
URI	serverURI() The URI of the request for this server.
URI	uri() The URI of the request at the origin.

Method Detail

method

Method method()

Returns:

The request method, e.g. GET or POST

uri

URI uri()

The URI of the request at the origin.

If behind a reverse proxy, this URI should be the URI that the client saw when making the request.

Returns:

The full request URI

serverURI

URI serverURI()

The URI of the request for this server.

If behind a reverse proxy, this will be different from uri() as it is the actual server URI rather than what the client sees.

Returns:

The full request URI

headers

Headers headers()

Returns:

The request headers

inputStream

Optional<InputStream> inputStream()

The input stream of the request, if there was a request body.

Note: this can only be read once and cannot be used with readBodyAsString(), formValue(String) or formValues(String).

Returns:

Optional.empty() if there is no request body; otherwise the input stream of the request body.

readBodyAsString

String readBodyAsString()
                 throws IOException

Returns the request body as a string.

This is a blocking call which waits until the whole request is available. If you need the raw bytes, or to stream the request body, then use the inputStream() instead.

The content type of the request body is assumed to be UTF-8.

Note: this can only be read once and cannot be used with inputStream() ()}, formValue(String) or formValues(String).

Returns:

The content of the request body, or an empty string if there is no request body

Throws:

IOException - if there is an exception during reading the request, e.g. if the HTTP connection is stopped during a request

parameter

String parameter(String name)

Gets the querystring value with the given name, or empty string if there is no parameter with that name.

If there are multiple parameters with the same name, the first one is returned.

Parameters:

name - The querystring parameter name to get

Returns:

The querystring value, or an empty string

parameters

List<String> parameters(String name)

Gets all the querystring parameters with the given name, or an empty list if none are found.

Parameters:

name - The querystring parameter name to get

Returns:

All values of the parameter with the given name

formValue

String formValue(String name)
          throws IOException

Gets the form value with the given name, or empty string if there is no form value with that name.

If there are multiple form elements with the same name, the first one is returned.

Note: this cannot be called after a call to inputStream() or readBodyAsString()

Parameters:

name - The name of the form element to get

Returns:

The value of the form element with the given name, or an empty string

Throws:

IOException - Thrown when there is an error while reading the form, e.g. if a user closes their browser before the form is fully read into memory.

formValues

List<String> formValues(String name)
                 throws IOException

Gets the form values with the given name, or empty list if there is no form value with that name.

Note: this cannot be called after a call to inputStream() or readBodyAsString()

Parameters:

name - The name of the form element to get

Returns:

All values of the form element with the given name

Throws:

IOException - Thrown when there is an error while reading the form, e.g. if a user closes their browser before the form is fully read into memory.

cookies

Set<Cookie> cookies()

Gets all the client-sent cookies

Returns:

A set of cookie objects

cookie

Optional<String> cookie(String name)

Gets the value of the client-sent cookie with the given name

Parameters:

name - The name of the cookie

Returns:

The cookie, or Optional.empty() if there is no cookie with that name.