forked from comixed/comixed
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added a REST API for retrieving list plugin list [comixed#372]
- Loading branch information
Showing
8 changed files
with
252 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
71 changes: 71 additions & 0 deletions
71
comixed-plugins/src/main/java/org/comixed/plugins/model/PluginDescriptor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| * ComiXed - A digital comic book library management application. | ||
| * Copyright (C) 2020, The ComiXed Project | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses> | ||
| */ | ||
|
|
||
| package org.comixed.plugins.model; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||
| import com.fasterxml.jackson.annotation.JsonView; | ||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import lombok.Getter; | ||
| import lombok.NonNull; | ||
| import lombok.RequiredArgsConstructor; | ||
| import lombok.Setter; | ||
| import org.comixed.views.View; | ||
|
|
||
| /** | ||
| * <code>PluginDescriptor</code> holds the details for a plugin. | ||
| * | ||
| * @author Darryl L. Pierce | ||
| */ | ||
| @RequiredArgsConstructor | ||
| public class PluginDescriptor { | ||
| @NonNull @Getter private Plugin plugin; | ||
|
|
||
| @Getter | ||
| @Setter | ||
| @JsonProperty("name") | ||
| @JsonView(View.PluginList.class) | ||
| private String name; | ||
|
|
||
| @Getter | ||
| @Setter | ||
| @JsonProperty("language") | ||
| @JsonView(View.PluginList.class) | ||
| private String language; | ||
|
|
||
| @Getter | ||
| @Setter | ||
| @JsonProperty("version") | ||
| @JsonView(View.PluginList.class) | ||
| private String version; | ||
|
|
||
| @Getter | ||
| @Setter | ||
| @JsonProperty("author") | ||
| @JsonView(View.PluginList.class) | ||
| private String author; | ||
|
|
||
| @Getter | ||
| @Setter | ||
| @JsonProperty("description") | ||
| @JsonView(View.PluginList.class) | ||
| private String description; | ||
|
|
||
| @Getter @Setter private Map<String, byte[]> entries = new HashMap<>(); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
comixed-rest-api/src/main/java/org/comixed/controller/core/PluginsController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| /* | ||
| * ComiXed - A digital comic book library management application. | ||
| * Copyright (C) 2020, The ComiXed Project | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses> | ||
| */ | ||
|
|
||
| package org.comixed.controller.core; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonView; | ||
| import java.util.List; | ||
| import lombok.extern.log4j.Log4j2; | ||
| import org.comixed.plugins.PluginManager; | ||
| import org.comixed.plugins.model.PluginDescriptor; | ||
| import org.comixed.views.View; | ||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.http.MediaType; | ||
| import org.springframework.web.bind.annotation.GetMapping; | ||
| import org.springframework.web.bind.annotation.RequestMapping; | ||
| import org.springframework.web.bind.annotation.RestController; | ||
|
|
||
| /** | ||
| * <code>PLuginsController</code> accepts requests relating to the plugin subsystem. | ||
| * | ||
| * @author Darryl L. Pierce | ||
| */ | ||
| @RestController | ||
| @RequestMapping("/api") | ||
| @Log4j2 | ||
| public class PluginsController { | ||
| @Autowired private PluginManager pluginManager; | ||
|
|
||
| @GetMapping(value = "/plugins", produces = MediaType.APPLICATION_JSON_VALUE) | ||
| @JsonView(View.PluginList.class) | ||
| public List<PluginDescriptor> getList() { | ||
| log.info("Fetching the list of plugins"); | ||
| return this.pluginManager.getPluginList(); | ||
| } | ||
| } |
Oops, something went wrong.