org.oncoblocks.centromere.web.controller

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

java.lang.Object

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

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

All Implemented Interfaces:

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

public class ReadOnlyApiController<T extends Model<ID>,ID extends Serializable>
extends AbstractApiController<T,ID>

Extension of AbstractApiController that throws a MethodNotAllowedException when POST, PUT, or DELETE operations are attempted.

Author:

woemler

Constructor Summary

Constructors

Constructor and Description
ReadOnlyApiController(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<?>	create(T entity, javax.servlet.http.HttpServletRequest request) POST / Attempts to create a new record using the submitted entity.
org.springframework.http.HttpEntity<?>	delete(ID id, javax.servlet.http.HttpServletRequest request) DELETE /{id} Attempts to delete the an entity identified by the submitted primary ID.
org.springframework.http.HttpEntity<?>	update(T entity, ID id, javax.servlet.http.HttpServletRequest request) PUT /{id} Attempts to update an existing entity record, replacing it with the submitted entity.

Methods inherited from class org.oncoblocks.centromere.web.controller.AbstractApiController

find, findById, findDistinct, getAssembler, getModel, getRepository, head, options, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadOnlyApiController

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

Method Detail

create

@RequestMapping(value="",
                method=POST,
                produces={"application/json","application/hal+json","application/hal+xml","application/xml","text/plain"})
public org.springframework.http.HttpEntity<?> create(@RequestBody
                                                                                                                                                                                                                                       T entity,
                                                                                                                                                                                                                                       javax.servlet.http.HttpServletRequest request)

POST / Attempts to create a new record using the submitted entity. Throws an exception if the entity already exists.

Returns:

updated representation of the submitted entity

update

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

PUT /{id} Attempts to update an existing entity record, replacing it with the submitted entity. Throws an exception if the target entity does not exist.

Returns:

updated representation of the submitted entity.

delete

@RequestMapping(value="/{id}",
                method=DELETE)
public org.springframework.http.HttpEntity<?> delete(@PathVariable
                                                                                                                   ID id,
                                                                                                                   javax.servlet.http.HttpServletRequest request)

DELETE /{id} Attempts to delete the an entity identified by the submitted primary ID.

Returns:

HttpStatus indicating success or failure.