com.yahoo.bard.webservice.web

Class AbstractResponse<T>

java.lang.Object

com.yahoo.bard.webservice.web.AbstractResponse<T>

Type Parameters:

T - the type of the raw data

All Implemented Interfaces:

ResponseStream

Direct Known Subclasses:

CsvResponse, JsonResponse

public abstract class AbstractResponse<T>
extends Object
implements ResponseStream

Formats data of a response as JSON.

Field Summary

Fields

Modifier and Type	Field and Description
protected Stream<T>	entries
protected ObjectMappersSuite	objectMappers
protected Pagination<?>	pages
protected javax.ws.rs.core.UriInfo	uriInfo

Constructor Summary

Constructors

Constructor and Description
AbstractResponse(Stream<T> entries, Pagination<?> pages, javax.ws.rs.core.UriInfo uriInfo, ObjectMappersSuite objectMappers) Constructor.

Method Summary

Modifier and Type	Method and Description
static void	addLink(PaginationLink link, int pageNumber, int perPage, javax.ws.rs.core.UriBuilder uriBuilder, MappingResponseProcessor responseProcessor, Map<String,URI> bodyLinks) Adds the specified link to the headers and to the map of links that will be added to the body of the response.
static void	addLink(PaginationLink link, Pagination<?> pages, javax.ws.rs.core.UriBuilder uriBuilder, Map<String,URI> bodyLinks) Adds the specified link to the headers and body of the response.
static void	addLink(PaginationLink link, Pagination<?> pages, javax.ws.rs.core.UriBuilder uriBuilder, MappingResponseProcessor responseProcessor, Map<String,URI> bodyLinks) Adds the specified link to the headers and body of the response.
static Map<String,Object>	addLinks(Pagination<?> pages, javax.ws.rs.core.UriBuilder uriBuilder) Returns all required pagination links.
static void	addLinks(Pagination<?> pages, javax.ws.rs.core.UriBuilder uriBuilder, MappingResponseProcessor responseProcessor) Adds all the required pagination links to the headers and body of the response.
javax.ws.rs.core.StreamingOutput	getResponseStream() Get a resource method that can be used to stream this response as an entity.
abstract void	write(OutputStream outputStream) Write the response to the output stream.
void	writeMetaObject(com.fasterxml.jackson.core.JsonGenerator generator, javax.ws.rs.core.UriBuilder uriBuilder) Builds the meta data entry of the page if such data is present.

Methods inherited from class java.lang.Object

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

Field Detail

entries

protected final Stream<T> entries

uriInfo

protected final javax.ws.rs.core.UriInfo uriInfo

pages

protected final Pagination<?> pages

objectMappers

protected final ObjectMappersSuite objectMappers

Constructor Detail

AbstractResponse

public AbstractResponse(Stream<T> entries,
                        Pagination<?> pages,
                        javax.ws.rs.core.UriInfo uriInfo,
                        ObjectMappersSuite objectMappers)

Constructor.

Parameters:

entries - The data entries to generate the response for

uriInfo - UriInfo to generate the URL for the page links

pages - The paginated set of results containing the pages being linked to.

objectMappers - Suite of Object Mappers to use when serializing the response

Method Detail

getResponseStream

public javax.ws.rs.core.StreamingOutput getResponseStream()

Get a resource method that can be used to stream this response as an entity.

Specified by:

getResponseStream in interface ResponseStream

Returns:

The resource method

write

public abstract void write(OutputStream outputStream)
                    throws IOException

Write the response to the output stream.

Parameters:

outputStream - Output stream to write to

Throws:

IOException - if there's a problem writing to the stream

addLinks

public static Map<String,Object> addLinks(Pagination<?> pages,
                                          javax.ws.rs.core.UriBuilder uriBuilder)

Returns all required pagination links.

Parameters:

pages - The paginated set of results containing the pages being linked to.

uriBuilder - The builder for creating the pagination links.

Returns:

the map of metadata for this response

addLink

public static void addLink(PaginationLink link,
                           Pagination<?> pages,
                           javax.ws.rs.core.UriBuilder uriBuilder,
                           Map<String,URI> bodyLinks)

Adds the specified link to the headers and body of the response.

Parameters:

link - The type of the link being added

pages - The paginated set of results containing the pages being linked to.

uriBuilder - The builder for creating the pagination links.

bodyLinks - The map of links that will be added to the body of the response

addLinks

public static void addLinks(Pagination<?> pages,
                            javax.ws.rs.core.UriBuilder uriBuilder,
                            MappingResponseProcessor responseProcessor)

Adds all the required pagination links to the headers and body of the response.

Parameters:

pages - The paginated set of results containing the pages being linked to.

uriBuilder - The uri builder to build the links

responseProcessor - The response processor whose links are being built

addLink

public static void addLink(PaginationLink link,
                           Pagination<?> pages,
                           javax.ws.rs.core.UriBuilder uriBuilder,
                           MappingResponseProcessor responseProcessor,
                           Map<String,URI> bodyLinks)

Adds the specified link to the headers and body of the response.

Parameters:

link - The type of the link being added

pages - The paginated set of results containing the pages being linked to.

uriBuilder - The uri builder to build the links

responseProcessor - The response processor whose links are being built

bodyLinks - The map of links that will be added to the body of the response

addLink

public static void addLink(PaginationLink link,
                           int pageNumber,
                           int perPage,
                           javax.ws.rs.core.UriBuilder uriBuilder,
                           MappingResponseProcessor responseProcessor,
                           Map<String,URI> bodyLinks)

Adds the specified link to the headers and to the map of links that will be added to the body of the response.

Parameters:

link - The type of the link being added

pageNumber - The page being linked to

perPage - The number of result rows in the page being linked to

uriBuilder - The uri builder to build the links

responseProcessor - The response processor whose links are being built

bodyLinks - The map of links that will be added to the body of the response

writeMetaObject

public void writeMetaObject(com.fasterxml.jackson.core.JsonGenerator generator,
                            javax.ws.rs.core.UriBuilder uriBuilder)
                     throws IOException

Builds the meta data entry of the page if such data is present. Currently it contains only the pagination related metadata.

Parameters:

generator - The JsonGenerator used to build the JSON response.

uriBuilder - The builder for creating the pagination links.

Throws:

IOException - if the generator throws an IOException.