org.resthub.web.controller

Interface RestController<T,ID extends Serializable>

Type Parameters:

T - Your resource POJO to manage, maybe an entity or DTO class

ID - Primary resource identifier at webservice level, usually Long or String

All Known Implementing Classes:

RepositoryBasedRestController, ServiceBasedRestController

public interface RestController<T,ID extends Serializable>

REST controller interface

Method Summary

Methods

Modifier and Type	Method and Description
T	create(T resource) Create a new resource REST webservice published : POST /
void	delete() Delete all resources REST webservice published : DELETE / Return No Content http status code if the request has been correctly processed
void	delete(ID id) Delete a resource by its identifier REST webservice published : DELETE /{id} Return No Content http status code if the request has been correctly processed
Iterable<T>	findAll() Find all resources, and return the full collection (plain list not paginated) REST webservice published : GET /?
T	findById(ID id) Find a resource by its identifier REST webservice published : GET /{id}
Iterable<T>	findByIds(Set<ID> ids) Find multiple resources by their identifiers REST webservice published : GET /?
org.springframework.data.domain.Page<T>	findPaginated(Integer page, Integer size, String direction, String properties) Find all resources, and return a paginated and optionaly sorted collection REST webservice published : GET /search?
T	update(ID id, T resource) Update an existing resource REST webservice published : PUT /{id}

Method Detail

create

@RequestMapping(method=POST)
@ResponseStatus(value=CREATED)
@ResponseBody
T create(@RequestBody
                                                  T resource)

Create a new resource
REST webservice published : POST /

Parameters:

resource - The resource to create

Returns:

CREATED http status code if the request has been correctly processed, with updated resource enclosed in the body, usually with and additional identifier automatically created by the database

update

@RequestMapping(value="{id}",
                method=PUT)
@ResponseBody
T update(@PathVariable
                                   ID id,
                                   @RequestBody
                                   T resource)

Update an existing resource
REST webservice published : PUT /{id}

Parameters:

id - The identifier of the resource to update, usually a Long or String identifier. It is explicitely provided in order to handle cases where the identifier could be changed.

resource - The resource to update

Returns:

OK http status code if the request has been correctly processed, with the updated resource enclosed in the body

Throws:

NotFoundException

findAll

@RequestMapping(method=GET,
                params="page=no")
@ResponseBody
Iterable<T> findAll()

Find all resources, and return the full collection (plain list not paginated)
REST webservice published : GET /?page=no

Returns:

OK http status code if the request has been correctly processed, with the list of all resource enclosed in the body. Be careful, this list should be big since it will return ALL resources. In this case, consider using paginated findAll method instead.

findPaginated

@RequestMapping(method=GET)
@ResponseBody
org.springframework.data.domain.Page<T> findPaginated(@RequestParam(value="page",required=false,defaultValue="1")
                                                                                Integer page,
                                                                                @RequestParam(value="size",required=false,defaultValue="10")
                                                                                Integer size,
                                                                                @RequestParam(value="direction",required=false,defaultValue="ASC")
                                                                                String direction,
                                                                                @RequestParam(value="properties",required=false)
                                                                                String properties)

Find all resources, and return a paginated and optionaly sorted collection
REST webservice published : GET /search?page=0&size=20 or GET /search?page=0&size=20&direction=desc&properties=name

Parameters:

page - Page number starting from 0. default to 0

size - Number of resources by pages. default to 10

direction - Optional sort direction, could be "asc" or "desc"

properties - Ordered list of comma separeted properies used for sorting resulats. At least one property should be provided if direction is specified

Returns:

OK http status code if the request has been correctly processed, with the a paginated collection of all resource enclosed in the body.

findById

@RequestMapping(value="{id}",
                method=GET)
@ResponseBody
T findById(@PathVariable
                                     ID id)

Find a resource by its identifier
REST webservice published : GET /{id}

Parameters:

id - The identifier of the resouce to find

Returns:

OK http status code if the request has been correctly processed, with resource found enclosed in the body

Throws:

NotFoundException

findByIds

@RequestMapping(method=GET,
                params="ids[]")
@ResponseBody
Iterable<T> findByIds(@RequestParam(value="ids[]")
                                                Set<ID> ids)

Find multiple resources by their identifiers
REST webservice published : GET /?ids[]=

example : /?ids[]=1&ids[]=2&ids[]=3

Parameters:

ids - List of ids to retrieve

Returns:

OK http status code with list of retrieved resources. Not found resources are ignored: no Exception thrown. List is empty if no resource found with any of the given ids.

delete

@RequestMapping(method=DELETE)
@ResponseStatus(value=NO_CONTENT)
void delete()

Delete all resources
REST webservice published : DELETE /
Return No Content http status code if the request has been correctly processed

delete

@RequestMapping(value="{id}",
                method=DELETE)
@ResponseStatus(value=NO_CONTENT)
void delete(@PathVariable
                                        ID id)

Delete a resource by its identifier
REST webservice published : DELETE /{id}
Return No Content http status code if the request has been correctly processed

Parameters:

id - The identifier of the resource to delete

Throws:

NotFoundException