Package com.bytedesk.core.black

Class BlackRestController

java.lang.Object

com.bytedesk.core.base.BaseRestController<BlackRequest,BlackRestService>

com.bytedesk.core.black.BlackRestController

@RestController
@RequestMapping("/api/v1/black")
public class BlackRestController
extends BaseRestController<BlackRequest,BlackRestService>

黑名单管理接口

Since:

2024-06-27

Author:

Jackning

Field Summary

Fields

Modifier and Type	Field	Description
private final BlackRestService	blackRestService

Constructor Summary

Constructors

Constructor	Description
BlackRestController()

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<?>	create(BlackRequest request)	创建黑名单
org.springframework.http.ResponseEntity<?>	delete(BlackRequest request)	删除黑名单
org.springframework.http.ResponseEntity<?>	existsByBlackUid(BlackRequest request)	查询当前blackUid是否存在于黑名单中
Object	export(BlackRequest request, jakarta.servlet.http.HttpServletResponse response)	导出黑名单列表
org.springframework.http.ResponseEntity<?>	queryByOrg(BlackRequest request)	根据组织查询黑名单
org.springframework.http.ResponseEntity<?>	queryByUid(BlackRequest request)	根据UID查询黑名单
org.springframework.http.ResponseEntity<?>	queryByUser(BlackRequest request)	根据用户查询黑名单
org.springframework.http.ResponseEntity<?>	unblockByBlackUid(BlackRequest request)
org.springframework.http.ResponseEntity<?>	update(BlackRequest request)	更新黑名单

Methods inherited from class com.bytedesk.core.base.BaseRestController

deleteByOrgUid, exportTemplate, getService

Methods inherited from class java.lang.Object

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

Field Details

blackRestService

private final BlackRestService blackRestService

Constructor Details

BlackRestController

public BlackRestController()

Method Details

queryByOrg

public org.springframework.http.ResponseEntity<?> queryByOrg(BlackRequest request)

根据组织查询黑名单

Overrides:

queryByOrg in class BaseRestController<BlackRequest,BlackRestService>

Parameters:

request - 查询请求

Returns:

分页黑名单列表

queryByUser

public org.springframework.http.ResponseEntity<?> queryByUser(BlackRequest request)

根据用户查询黑名单

Overrides:

queryByUser in class BaseRestController<BlackRequest,BlackRestService>

Parameters:

request - 查询请求

Returns:

分页黑名单列表

queryByUid

public org.springframework.http.ResponseEntity<?> queryByUid(BlackRequest request)

根据UID查询黑名单

Overrides:

queryByUid in class BaseRestController<BlackRequest,BlackRestService>

Parameters:

request - 查询请求

Returns:

黑名单详情

existsByBlackUid

@GetMapping("/exists/blackUid")
public org.springframework.http.ResponseEntity<?> existsByBlackUid(BlackRequest request)

查询当前blackUid是否存在于黑名单中

Parameters:

request - 查询请求

Returns:

黑名单详情

unblockByBlackUid

@PostMapping("/unblock/blackUid")
public org.springframework.http.ResponseEntity<?> unblockByBlackUid(@RequestBody
 BlackRequest request)

create

public org.springframework.http.ResponseEntity<?> create(BlackRequest request)

创建黑名单

Overrides:

create in class BaseRestController<BlackRequest,BlackRestService>

Parameters:

request - 创建请求

Returns:

创建的黑名单

update

public org.springframework.http.ResponseEntity<?> update(BlackRequest request)

更新黑名单

Overrides:

update in class BaseRestController<BlackRequest,BlackRestService>

Parameters:

request - 更新请求

Returns:

更新后的黑名单

delete

public org.springframework.http.ResponseEntity<?> delete(BlackRequest request)

删除黑名单

Overrides:

delete in class BaseRestController<BlackRequest,BlackRestService>

Parameters:

request - 删除请求

Returns:

删除结果

export

public Object export(BlackRequest request,
 jakarta.servlet.http.HttpServletResponse response)

导出黑名单列表

Overrides:

export in class BaseRestController<BlackRequest,BlackRestService>

Parameters:

request - 导出请求

response - HTTP响应

Returns:

导出结果