cn.bestwu.framework.rest.controller

类 RepositoryEntityController

java.lang.Object

cn.bestwu.framework.rest.support.Response

cn.bestwu.framework.rest.controller.BaseController

cn.bestwu.framework.rest.controller.RepositoryEntityController

@ApiSign
 @RepositoryRestController
 @RequestMapping(value="/{repository}")
public class RepositoryEntityController
extends BaseController

Entity 模型 基本控制类 对应资源的CRUD操作API

作者:

Peter Wu

字段概要

从类继承的字段 cn.bestwu.framework.rest.controller.BaseController

BASE_NAME, ID_URI

从类继承的字段 cn.bestwu.framework.rest.support.Response

exact, publisher, request

构造器概要

构造器

构造器和说明
RepositoryEntityController()

方法概要

限定符和类型	方法和说明
java.lang.Object	batchDestroy(RootResourceInformation resourceInformation, java.lang.String... id) 删除多个资源
java.lang.Object	create(RootResourceInformation resourceInformation, PersistentEntityResource resource) 创建资源
java.lang.Object	destroy(RootResourceInformation resourceInformation, java.lang.String id) 删除资源
org.springframework.http.ResponseEntity<?>	headCollectionResource(RootResourceInformation resourceInformation) HEAD /{repsoitory}
org.springframework.http.ResponseEntity<?>	headForItemResource(RootResourceInformation resourceInformation, java.lang.String id) HEAD /{repsoitory}/{id}
java.lang.Object	index(RootResourceInformation resourceInformation, org.springframework.data.domain.Pageable pageable, boolean all) 查看资源列表
org.springframework.http.ResponseEntity<?>	optionsForCollectionResource(RootResourceInformation information) OPTIONS /{repository}.
org.springframework.http.ResponseEntity<?>	optionsForItemResource(RootResourceInformation information) OPTIONS /{repository}/{id}.
java.lang.Object	searchMethod(RootResourceInformation resourceInformation, org.springframework.util.MultiValueMap<java.lang.String,java.lang.Object> parameters, java.lang.String search, org.springframework.data.domain.Pageable pageable) Repository方法搜索
java.lang.Object	show(RootResourceInformation resourceInformation, java.lang.String id) 查看单个资源
java.lang.Object	update(RootResourceInformation resourceInformation, PersistentEntityResource resource, java.lang.String id, ETag eTag) 修改资源

从类继承的方法 cn.bestwu.framework.rest.controller.BaseController

getDefaultPageable, getDefaultPageable, getDeviceInfo, getOldModel, getRealPath, getText, getTextDefaultNull, getUserAgent, hasParameter, hasParameterKey, setRelatedProperty, versionEndsWith, versionEquals

从类继承的方法 cn.bestwu.framework.rest.support.Response

cacheControl, created, getBaseLinkBuilder, getEntitySelfLink, getId, getPersistentEntity, noCache, noCache, noContent, ok, prepareHeaders, updated

从类继承的方法 java.lang.Object

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

构造器详细资料

RepositoryEntityController

public RepositoryEntityController()

方法详细资料

headCollectionResource

@RequestMapping(method=HEAD)
public org.springframework.http.ResponseEntity<?> headCollectionResource(RootResourceInformation resourceInformation)

HEAD /{repsoitory}

参数:

resourceInformation - resourceInformation

返回:

ResponseEntity

headForItemResource

@RequestMapping(value="/{id}",
                method=HEAD)
public org.springframework.http.ResponseEntity<?> headForItemResource(RootResourceInformation resourceInformation,
                                                                                                                                    @PathVariable
                                                                                                                                    java.lang.String id)

HEAD /{repsoitory}/{id}

参数:

resourceInformation - resourceInformation

id - id

返回:

ResponseEntity

optionsForCollectionResource

@RequestMapping(method=OPTIONS)
public org.springframework.http.ResponseEntity<?> optionsForCollectionResource(RootResourceInformation information)

OPTIONS /{repository}.

参数:

information - information

返回:

ResponseEntity

optionsForItemResource

@RequestMapping(value="/{id}",
                method=OPTIONS)
public org.springframework.http.ResponseEntity<?> optionsForItemResource(RootResourceInformation information)

OPTIONS /{repository}/{id}.

参数:

information - information

返回:

ResponseEntity

searchMethod

@RequestMapping(value="/search/{search}",
                method=GET)
public java.lang.Object searchMethod(RootResourceInformation resourceInformation,
                                                                                                             @RequestParam
                                                                                                             org.springframework.util.MultiValueMap<java.lang.String,java.lang.Object> parameters,
                                                                                                             @PathVariable
                                                                                                             java.lang.String search,
                                                                                                             org.springframework.data.domain.Pageable pageable)
                                                                                                      throws java.lang.NoSuchMethodException

Repository方法搜索

参数:

resourceInformation - resourceInformation

parameters - parameters

search - search

pageable - pageable

返回:

return

抛出:

java.lang.NoSuchMethodException - NoSuchMethodException

index

@RequestMapping(method=GET)
public java.lang.Object index(RootResourceInformation resourceInformation,
                                                           org.springframework.data.domain.Pageable pageable,
                                                           boolean all)

查看资源列表

参数:

resourceInformation - resourceInformation

pageable - 分页参数

all - 是否返回所有结果

返回:

return

show

@RequestMapping(value="/{id}",
                method=GET)
public java.lang.Object show(RootResourceInformation resourceInformation,
                                                                                          @PathVariable
                                                                                          java.lang.String id)

查看单个资源

参数:

resourceInformation - resourceInformation

id - id

返回:

return

create

@RequestMapping(method=POST)
public java.lang.Object create(RootResourceInformation resourceInformation,
                                                             PersistentEntityResource resource)

创建资源

参数:

resourceInformation - resourceInformation

resource - 要创建的资源

返回:

return

update

@RequestMapping(value="/{id}",
                method=PUT)
public java.lang.Object update(RootResourceInformation resourceInformation,
                                                                                            PersistentEntityResource resource,
                                                                                            @PathVariable
                                                                                            java.lang.String id,
                                                                                            ETag eTag)

修改资源

参数:

resourceInformation - resourceInformation

resource - resource

id - id

eTag - eTag

返回:

return

destroy

@RequestMapping(value="/{id}",
                method=DELETE)
public java.lang.Object destroy(RootResourceInformation resourceInformation,
                                                                                                @PathVariable
                                                                                                java.lang.String id)

删除资源

参数:

resourceInformation - resourceInformation

id - id

返回:

return

batchDestroy

@RequestMapping(method=DELETE)
public java.lang.Object batchDestroy(RootResourceInformation resourceInformation,
                                                                     java.lang.String... id)
                                                              throws java.lang.IllegalAccessException,
                                                                     java.lang.InstantiationException

删除多个资源

参数:

resourceInformation - resourceInformation

id - id

返回:

return

抛出:

java.lang.IllegalAccessException - IllegalAccessException

java.lang.InstantiationException - InstantiationException