org.hawkular.inventory.rest

Class ResponseUtil

java.lang.Object

org.hawkular.inventory.rest.ResponseUtil

public final class ResponseUtil
extends Object

Since:

0.0.1

Author:

Lukas Krejci, Heiko W. Rupp

Constructor Summary

Constructors

Constructor and Description
ResponseUtil()

Method Summary

Modifier and Type	Method and Description
static javax.ws.rs.core.Response.ResponseBuilder	created(AbstractElement<?,?> element, javax.ws.rs.core.UriInfo info)
static javax.ws.rs.core.Response.ResponseBuilder	created(AbstractElement element, javax.ws.rs.core.UriInfo info, String id) Deprecated. This is only used by the deprecated REST API
static javax.ws.rs.core.Response.ResponseBuilder	created(Collection<? extends AbstractElement<?,?>> data, javax.ws.rs.core.UriInfo info)
static javax.ws.rs.core.Response.ResponseBuilder	created(javax.ws.rs.core.UriInfo info, Spliterator<String> ids) Deprecated. This returns just ids of the newly created entities in the response. That is not satisfactory.
static void	createPagingHeader(javax.ws.rs.core.Response.ResponseBuilder builder, javax.ws.rs.core.UriInfo uriInfo, Page<?> resultList) Create the paging headers for collections and attach them to the passed builder.
static <T> javax.ws.rs.core.Response.ResponseBuilder	pagedResponse(javax.ws.rs.core.Response.ResponseBuilder response, javax.ws.rs.core.UriInfo uriInfo, com.fasterxml.jackson.databind.ObjectMapper mapper, Page<T> page)
static <T> javax.ws.rs.core.Response.ResponseBuilder	pagedResponse(javax.ws.rs.core.Response.ResponseBuilder response, javax.ws.rs.core.UriInfo uriInfo, Page<T> page, Object data)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResponseUtil

public ResponseUtil()

Method Detail

created

@Deprecated
public static javax.ws.rs.core.Response.ResponseBuilder created(AbstractElement element,
                                                                            javax.ws.rs.core.UriInfo info,
                                                                            String id)

Deprecated. This is only used by the deprecated REST API

This method exists solely to concentrate usage of Response.created(java.net.URI) into one place until this JIRA is resolved somehow.

Parameters:

element - the newly created element. This will be returned in the response body as a JSON payload

info - the UriInfo instance of the current request

id - the ID of a newly created entity under the base

Returns:

the response builder with status 201 and location set to the entity with the provided id.

created

public static javax.ws.rs.core.Response.ResponseBuilder created(AbstractElement<?,?> element,
                                                                javax.ws.rs.core.UriInfo info)
                                                         throws URISyntaxException

Throws:

URISyntaxException

created

@Deprecated
public static javax.ws.rs.core.Response.ResponseBuilder created(javax.ws.rs.core.UriInfo info,
                                                                            Spliterator<String> ids)

Deprecated. This returns just ids of the newly created entities in the response. That is not satisfactory.

Similar to created(AbstractElement, UriInfo, String) but used when more than 1 entity is created during the request.

The provided list of ids is converted to URIs (by merely appending the ids using the UriBuilder.segment(String...) method) and put in the response as its entity.

Parameters:

info - uri info to help with converting ids to URIs

ids - the list of ids of the entities

Returns:

the response builder with status 201 and entity set

created

public static javax.ws.rs.core.Response.ResponseBuilder created(Collection<? extends AbstractElement<?,?>> data,
                                                                javax.ws.rs.core.UriInfo info)

pagedResponse

public static <T> javax.ws.rs.core.Response.ResponseBuilder pagedResponse(javax.ws.rs.core.Response.ResponseBuilder response,
                                                                          javax.ws.rs.core.UriInfo uriInfo,
                                                                          com.fasterxml.jackson.databind.ObjectMapper mapper,
                                                                          Page<T> page)

pagedResponse

public static <T> javax.ws.rs.core.Response.ResponseBuilder pagedResponse(javax.ws.rs.core.Response.ResponseBuilder response,
                                                                          javax.ws.rs.core.UriInfo uriInfo,
                                                                          Page<T> page,
                                                                          Object data)

createPagingHeader

public static void createPagingHeader(javax.ws.rs.core.Response.ResponseBuilder builder,
                                      javax.ws.rs.core.UriInfo uriInfo,
                                      Page<?> resultList)

Create the paging headers for collections and attach them to the passed builder. Those are represented as Link: http headers that carry the URL for the pages and the respective relation.
In addition a X-Total-Count header is created that contains the whole collection size.

Parameters:

builder - The ResponseBuilder that receives the headers

uriInfo - The uriInfo of the incoming request to build the urls

resultList - The collection with its paging information