Module io.helidon.webserver.test.support

Package io.helidon.webserver.testsupport

Class TestRequest

java.lang.Object

io.helidon.webserver.testsupport.TestRequest

public class TestRequest
extends Object

An API to compose a test request.

Method Summary

Modifier and Type	Method	Description
TestResponse	call(io.helidon.common.http.Http.RequestMethod method)	Calls using specified HTTP method with body.
TestResponse	call(io.helidon.common.http.Http.RequestMethod method, MediaPublisher mediaPublisher)	Calls using specified HTTP method with body.
TestResponse	delete()	Calls HTTP DELETE method with body.
TestResponse	delete(MediaPublisher mediaPublisher)	Calls HTTP DELETE method with body.
TestResponse	get()	Calls HTTP GET method with body.
TestResponse	get(MediaPublisher mediaPublisher)	Calls HTTP GET method with body.
TestResponse	head()	Calls HTTP HEAD method with body.
TestResponse	head(MediaPublisher mediaPublisher)	Calls HTTP HEAD method with body.
TestRequest	header(String name, String value)	Add a header.
TestResponse	options()	Calls HTTP OPTIONS method with body.
TestResponse	options(MediaPublisher mediaPublisher)	Calls HTTP OPTIONS method with body.
TestResponse	post()	Calls HTTP POST method with body.
TestResponse	post(MediaPublisher mediaPublisher)	Calls HTTP POST method with body.
TestResponse	put()	Calls HTTP PUT method with body.
TestResponse	put(MediaPublisher mediaPublisher)	Calls HTTP PUT method with body.
TestRequest	queryParameter(String name, String value)	Add a query parameter.
TestResponse	trace()	Calls HTTP TRACE method with body.
TestResponse	trace(MediaPublisher mediaPublisher)	Calls HTTP TRACE method with body.
TestRequest	version(io.helidon.common.http.Http.Version version)	Define an HTTP version.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

queryParameter

public TestRequest queryParameter(String name,
                                  String value)

Add a query parameter.

Parameters:

name - a name.

value - a value.

Returns:

Updated instance.

Throws:

NullPointerException - If name or value parameter is null.

header

public TestRequest header(String name,
                          String value)

Add a header.

Parameters:

name - a name.

value - a value.

Returns:

Updated instance.

Throws:

NullPointerException - If name or value parameter is null.

version

public TestRequest version(io.helidon.common.http.Http.Version version)

Define an HTTP version. Default is HTTP/1.1.

Parameters:

version - a version to set.

Returns:

Updated instance.

Throws:

NullPointerException - If name or value parameter is null.

get

public TestResponse get(MediaPublisher mediaPublisher)
                 throws InterruptedException,
                        TimeoutException

Calls HTTP GET method with body.

Parameters:

mediaPublisher - a request body publisher.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

get

public TestResponse get()
                 throws InterruptedException,
                        TimeoutException

Calls HTTP GET method with body.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

post

public TestResponse post(MediaPublisher mediaPublisher)
                  throws InterruptedException,
                         TimeoutException

Calls HTTP POST method with body.

Parameters:

mediaPublisher - a request body publisher.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

post

public TestResponse post()
                  throws InterruptedException,
                         TimeoutException

Calls HTTP POST method with body.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

put

public TestResponse put(MediaPublisher mediaPublisher)
                 throws InterruptedException,
                        TimeoutException

Calls HTTP PUT method with body.

Parameters:

mediaPublisher - a request body publisher.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

put

public TestResponse put()
                 throws InterruptedException,
                        TimeoutException

Calls HTTP PUT method with body.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

delete

public TestResponse delete(MediaPublisher mediaPublisher)
                    throws InterruptedException,
                           TimeoutException

Calls HTTP DELETE method with body.

Parameters:

mediaPublisher - a request body publisher.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

delete

public TestResponse delete()
                    throws InterruptedException,
                           TimeoutException

Calls HTTP DELETE method with body.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

options

public TestResponse options(MediaPublisher mediaPublisher)
                     throws InterruptedException,
                            TimeoutException

Calls HTTP OPTIONS method with body.

Parameters:

mediaPublisher - a request body publisher.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

options

public TestResponse options()
                     throws InterruptedException,
                            TimeoutException

Calls HTTP OPTIONS method with body.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

head

public TestResponse head(MediaPublisher mediaPublisher)
                  throws InterruptedException,
                         TimeoutException

Calls HTTP HEAD method with body.

Parameters:

mediaPublisher - a request body publisher.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

head

public TestResponse head()
                  throws InterruptedException,
                         TimeoutException

Calls HTTP HEAD method with body.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

trace

public TestResponse trace(MediaPublisher mediaPublisher)
                   throws InterruptedException,
                          TimeoutException

Calls HTTP TRACE method with body.

Parameters:

mediaPublisher - a request body publisher.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

trace

public TestResponse trace()
                   throws InterruptedException,
                          TimeoutException

Calls HTTP TRACE method with body.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

call

public TestResponse call(io.helidon.common.http.Http.RequestMethod method,
                         MediaPublisher mediaPublisher)
                  throws InterruptedException,
                         TimeoutException

Calls using specified HTTP method with body.

Parameters:

method - an HTTP method.

mediaPublisher - a request body publisher.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.

call

public TestResponse call(io.helidon.common.http.Http.RequestMethod method)
                  throws InterruptedException,
                         TimeoutException

Calls using specified HTTP method with body.

Parameters:

method - an HTTP method.

Returns:

a response to read.

Throws:

InterruptedException - if thread is interrupted.

TimeoutException - if request timeout is reached.