Package ubic.gemma.rest.util

Class Responder

java.lang.Object

ubic.gemma.rest.util.Responder

public class Responder
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	Responder.FilterMethod<T>	A functional interface matching the signature of a paginating service method.

Constructor Summary

Constructors

Constructor	Description
Responder()

Method Summary

Modifier and Type	Method	Description
static <T> FilteredResponseDataObject<T>	filter(List<T> payload, Filters filters)	Produce a FilteredResponseDataObject for a given filtered List.
static <T> LimitedResponseDataObject<T>	limit(List<T> payload, String query, Filters filters, String[] groupBy, Sort sort, Integer limit)
static <T extends IdentifiableValueObject<?>> PaginatedResponseDataObject<T>	paginate(Slice<T> payload, String[] groupBy)	Produce a PaginatedResponseDataObject for a given unfiltered Slice.
static <T extends IdentifiableValueObject<?>> FilteredAndPaginatedResponseDataObject<T>	paginate(Slice<T> payload, Filters filters, String[] groupBy)	Produce a FilteredAndPaginatedResponseDataObject for a given Slice
static <T extends IdentifiableValueObject<?>> FilteredAndPaginatedResponseDataObject<T>	paginate(Responder.FilterMethod<T> filterMethod, Filters filters, String[] groupBy, Sort sort, int offset, int limit)	Paginate using an arbitrary filtering method.
static <T> QueriedAndFilteredResponseDataObject<T>	queryAndFilter(List<T> payload, String query, Filters filters, String[] groupBy, Sort sort)
static <T extends IdentifiableValueObject<?>> QueriedAndFilteredAndPaginatedResponseDataObject<T>	queryAndPaginate(Slice<T> payload, String query, Filters filters, String[] groupBy)
static <T> ResponseDataObject<T>	respond(T payload)	Produce a ResponseDataObject that wraps the given argument.

Methods inherited from class java.lang.Object

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

Constructor Detail

Responder

public Responder()

Method Detail

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

limit

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

paginate

public static <T extends IdentifiableValueObject<?>> PaginatedResponseDataObject<T> paginate(Slice<T> payload,
                                                                                             String[] groupBy)
                                                                                      throws javax.ws.rs.NotFoundException

Produce a PaginatedResponseDataObject for a given unfiltered Slice.

Throws:

javax.ws.rs.NotFoundException

filter

public static <T> FilteredResponseDataObject<T> filter(List<T> payload,
                                                       @Nullable
                                                       Filters filters)

Produce a FilteredResponseDataObject for a given filtered List.

queryAndFilter

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

paginate

public static <T extends IdentifiableValueObject<?>> FilteredAndPaginatedResponseDataObject<T> paginate(Slice<T> payload,
                                                                                                        @Nullable
                                                                                                        Filters filters,
                                                                                                        String[] groupBy)
                                                                                                 throws javax.ws.rs.NotFoundException

Produce a FilteredAndPaginatedResponseDataObject for a given Slice

Throws:

javax.ws.rs.NotFoundException

paginate

public static <T extends IdentifiableValueObject<?>> FilteredAndPaginatedResponseDataObject<T> paginate(Responder.FilterMethod<T> filterMethod,
                                                                                                        @Nullable
                                                                                                        Filters filters,
                                                                                                        String[] groupBy,
                                                                                                        @Nullable
                                                                                                        Sort sort,
                                                                                                        int offset,
                                                                                                        int limit)
                                                                                                 throws javax.ws.rs.NotFoundException

Paginate using an arbitrary filtering method.

Throws:

javax.ws.rs.NotFoundException

queryAndPaginate

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