org.exoplatform.acceptance.rest.administration

Class CRUDController<T extends StorableObject,I extends Serializable>

java.lang.Object

org.exoplatform.acceptance.rest.administration.CRUDController<T,I>

Direct Known Subclasses:

CredentialCRUDController, VCSRepositoryCRUDController

public abstract class CRUDController<T extends StorableObject,I extends Serializable>
extends Object

Abstract REST Controller

Since:

2.0.0

Author:

Arnaud Héritier ( aheritier@exoplatform.com )

Constructor Summary

Constructors

Constructor and Description
CRUDController()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteObject(String id) Delete an existing object
protected abstract CRUDService<T>	getCRUDService() getCRUDService.
T	getObject(String id, javax.servlet.http.HttpServletResponse response) Get a specific object by its id.
Iterable<T>	getObjects(int offset, int limit) Get a (potentially paginated) list of objects
T	saveObject(T object) Save a new object
T	updateObject(I id, T object, javax.servlet.http.HttpServletResponse response) Update an existing object

Methods inherited from class java.lang.Object

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

Constructor Detail

CRUDController

public CRUDController()

Method Detail

getCRUDService

protected abstract CRUDService<T> getCRUDService()

getCRUDService.

Returns:

a CRUDService object.

getObjects

@RequestMapping(method=GET)
@ResponseBody
public Iterable<T> getObjects(@RequestParam(value="offset",defaultValue="0")
                                                 int offset,
                                                 @RequestParam(value="limit",defaultValue="-1")
                                                 int limit)

Get a (potentially paginated) list of objects

Parameters:

offset - the page number to get (0 by default is the first page)

limit - the maximum number of entries in the page of results ( > 0 to activate pagination, -1 thus everything by default )

Returns:

a list of objects

getObject

@RequestMapping(value="{id}",
                method=GET)
@ResponseBody
public T getObject(@PathVariable(value="id")
                                      String id,
                                      javax.servlet.http.HttpServletResponse response)

Get a specific object by its id.

Parameters:

id - the id of the object

response - a HttpServletResponse object.

Returns:

the object

saveObject

@RequestMapping(method=POST,
                consumes="application/json")
@ResponseBody
public T saveObject(@RequestBody
                                       T object)

Save a new object

Parameters:

object - the object to save

Returns:

the saved object

updateObject

@RequestMapping(value="{id}",
                method=PUT,
                consumes="application/json")
@ResponseBody
public T updateObject(@PathVariable(value="id")
                                         I id,
                                         @RequestBody
                                         T object,
                                         javax.servlet.http.HttpServletResponse response)

Update an existing object

Parameters:

id - the id of the object to update

object - the object to update

response - a HttpServletResponse object.

Returns:

the updated object

deleteObject

@RequestMapping(value="{id}",
                method=DELETE)
@ResponseStatus(value=NO_CONTENT)
public void deleteObject(@PathVariable(value="id")
                                              String id)

Delete an existing object

Parameters:

id - the id of the object to delete