org.glassfish.jersey.test.util.server

Class ContainerRequestBuilder

java.lang.Object

org.glassfish.jersey.test.util.server.ContainerRequestBuilder

public final class ContainerRequestBuilder
extends Object

Used by unit tests / benchmarks to create mock ContainerRequest instances.

Since:

2.17

Author:

Michal Gajdos, Martin Matula

Method Summary

Modifier and Type	Method and Description
ContainerRequestBuilder	accept(jakarta.ws.rs.core.MediaType... mediaTypes) Add the accepted response media types.
ContainerRequestBuilder	accept(String... mediaTypes) Add the accepted response media types.
ContainerRequest	build() Build a Jersey container request context.
ContainerRequestBuilder	cookie(jakarta.ws.rs.core.Cookie cookie) Add a cookie to be set.
ContainerRequestBuilder	cookies(jakarta.ws.rs.core.Cookie... cookies) Add cookies to be set.
ContainerRequestBuilder	entity(InputStream stream) Set the request entity input stream.
ContainerRequestBuilder	entity(Object entity, ApplicationHandler handler) Set the request entity and entity input stream.
ContainerRequestBuilder	entity(Object entity, org.glassfish.jersey.message.MessageBodyWorkers workers) Set the request entity and entity input stream.
static ContainerRequestBuilder	from(String requestUri, String method, jakarta.ws.rs.core.Configuration configuration) Create new Jersey container request context builder.
static ContainerRequestBuilder	from(String baseUri, String requestUri, String method, jakarta.ws.rs.core.Configuration configuration) Create new Jersey container request context builder.
static ContainerRequestBuilder	from(String baseUri, String requestUri, String method, jakarta.ws.rs.core.SecurityContext securityContext, org.glassfish.jersey.internal.PropertiesDelegate propertiesDelegate, jakarta.ws.rs.core.Configuration configuration) Create new Jersey container request context builder.
static ContainerRequestBuilder	from(URI requestUri, String method, jakarta.ws.rs.core.Configuration configuration) Create new Jersey container request context builder.
static ContainerRequestBuilder	from(URI baseUri, URI requestUri, String method, jakarta.ws.rs.core.Configuration configuration) Create new Jersey container request context builder.
static ContainerRequestBuilder	from(URI baseUri, URI requestUri, String method, jakarta.ws.rs.core.SecurityContext securityContext, org.glassfish.jersey.internal.PropertiesDelegate propertiesDelegate, jakarta.ws.rs.core.Configuration configuration) Create new Jersey container request context builder.
ContainerRequestBuilder	header(String name, Object value) Add an arbitrary header.
ContainerRequestBuilder	type(jakarta.ws.rs.core.MediaType contentType) Add content type of the entity.
ContainerRequestBuilder	type(String contentType) Add content type of the entity.

Methods inherited from class java.lang.Object

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

Method Detail

from

public static ContainerRequestBuilder from(String requestUri,
                                           String method,
                                           jakarta.ws.rs.core.Configuration configuration)

Create new Jersey container request context builder. The builder and built request context are supposed to be used only for testing purposes.

Parameters:

requestUri - request URI.

method - request HTTP method name.

configuration - container request configuration

Returns:

new builder instance.

from

public static ContainerRequestBuilder from(String baseUri,
                                           String requestUri,
                                           String method,
                                           jakarta.ws.rs.core.Configuration configuration)

Create new Jersey container request context builder. The builder and built request context are supposed to be used only for testing purposes.

Parameters:

baseUri - base application URI.

requestUri - request URI.

method - request HTTP method name.

configuration - container request configuration

Returns:

new builder instance.

from

public static ContainerRequestBuilder from(String baseUri,
                                           String requestUri,
                                           String method,
                                           jakarta.ws.rs.core.SecurityContext securityContext,
                                           org.glassfish.jersey.internal.PropertiesDelegate propertiesDelegate,
                                           jakarta.ws.rs.core.Configuration configuration)

Create new Jersey container request context builder. The builder and built request context are supposed to be used only for testing purposes.

Parameters:

baseUri - base application URI.

requestUri - request URI.

method - request HTTP method name.

securityContext - security context of the current request. May be null. The SecurityContext.getUserPrincipal() must return null if the current request has not been authenticated by the container.

propertiesDelegate - custom properties delegate to be used by the context, may be null.

configuration - container request configuration

Returns:

new builder instance.

from

public static ContainerRequestBuilder from(URI requestUri,
                                           String method,
                                           jakarta.ws.rs.core.Configuration configuration)

Create new Jersey container request context builder. The builder and built request context are supposed to be used only for testing purposes.

Parameters:

requestUri - request URI.

method - request HTTP method name.

configuration - container request configuration

Returns:

new builder instance.

from

public static ContainerRequestBuilder from(URI baseUri,
                                           URI requestUri,
                                           String method,
                                           jakarta.ws.rs.core.Configuration configuration)

Create new Jersey container request context builder. The builder and built request context are supposed to be used only for testing purposes.

Parameters:

baseUri - base application URI.

requestUri - request URI.

method - request HTTP method name.

configuration - container request configuration

Returns:

new builder instance.

from

public static ContainerRequestBuilder from(URI baseUri,
                                           URI requestUri,
                                           String method,
                                           jakarta.ws.rs.core.SecurityContext securityContext,
                                           org.glassfish.jersey.internal.PropertiesDelegate propertiesDelegate,
                                           jakarta.ws.rs.core.Configuration configuration)

Create new Jersey container request context builder. The builder and built request context are supposed to be used only for testing purposes.

Parameters:

baseUri - base application URI.

requestUri - request URI.

method - request HTTP method name.

securityContext - security context of the current request. May be null. The SecurityContext.getUserPrincipal() must return null if the current request has not been authenticated by the container.

propertiesDelegate - custom properties delegate to be used by the context, may be null.

configuration - container request configuration

Returns:

new builder instance.

build

public ContainerRequest build()

Build a Jersey container request context. The build container request can be used in ApplicationHandler.apply(org.glassfish.jersey.server.ContainerRequest) method to obtain response from Jersey.

Returns:

testing container request context.

accept

public ContainerRequestBuilder accept(String... mediaTypes)

Add the accepted response media types.

Parameters:

mediaTypes - accepted response media types. If cookie is null then all current headers of the same name will be removed.

Returns:

the updated builder.

accept

public ContainerRequestBuilder accept(jakarta.ws.rs.core.MediaType... mediaTypes)

Add the accepted response media types.

Parameters:

mediaTypes - accepted response media types. If cookie is null then all current headers of the same name will be removed.

Returns:

the updated builder.

entity

public ContainerRequestBuilder entity(InputStream stream)

Set the request entity input stream. Entity null values are ignored.

Parameters:

stream - request entity input stream.

Returns:

the updated builder.

entity

public ContainerRequestBuilder entity(Object entity,
                                      org.glassfish.jersey.message.MessageBodyWorkers workers)

Set the request entity and entity input stream. Entity null values are ignored.

MessageBodyWorkers are used to transform the object into entity input stream required to process the request.

NOTE: Entity transformation into entity input stream doesn't have any impact on benchmarks.

Parameters:

entity - request entity instance.

workers - message body workers to transform entity into entity input stream.

Returns:

the updated builder.

entity

public ContainerRequestBuilder entity(Object entity,
                                      ApplicationHandler handler)

Set the request entity and entity input stream. Entity null values are ignored.

ApplicationHandler is required to obtain MessageBodyWorkers to transform the object into entity input stream used for processing the request.

NOTE: Entity transformation into entity input stream doesn't have any impact on benchmarks.

Parameters:

entity - request entity instance.

handler - application handler to obtain message body workers from.

Returns:

the updated builder.

type

public ContainerRequestBuilder type(String contentType)

Add content type of the entity.

Parameters:

contentType - content media type.

Returns:

the updated builder.

type

public ContainerRequestBuilder type(jakarta.ws.rs.core.MediaType contentType)

Add content type of the entity.

Parameters:

contentType - content media type.

Returns:

the updated builder.

header

public ContainerRequestBuilder header(String name,
                                      Object value)

Add an arbitrary header.

Parameters:

name - the name of the header

value - the value of the header, the header will be serialized using a RuntimeDelegate.HeaderDelegate if one is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the class of value or using its toString method if a header delegate is not available. If value is null then all current headers of the same name will be removed.

Returns:

the updated builder.

cookie

public ContainerRequestBuilder cookie(jakarta.ws.rs.core.Cookie cookie)

Add a cookie to be set.

Parameters:

cookie - to be set. If cookie is null then all current headers of the same name will be removed.

Returns:

the updated builder.

cookies

public ContainerRequestBuilder cookies(jakarta.ws.rs.core.Cookie... cookies)

Add cookies to be set.

Parameters:

cookies - to be set. If cookies is null then all current headers of the same name will be removed.

Returns:

the updated builder.