org.oncoblocks.centromere.web.controller

Class AbstractApiController<T extends Model<ID>,ID extends Serializable>

java.lang.Object

org.oncoblocks.centromere.web.controller.AbstractApiController<T,ID>

All Implemented Interfaces:

WebServicesController<T,ID>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

CrudApiController, ReadOnlyApiController

public abstract class AbstractApiController<T extends Model<ID>,ID extends Serializable>
extends Object
implements WebServicesController<T,ID>, org.springframework.context.ApplicationContextAware

Base abstract implementation of WebServicesController for GET, HEAD, and OPTIONS requests. Supports dynamic queries of repository resources using annotated Model classes, field filtering, pagination, and hypermedia support.

Author:

woemler

Constructor Summary

Constructors

Constructor and Description
AbstractApiController(RepositoryOperations<T,ID> repository, Class<T> model, org.springframework.hateoas.mvc.ResourceAssemblerSupport<T,FilterableResource> assembler)

Method Summary

Modifier and Type	Method and Description
org.springframework.http.HttpEntity<?>	find(org.springframework.data.domain.Pageable pageable, org.springframework.data.web.PagedResourcesAssembler<T> pagedResourcesAssembler, javax.servlet.http.HttpServletRequest request) Queries the repository using inputted query string paramters, defined within a annotated Model classes.
org.springframework.http.HttpEntity<?>	findById(ID id, javax.servlet.http.HttpServletRequest request) GET /{id} Fetches a single record by its primary ID and returns it, or a Not Found exception if not.
org.springframework.http.HttpEntity<?>	findDistinct(String field, javax.servlet.http.HttpServletRequest request) GET /distinct Fetches the distinct values of the model attribute, field, which fulfill the given query parameters.
org.springframework.hateoas.mvc.ResourceAssemblerSupport<T,FilterableResource>	getAssembler()
Class<T>	getModel()
RepositoryOperations<T,ID>	getRepository()
org.springframework.http.HttpEntity<?>	head(javax.servlet.http.HttpServletRequest request) HEAD /** Performs a test on the resource endpoints availability.
org.springframework.http.HttpEntity<?>	options(javax.servlet.http.HttpServletRequest request) OPTIONS / Returns an information about the endpoint and available parameters.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oncoblocks.centromere.web.controller.WebServicesController

create, delete, update

Constructor Detail

AbstractApiController

public AbstractApiController(RepositoryOperations<T,ID> repository,
                             Class<T> model,
                             org.springframework.hateoas.mvc.ResourceAssemblerSupport<T,FilterableResource> assembler)

Method Detail

findById

@RequestMapping(value="/{id}",
                method=GET,
                produces={"application/hal+json","application/json","application/hal+xml","application/xml","text/plain"})
public org.springframework.http.HttpEntity<?> findById(@PathVariable
                                                                                                                                                                                                                                             ID id,
                                                                                                                                                                                                                                             javax.servlet.http.HttpServletRequest request)

GET /{id} Fetches a single record by its primary ID and returns it, or a Not Found exception if not.

Specified by:

findById in interface WebServicesController<T extends Model<ID>,ID extends Serializable>

Parameters:

id - primary ID for the target record.

Returns:

T instance

findDistinct

@RequestMapping(value="/distinct",
                method=GET,
                produces={"application/hal+json","application/json","application/hal+xml","application/xml","text/plain"})
public org.springframework.http.HttpEntity<?> findDistinct(@RequestParam
                                                                                                                                                                                                                                                     String field,
                                                                                                                                                                                                                                                     javax.servlet.http.HttpServletRequest request)

GET /distinct Fetches the distinct values of the model attribute, field, which fulfill the given query parameters.

Specified by:

findDistinct in interface WebServicesController<T extends Model<ID>,ID extends Serializable>

Parameters:

field - Name of the model attribute to retrieve unique values of.

request - HttpServletRequest

Returns:

find

@RequestMapping(value="",
                method=GET,
                produces={"application/json","application/hal+json","application/hal+xml","application/xml","text/plain"})
public org.springframework.http.HttpEntity<?> find(@PageableDefault(size=1000)
                                                                                                                                                                                                                                    org.springframework.data.domain.Pageable pageable,
                                                                                                                                                                                                                                    org.springframework.data.web.PagedResourcesAssembler<T> pagedResourcesAssembler,
                                                                                                                                                                                                                                    javax.servlet.http.HttpServletRequest request)

Queries the repository using inputted query string paramters, defined within a annotated Model classes. Supports hypermedia, pagination, sorting, field filtering, and field exclusion.

Specified by:

find in interface WebServicesController<T extends Model<ID>,ID extends Serializable>

Parameters:

pagedResourcesAssembler - PagedResourcesAssembler

request - HttpServletRequest

Returns:

head

@RequestMapping(value={"","/**"},
                method=HEAD)
public org.springframework.http.HttpEntity<?> head(javax.servlet.http.HttpServletRequest request)

HEAD /** Performs a test on the resource endpoints availability.

Specified by:

head in interface WebServicesController<T extends Model<ID>,ID extends Serializable>

Returns:

options

@RequestMapping(method=OPTIONS)
public org.springframework.http.HttpEntity<?> options(javax.servlet.http.HttpServletRequest request)

OPTIONS / Returns an information about the endpoint and available parameters. TODO

Specified by:

options in interface WebServicesController<T extends Model<ID>,ID extends Serializable>

Returns:

getRepository

public RepositoryOperations<T,ID> getRepository()

getAssembler

public org.springframework.hateoas.mvc.ResourceAssemblerSupport<T,FilterableResource> getAssembler()

getModel

public Class<T> getModel()

setApplicationContext

@Autowired
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware