Package eu.rarogsoftware.rarog.platform.app.rest.plugins

Class PluginController

java.lang.Object

eu.rarogsoftware.rarog.platform.app.rest.plugins.PluginController

@RequestMapping(value="/plugins",
                produces="application/json")
@RestController
@AdminOnly
public class PluginController
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	PluginController.PathInstallInstructionBean
static final record	PluginController.PluginRecord

Constructor Summary

Constructors

Constructor	Description
PluginController(PluginManager pluginManager)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Void>	changePluginState(String pluginKey, BooleanValueBean value)
List<PluginController.PluginRecord>	getInstalledPlugins()
PluginController.PluginRecord	getPlugin(String pluginKey)
org.springframework.http.ResponseEntity<Map<String,Object>>	handleResponseStatusException(org.springframework.web.server.ResponseStatusException exception)
org.springframework.http.ResponseEntity<Void>	installPluginFromFile(jakarta.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<Void>	installPluginFromForm(org.springframework.web.multipart.MultipartFile multipartFile, Boolean reinstallIfNeeded)
org.springframework.http.ResponseEntity<Void>	installPluginFromPath(PluginController.PathInstallInstructionBean instructionBean)
BooleanValueBean	isPluginEnabled(String pluginKey)
org.springframework.http.ResponseEntity<Void>	purgePlugin(String pluginKey)
org.springframework.http.ResponseEntity<Void>	removePlugin(String pluginKey)

Methods inherited from class java.lang.Object

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

Constructor Details

PluginController

public PluginController(PluginManager pluginManager)

Method Details

getInstalledPlugins

@GetMapping
public List<PluginController.PluginRecord> getInstalledPlugins()

installPluginFromPath

@PostMapping(consumes="application/json")
public org.springframework.http.ResponseEntity<Void> installPluginFromPath(@RequestBody
 PluginController.PathInstallInstructionBean instructionBean)

installPluginFromForm

@PostMapping(consumes="multipart/form-data")
public org.springframework.http.ResponseEntity<Void> installPluginFromForm(@RequestParam("file")
 org.springframework.web.multipart.MultipartFile multipartFile,
 @RequestParam("reinstallIfNeeded")
 Boolean reinstallIfNeeded)

installPluginFromFile

@PostMapping(consumes={"application/octet-stream","application/java-archive"})
public org.springframework.http.ResponseEntity<Void> installPluginFromFile(jakarta.servlet.http.HttpServletRequest request)

getPlugin

@GetMapping("/{pluginKey}")
public PluginController.PluginRecord getPlugin(@PathVariable("pluginKey")
 String pluginKey)

removePlugin

@DeleteMapping("/{pluginKey}")
public org.springframework.http.ResponseEntity<Void> removePlugin(@PathVariable("pluginKey")
 String pluginKey)

isPluginEnabled

@GetMapping("/{pluginKey}/enabled")
public BooleanValueBean isPluginEnabled(@PathVariable("pluginKey")
 String pluginKey)

changePluginState

@PutMapping("/{pluginKey}/enabled")
public org.springframework.http.ResponseEntity<Void> changePluginState(@PathVariable("pluginKey")
 String pluginKey,
 @RequestBody
 BooleanValueBean value)

purgePlugin

@PostMapping("/{pluginKey}/purge")
public org.springframework.http.ResponseEntity<Void> purgePlugin(@PathVariable("pluginKey")
 String pluginKey)

handleResponseStatusException

@ExceptionHandler(org.springframework.web.server.ResponseStatusException.class)
public org.springframework.http.ResponseEntity<Map<String,Object>> handleResponseStatusException(org.springframework.web.server.ResponseStatusException exception)