Skip to content

[Improvement] Add permission annotation for interface #227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SteNicholas merged 2 commits into from
May 20, 2024
Merged

[Improvement] Add permission annotation for interface #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77d022b
add permission annotation.
May 14, 2024
d8d1d3b
code style.
May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ...n-web-server/src/main/java/org/apache/paimon/web/server/controller/CatalogController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.apache.paimon.web.server.data.result.enums.Status;
import org.apache.paimon.web.server.service.CatalogService;

import cn.dev33.satoken.annotation.SaCheckPermission;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
Expand Down Expand Up @@ -53,6 +54,7 @@ public CatalogController(CatalogService catalogService) {
* @param catalogDTO The catalogDTO for the catalog
* @return A response indicating the success or failure of the operation
*/
@SaCheckPermission("metadata:catalog:create")
@PostMapping("/create")
public R<Void> createCatalog(@RequestBody CatalogDTO catalogDTO) {
try {
Expand All @@ -71,6 +73,7 @@ public R<Void> createCatalog(@RequestBody CatalogDTO catalogDTO) {
*
* @return The list of all catalogs
*/
@SaCheckPermission("metadata:catalog:list")
@GetMapping("/list")
public R<List<CatalogInfo>> getCatalog() {
List<CatalogInfo> catalogs = catalogService.list();
Expand All @@ -83,6 +86,7 @@ public R<List<CatalogInfo>> getCatalog() {
* @param catalogDTO Given the catalog name or catalog id to remove catalog
* @return A response indicating the success or failure of the operation
*/
@SaCheckPermission("metadata:catalog:remove")
@PostMapping("/remove")
public R<Void> removeCatalog(@RequestBody CatalogDTO catalogDTO) {
boolean remove;
Expand Down
6 changes: 6 additions & 0 deletions ...ver/src/main/java/org/apache/paimon/web/server/controller/CdcJobDefinitionController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.apache.paimon.web.server.data.result.R;
import org.apache.paimon.web.server.service.CdcJobDefinitionService;

import cn.dev33.satoken.annotation.SaCheckPermission;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
Expand All @@ -47,16 +48,19 @@ public CdcJobDefinitionController(CdcJobDefinitionService cdcJobDefinitionServic
this.cdcJobDefinitionService = cdcJobDefinitionService;
}

@SaCheckPermission("cdc:job:create")
@PostMapping("create")
public R<Void> createCdcJob(@RequestBody CdcJobDefinitionDTO cdcJobDefinitionDTO) {
return cdcJobDefinitionService.create(cdcJobDefinitionDTO);
}

@SaCheckPermission("cdc:job:update")
@PutMapping("update")
public R<Void> updateCdcJob(@RequestBody CdcJobDefinitionDTO cdcJobDefinitionDTO) {
return cdcJobDefinitionService.update(cdcJobDefinitionDTO);
}

@SaCheckPermission("cdc:job:list")
@GetMapping("list")
public PageR<CdcJobDefinition> listAllCdcJob(
@RequestParam(required = false) boolean withConfig,
Expand All @@ -65,6 +69,7 @@ public PageR<CdcJobDefinition> listAllCdcJob(
return cdcJobDefinitionService.listAll(withConfig, currentPage, pageSize);
}

@SaCheckPermission("cdc:job:query")
@GetMapping("/{id}")
public R<CdcJobDefinition> getById(@PathVariable Integer id) {
CdcJobDefinition cdcJobDefinition = cdcJobDefinitionService.getById(id);
Expand All @@ -74,6 +79,7 @@ public R<CdcJobDefinition> getById(@PathVariable Integer id) {
return R.succeed(cdcJobDefinition);
}

@SaCheckPermission("cdc:job:delete")
@DeleteMapping("{id}")
public R<Void> deleteById(@PathVariable Integer id) {
cdcJobDefinitionService.removeById(id);
Expand Down
4 changes: 4 additions & 0 deletions ...-web-server/src/main/java/org/apache/paimon/web/server/controller/DatabaseController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import org.apache.paimon.web.server.data.vo.DatabaseVO;
import org.apache.paimon.web.server.service.DatabaseService;

import cn.dev33.satoken.annotation.SaCheckPermission;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
Expand Down Expand Up @@ -52,6 +53,7 @@ public DatabaseController(DatabaseService databaseService) {
* @param databaseDTO The details of the database to create
* @return a {@code R<Void>} response indicating success or failure
*/
@SaCheckPermission("metadata:database:create")
@PostMapping("/create")
public R<Void> createDatabase(@RequestBody DatabaseDTO databaseDTO) {
if (databaseService.databaseExists(databaseDTO)) {
Expand All @@ -67,6 +69,7 @@ public R<Void> createDatabase(@RequestBody DatabaseDTO databaseDTO) {
*
* @return The list of databases of given catalog id
*/
@SaCheckPermission("metadata:database:list")
@GetMapping("/list")
public R<List<DatabaseVO>> listDatabases(
@RequestParam(value = "catalogId", required = false) Integer catalogId) {
Expand All @@ -79,6 +82,7 @@ public R<List<DatabaseVO>> listDatabases(
* @param databaseDTO The database to be dropped
* @return a {@code R<Void>} response indicating success or failure
*/
@SaCheckPermission("metadata:database:drop")
@PostMapping("/drop")
public R<Void> dropDatabase(@RequestBody DatabaseDTO databaseDTO) {
return databaseService.dropDatabase(databaseDTO)
Expand Down
6 changes: 6 additions & 0 deletions ...-web-server/src/main/java/org/apache/paimon/web/server/controller/MetadataController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import org.apache.paimon.web.server.data.vo.SnapshotVO;
import org.apache.paimon.web.server.service.MetadataService;

import cn.dev33.satoken.annotation.SaCheckPermission;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
Expand All @@ -47,26 +48,31 @@ public MetadataController(MetadataService metadataService) {
this.metadataService = metadataService;
}

@SaCheckPermission("metadata:schema:list")
@PostMapping("/schema")
public R<List<SchemaVO>> getSchemaInfo(@RequestBody MetadataDTO dto) {
return R.succeed(metadataService.getSchema(dto));
}

@SaCheckPermission("metadata:snapshot:list")
@PostMapping("/snapshot")
public R<List<SnapshotVO>> getSnapshotInfo(@RequestBody MetadataDTO dto) {
return R.succeed(metadataService.getSnapshot(dto));
}

@SaCheckPermission("metadata:manifest:list")
@PostMapping("/manifest")
public R<List<ManifestsVO>> getManifestInfo(@RequestBody MetadataDTO dto) {
return R.succeed(metadataService.getManifest(dto));
}

@SaCheckPermission("metadata:datafile:list")
@PostMapping("/dataFile")
public R<List<DataFileVO>> getDataFileInfo(@RequestBody MetadataDTO dto) {
return R.succeed(metadataService.getDataFile(dto));
}

@SaCheckPermission("metadata:options:list")
@PostMapping("/options")
public R<List<OptionVO>> getOptionInfo(@RequestBody MetadataDTO dto) {
return R.succeed(metadataService.getOption(dto));
Expand Down
11 changes: 11 additions & 0 deletions paimon-web-server/src/main/java/org/apache/paimon/web/server/controller/TableController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
import org.apache.paimon.web.server.data.vo.TableVO;
import org.apache.paimon.web.server.service.TableService;

import cn.dev33.satoken.annotation.SaCheckPermission;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
Expand Down Expand Up @@ -59,6 +60,7 @@ public TableController(TableService tableService) {
* @param tableDTO The TableDTO object containing information about the table
* @return a {@code R<Void>} response indicating success or failure
*/
@SaCheckPermission("metadata:table:create")
@PostMapping("/create")
public R<Void> createTable(@RequestBody TableDTO tableDTO) {
if (tableService.tableExists(tableDTO)) {
Expand All @@ -75,6 +77,7 @@ public R<Void> createTable(@RequestBody TableDTO tableDTO) {
* @param tableDTO The TableDTO object containing information about the table
* @return a {@code R<Void>} response indicating success or failure
*/
@SaCheckPermission("metadata:column:add")
@PostMapping("/column/add")
public R<Void> addColumn(@RequestBody TableDTO tableDTO) {
return tableService.addColumn(tableDTO)
Expand All @@ -90,6 +93,7 @@ public R<Void> addColumn(@RequestBody TableDTO tableDTO) {
* @param tableName The name of the table
* @return Response object containing {@link TableVO} representing the table
*/
@SaCheckPermission("metadata:column:list")
@GetMapping("/column/list")
public R<TableVO> listColumns(
@RequestParam String catalogName,
Expand All @@ -107,6 +111,7 @@ public R<TableVO> listColumns(
* @param columnName The name of the column to be dropped
* @return a {@code R<Void>} response indicating success or failure
*/
@SaCheckPermission("metadata:column:drop")
@DeleteMapping("/column/drop/{catalogName}/{databaseName}/{tableName}/{columnName}")
public R<Void> dropColumn(
@PathVariable String catalogName,
Expand All @@ -124,6 +129,7 @@ public R<Void> dropColumn(
* @param alterTableDTO the DTO containing alteration details
* @return a {@code R<Void>} response indicating success or failure
*/
@SaCheckPermission("metadata:table:update")
@PostMapping("/alter")
public R<Void> alterTable(@RequestBody AlterTableDTO alterTableDTO) {
return tableService.alterTable(alterTableDTO)
Expand All @@ -137,6 +143,7 @@ public R<Void> alterTable(@RequestBody AlterTableDTO alterTableDTO) {
* @param tableDTO The TableDTO object containing information about the table
* @return a {@code R<Void>} response indicating success or failure
*/
@SaCheckPermission("metadata:option:add")
@PostMapping("/option/add")
public R<Void> addOption(@RequestBody TableDTO tableDTO) {
return tableService.addOption(tableDTO)
Expand All @@ -153,6 +160,7 @@ public R<Void> addOption(@RequestBody TableDTO tableDTO) {
* @param key The key of the option to be removed
* @return a {@code R<Void>} response indicating success or failure
*/
@SaCheckPermission("metadata:option:remove")
@PostMapping("/option/remove")
public R<Void> removeOption(
@RequestParam String catalogName,
Expand All @@ -172,6 +180,7 @@ public R<Void> removeOption(
* @param tableName The name of the table to be dropped
* @return a {@code R<Void>} response indicating success or failure
*/
@SaCheckPermission("metadata:table:drop")
@DeleteMapping("/drop/{catalogName}/{databaseName}/{tableName}")
public R<Void> dropTable(
@PathVariable String catalogName,
Expand All @@ -191,6 +200,7 @@ public R<Void> dropTable(
* @param toTableName The new name for the table
* @return a {@code R<Void>} response indicating success or failure
*/
@SaCheckPermission("metadata:table:update")
@PostMapping("/rename")
public R<Void> renameTable(
@RequestParam String catalogName,
Expand All @@ -207,6 +217,7 @@ public R<Void> renameTable(
*
* @return Response object containing a list of {@link TableVO} representing the tables
*/
@SaCheckPermission("metadata:table:list")
@PostMapping("/list")
public R<Object> listTables(@RequestBody TableDTO tableDTO) {
List<TableVO> tables = tableService.listTables(tableDTO);
Expand Down