org.resthub.web.controller

Class ServiceBasedRestController<T,ID extends Serializable,S extends CrudService>

java.lang.Object

org.resthub.web.controller.ServiceBasedRestController<T,ID,S>

Type Parameters:

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

ID - Resource id type, usually Long or String

S - The service class

All Implemented Interfaces:

RestController<T,ID>

public abstract class ServiceBasedRestController<T,ID extends Serializable,S extends CrudService>
extends Object
implements RestController<T,ID>

Abstract REST controller using a service implementation

You should extend this class when you want to use a 3 layers pattern : Repository, Service and Controller If you don't have a real service (also called business layer), consider using RepositoryBasedRestController

Default implementation uses "id" field (usually a Long) in order to identify resources in web request. If your want to identity resources by a slug (human readable identifier), your should override findById() method with for example :

 
   @Override
   public Sample findById(@PathVariable String id) {
        Sample sample = this.service.findByName(id);
        if (sample == null) {
            throw new NotFoundException();
        }
        return sample;
   }
   
 

See Also:

RepositoryBasedRestController

Field Summary

Fields

Modifier and Type	Field and Description
protected S	service

Constructor Summary

Constructors

Constructor and Description
ServiceBasedRestController()

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 /?page=no
Iterable<T>	findAllXml() XML findAll is currently unimplemented, see https://github.com/FasterXML/jackson-dataformat-xml/issues/38 for more details
T	findById(ID id) Find a resource by its identifier REST webservice published : GET /{id}
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?page=0&size=20 or GET /search?page=0&size=20&direction=desc&properties=name
void	setService(S service) You should override this setter in order to inject your service with @Inject annotation
T	update(ID id, T resource) Update an existing resource REST webservice published : PUT /{id}

Methods inherited from class java.lang.Object

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

Field Detail

service

protected S extends CrudService service

Constructor Detail

ServiceBasedRestController

public ServiceBasedRestController()

Method Detail

setService

public void setService(S service)

You should override this setter in order to inject your service with @Inject annotation

Parameters:

service - The service to be injected

create

public T create(@RequestBody
       T resource)

Create a new resource
REST webservice published : POST /

Specified by:

create in interface RestController<T,ID extends Serializable>

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

public T update(@PathVariable
       ID id,
       @RequestBody
       T resource)

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

Specified by:

update in interface RestController<T,ID extends Serializable>

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

findAllXml

public Iterable<T> findAllXml()

XML findAll is currently unimplemented, see https://github.com/FasterXML/jackson-dataformat-xml/issues/38 for more details

Specified by:

findAllXml in interface RestController<T,ID extends Serializable>

Returns:

findAll

public Iterable<T> findAll()

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

Specified by:

findAll in interface RestController<T,ID extends Serializable>

Returns:

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

findPaginated

public 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="")
                                                    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

Specified by:

findPaginated in interface RestController<T,ID extends Serializable>

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

public T findById(@PathVariable
         ID id)

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

Specified by:

findById in interface RestController<T,ID extends Serializable>

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

delete

public void delete()

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

Specified by:

delete in interface RestController<T,ID extends Serializable>

delete

public 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

Specified by:

delete in interface RestController<T,ID extends Serializable>

Parameters:

id - The identifier of the resource to delete