org.hawkular.alerts.rest

Class ResponseUtil

java.lang.Object

org.hawkular.alerts.rest.ResponseUtil

public class ResponseUtil
extends Object

Helper class used to build REST responses and deal with errors.

Author:

Lucas Ponce

Constructor Summary

Constructors

Constructor and Description
ResponseUtil()

Method Summary

Modifier and Type	Method and Description
static javax.ws.rs.core.Response	badRequest(String message)
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 javax.ws.rs.core.Response	internalError(String message)
static javax.ws.rs.core.Response	noContent()
static javax.ws.rs.core.Response	notFound(String message)
static javax.ws.rs.core.Response	ok()
static javax.ws.rs.core.Response	ok(Object entity)
static <T> javax.ws.rs.core.Response	paginatedOk(Page<T> page, javax.ws.rs.core.UriInfo uri)

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

internalError

public static javax.ws.rs.core.Response internalError(String message)

noContent

public static javax.ws.rs.core.Response noContent()

notFound

public static javax.ws.rs.core.Response notFound(String message)

ok

public static javax.ws.rs.core.Response ok(Object entity)

paginatedOk

public static <T> javax.ws.rs.core.Response paginatedOk(Page<T> page,
                                                        javax.ws.rs.core.UriInfo uri)

ok

public static javax.ws.rs.core.Response ok()

badRequest

public static javax.ws.rs.core.Response badRequest(String message)

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