Package com.reallifedeveloper.common.resource

Class TestResource

java.lang.Object

com.reallifedeveloper.common.resource.BaseResource

com.reallifedeveloper.common.resource.TestResource

@Path("/{path:.*}")
public class TestResource
extends BaseResource

A JAX-RS resource that can be used for testing REST clients. This resource accepts all requests, and you can specify the responses given using the reset(Response...) method.

See TestResourceTest for an example of how to use this class.

Author:

RealLifeDeveloper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TestResource.RequestInfo	Information about an HTTP request.

Field Summary

Fields inherited from class com.reallifedeveloper.common.resource.BaseResource

API_KEY_HTTP_HEADER, API_KEY_QUERY_PARAMETER, CACHE_1_HOUR, DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
TestResource()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	delete(String path)
jakarta.ws.rs.core.Response	get(String path)
jakarta.ws.rs.core.Response	head(String path)
jakarta.ws.rs.core.Response	options(String path)
jakarta.ws.rs.core.Response	post(String path, String postData)
jakarta.ws.rs.core.Response	put(String path, String putData)
List<TestResource.RequestInfo>	requests()	Gives a list of TestResource.RequestInfo objects representing the requests that have reached this resource.
void	reset(jakarta.ws.rs.core.Response... newResponses)	Resets the resource so that it starts to respond with the given responses.

Methods inherited from class com.reallifedeveloper.common.resource.BaseResource

commaSeparatedStringToList, handleError, logger, parseDate, parseUrl

Methods inherited from class java.lang.Object

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

Constructor Details

TestResource

public TestResource()

Method Details

get

@GET
public jakarta.ws.rs.core.Response get(@PathParam("path")
 String path)

post

@POST
public jakarta.ws.rs.core.Response post(@PathParam("path")
 String path,
 String postData)

put

@PUT
public jakarta.ws.rs.core.Response put(@PathParam("path")
 String path,
 String putData)

delete

@DELETE
public jakarta.ws.rs.core.Response delete(@PathParam("path")
 String path)

head

@HEAD
public jakarta.ws.rs.core.Response head(@PathParam("path")
 String path)

options

@OPTIONS
public jakarta.ws.rs.core.Response options(@PathParam("path")
 String path)

reset

public void reset(jakarta.ws.rs.core.Response... newResponses)

Resets the resource so that it starts to respond with the given responses.

Parameters:

newResponses - the responses to give

requests

public List<TestResource.RequestInfo> requests()

Gives a list of TestResource.RequestInfo objects representing the requests that have reached this resource.

Returns:

a list of RequestInfo objects