Package ubic.gemma.rest.util

Class Responders

java.lang.Object

ubic.gemma.rest.util.Responders

public class Responders
extends Object

Handles setting of the response status code and composing a proper payload structure.

Author:

tesarst

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Responders.FilterMethod<T>	A functional interface matching the signature of a paginating service method.

Constructor Summary

Constructors

Constructor	Description
Responders()

Method Summary

Modifier and Type	Method	Description
static <T> QueriedAndFilteredResponseDataObject<T>	all(List<T> payload, String query, Filters filters, String[] groupBy, Sort sort)
static <T> FilteredResponseDataObject<T>	all(List<T> payload, Filters filters, String[] groupBy, Sort sort)	Produce all results.
static <T> PaginatedResponseDataObject<T>	paginate(Slice<T> payload, String[] groupBy)	Paginate results.
static <T> QueriedAndFilteredAndPaginatedResponseDataObject<T>	paginate(Slice<T> payload, String query, Filters filters, String[] groupBy)	Paginate results with a filter and a full-text query.
static <T> FilteredAndPaginatedResponseDataObject<T>	paginate(Slice<T> payload, Filters filters, String[] groupBy)	Paginate results with a filter.
static <T> FilteredAndPaginatedResponseDataObject<T>	paginate(Responders.FilterMethod<T> filterMethod, Filters filters, String[] groupBy, Sort sort, int offset, int limit)	Paginate results with a filter using a callback to produce the payload.
static <T> ResponseDataObject<T>	respond(T payload)	Produce a ResponseDataObject that wraps the given argument.
static javax.ws.rs.core.Response.ResponseBuilder	sendfile(Path file)
static <T> FilteredAndLimitedResponseDataObject<T>	top(List<T> payload, Filters filters, String[] groupBy, Sort sort, Integer limit)	Produce top results.

Methods inherited from class java.lang.Object

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

Constructor Details

Responders

public Responders()

Method Details

sendfile

public static javax.ws.rs.core.Response.ResponseBuilder sendfile(Path file)

respond

public static <T> ResponseDataObject<T> respond(@Nullable
 T payload)
                                         throws javax.ws.rs.NotFoundException

Produce a ResponseDataObject that wraps the given argument.

Parameters:

payload - an object to be wrapped and published to the API

Returns:

a ResponseDataObject containing the argument

Throws:

javax.ws.rs.NotFoundException - if the argument is null, a suitable ResponseErrorObject will be subsequently produced by NotFoundExceptionMapper

all

public static <T> FilteredResponseDataObject<T> all(List<T> payload,
 @Nullable
 Filters filters,
 String[] groupBy,
 @Nullable
 Sort sort)

Produce all results.

all

public static <T>
QueriedAndFilteredResponseDataObject<T> all(List<T> payload,
 @Nullable
 String query,
 @Nullable
 Filters filters,
 String[] groupBy,
 @Nullable
 Sort sort)

top

public static <T>
FilteredAndLimitedResponseDataObject<T> top(List<T> payload,
 @Nullable
 Filters filters,
 String[] groupBy,
 @Nullable
 Sort sort,
 Integer limit)

Produce top results.

paginate

public static <T> PaginatedResponseDataObject<T> paginate(Slice<T> payload,
 String[] groupBy)

Paginate results.

paginate

public static <T>
FilteredAndPaginatedResponseDataObject<T> paginate(Slice<T> payload,
 @Nullable
 Filters filters,
 String[] groupBy)

Paginate results with a filter.

paginate

public static <T>
FilteredAndPaginatedResponseDataObject<T> paginate(Responders.FilterMethod<T> filterMethod,
 @Nullable
 Filters filters,
 String[] groupBy,
 @Nullable
 Sort sort,
 int offset,
 int limit)

Paginate results with a filter using a callback to produce the payload.

paginate

public static <T>
QueriedAndFilteredAndPaginatedResponseDataObject<T> paginate(Slice<T> payload,
 String query,
 @Nullable
 Filters filters,
 String[] groupBy)

Paginate results with a filter and a full-text query.