Class Request

Same as calling optAttribute(name).orElse(null)

Load all the content into a byte array. If the request has large amounts of data, it will be better to use [[binaryStream()]]. This method will close the stream.

Example

const requestContent = B.net.request.binaryContent();
Copy

Provides a [[Java.IO.ServletInputStream]] to the callback functionto read the requests content. This method will close the stream.

Example

B.net.request.binaryStream(in => {
  let line = in.readLine();
});
Copy

The name of the character encoding used in the body of this request. This property returns an empty string if the request does not specify a character encoding.

Example

const encoding = B.net.request.characterEncoding();
Copy

Example

const B.net.request.setCharacterEncoding('UTF-8');
Copy

Load all the content into a string. If the request has large amounts of data, it will be better to use [[stream]]. This method will close the stream.

Example

const requestContent = B.net.request.content();
Copy

Same as calling optCookie().orElse(null)

Get all the cookies as an object

Example

const cookies = B.net.request.cookies();
const cookieValue = cookies.dog
Copy

Get all the cookies as a Map

Example

const cookies = B.net.request.cookiesAsMap();
const cookieValue = cookies.get('dog');
Copy

Returns the domain part of the request URI

Same as B.net.request.optParameter('foo').map(B.escapeHtml).orElse(null);

This will iterate over all parts of the multipart request, and give you the name and inputstream via callback function.

Similar to protocol() + domain() + path() + queryString()

Returns an object of all the headers this request contains. If the request has no headers, this method returns an empty object.

Retrieves an object from the request.

Same as calling optHeader().orElse(null)

Returns a list of all the header names this request contains. If the request has no headers, this method returns an empty list.

Returns all the values of the specified request header as an list of strings. Some headers, such as Accept-Language can be sent by clients as several headers each with a different value rather than sending the header as a comma separated list.

If the request did not include any headers of the specified name, this method returns an empty list. The header name is case insensitive. You can use this method with any request header.

Provides a stream to read the requests content.

Indicates if the inbound request is coming from a mobile device. Same as calling optHeader("sec-ch-ua-mobile").filter(v => "?1" === v).isPresent()

Is this request a MultiPartMIME request

Returns a boolean indicating whether this request was made using a secure channel, such as HTTPS.

Returns the name of the HTTP method with which this request was made, for example, GET, POST, or PUT. Same as the value of the CGI variable REQUEST_METHOD

Retrieves an optional object from the request.

Get an [[Java.Optional]] cookie by its name.

Example

const cookieValue = B.net.request.optCookie('dog').orElse('mutt');
Copy

Gets an [[Java.Optional]] escaped parameter. Same as B.net.request.optParameter('foo').map(B.escapeHtml);

Returns the optional string of the specified request header. If the request did not include a header of the specified name, this method returns an empty string. If there are multiple headers with the same name, this method returns the first head in the request. The header name is case insensitive. You can use this method with any request header.

Get an [[Java.Optional]] parameters by its name.

Example

const authorization = B.net.request.optParameter('Authorization');
Copy

Same as calling request.optParameter().orElse(null)

Get all the parameter names.

Get a parameter values by its name. If it doesn't exist an empty array will be returned.

Example

const authorization = B.net.request.optParameterValues('Authorization');
Copy

Get all the parameters as an object.

Get all the parameters as a map.

Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request. The web container does not decode this String.

Indicates which OS the inbound request is coming from. Same as calling optHeader("sec-ch-ua-platform").

Returns the part of this request's URL from the protocol name up to the query string in the first line of the HTTP request.

Returns the query string that is contained in the request URL after the path. This method returns an empty string if the URL does not have a query string. Same as the value of the CGI variable QUERY_STRING

Provides a reader to read the requests content.

Returns the fully qualified name of the client or the last proxy that sent the request. If the engine cannot or chooses not to resolve the hostname (to improve performance), this method returns the dotted-string form of the IP address. For HTTP servlets, same as the value of the CGI variable REMOTE_HOST

Returns the Internet Protocol (IP) address of the client or last proxy that sent the request. For HTTP servlets, same as the value of the CGI variable REMOTE_ADDR

Returns the login of the user making this request, if the user has been authenticated, or null if the user has not been authenticated. Whether the user name is sent with each subsequent request depends on the browser and type of authentication. Same as the value of the CGI variable REMOTE_USER.

Removes an object from the request.

Set an object into the request that can be retrieved with getAttribute later.

Provides a [[Java.IO.BufferedReader]] to the callback function to read the requests content. This method will close the stream.

Example

B.net.request.stream(in => {
});
Copy

The path() + queryString()