Module quak.framework.web.model

Package io.john.amiscaray.quak.http.request

Record Class SimpleRequest<T>

java.lang.Object

java.lang.Record

io.john.amiscaray.quak.http.request.SimpleRequest<T>

Type Parameters:

T - The type of the request body.

Record Components:

headers - The headers as a map.

queryParams - The query parameters as a map.

method - The request method.

body - The request body.

attributes - The attributes for the request (for server-side use).

All Implemented Interfaces:

Request<T>

public record SimpleRequest<T>(Map<String,String> headers, Map<String,String> queryParams, RequestMethod method, T body, Map<String,Object> attributes)
extends Record
implements Request<T>

A simple HTTP request.

Constructor Summary

Constructors

Constructor	Description
SimpleRequest(RequestMethod method, T body)	Create a SimpleRequest with empty headers, query params, and attributes.
SimpleRequest(Map<String,String> queryParams)	Create a SimpleRequest with empty headers, a request method of GET, an empty body, and empty attributes.
SimpleRequest(Map<String,String> headers, RequestMethod method, T body)	Create a SimpleRequest with empty queryParams and no attributes.
SimpleRequest(Map<String,String> headers, Map<String,String> queryParams, RequestMethod method, T body, Map<String,Object> attributes)	Creates an instance of a SimpleRequest record class.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	attributes()	Returns the value of the attributes record component.
T	body()	Returns the value of the body record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Map<String,String>	headers()	Returns the value of the headers record component.
RequestMethod	method()	Returns the value of the method record component.
Map<String,String>	queryParams()	Returns the value of the queryParams record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.john.amiscaray.quak.http.request.Request

getJWTAuthToken, getUserAuthentication

Constructor Details

SimpleRequest

public SimpleRequest(Map<String,String> headers,
 RequestMethod method,
 T body)

Create a SimpleRequest with empty queryParams and no attributes.

Parameters:

headers - The headers as a map.

method - The request method.

body - The request body.

SimpleRequest

public SimpleRequest(RequestMethod method,
 T body)

Create a SimpleRequest with empty headers, query params, and attributes.

Parameters:

method - The request method.

body - The request body.

SimpleRequest

public SimpleRequest(Map<String,String> queryParams)

Create a SimpleRequest with empty headers, a request method of GET, an empty body, and empty attributes.

Parameters:

queryParams - The query params.

SimpleRequest

public SimpleRequest(Map<String,String> headers,
 Map<String,String> queryParams,
 RequestMethod method,
 T body,
 Map<String,Object> attributes)

Creates an instance of a SimpleRequest record class.

Parameters:

headers - the value for the headers record component

queryParams - the value for the queryParams record component

method - the value for the method record component

body - the value for the body record component

attributes - the value for the attributes record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

headers

public Map<String,String> headers()

Returns the value of the headers record component.

Specified by:

headers in interface Request<T>

Returns:

the value of the headers record component

queryParams

public Map<String,String> queryParams()

Returns the value of the queryParams record component.

Specified by:

queryParams in interface Request<T>

Returns:

the value of the queryParams record component

method

public RequestMethod method()

Returns the value of the method record component.

Specified by:

method in interface Request<T>

Returns:

the value of the method record component

body

public T body()

Returns the value of the body record component.

Specified by:

body in interface Request<T>

Returns:

the value of the body record component

attributes

public Map<String,Object> attributes()

Returns the value of the attributes record component.

Specified by:

attributes in interface Request<T>

Returns:

the value of the attributes record component