Package org.frankframework.console.controllers

Class Configurations

java.lang.Object

org.frankframework.console.controllers.Configurations

@RestController
public class Configurations
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Configurations.ActionModel
static final record	Configurations.ConfigurationParameters
static final record	Configurations.ConfigurationPathVariables
static final record	Configurations.ManageConfigurationModel
static final record	Configurations.UpdateConfigurationModel
static final record	Configurations.UploadConfigurationModel

Constructor Summary

Constructors

Constructor	Description
Configurations(FrankApiService frankApiService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<?>	deleteConfiguration(Configurations.ConfigurationPathVariables path, Configurations.ConfigurationParameters params)
org.springframework.http.ResponseEntity<?>	downloadConfiguration(Configurations.ConfigurationPathVariables path, Configurations.ConfigurationParameters params)
org.springframework.http.ResponseEntity<?>	fullAction(Configurations.ActionModel model)
org.springframework.http.ResponseEntity<?>	getConfigurationByName(Configurations.ConfigurationPathVariables path, Configurations.ConfigurationParameters params)
org.springframework.http.ResponseEntity<?>	getConfigurationDetailsByName(Configurations.ConfigurationPathVariables path, Configurations.ConfigurationParameters params)
org.springframework.http.ResponseEntity<?>	getConfigurationFlow(Configurations.ConfigurationPathVariables path)
org.springframework.http.ResponseEntity<?>	getConfigurationHealth(Configurations.ConfigurationPathVariables path)
org.springframework.http.ResponseEntity<?>	getConfigurationXML(Configurations.ConfigurationParameters params)
org.springframework.http.ResponseEntity<?>	manageConfiguration(Configurations.ConfigurationPathVariables path, Configurations.ConfigurationParameters params, Configurations.ManageConfigurationModel model)
org.springframework.http.ResponseEntity<?>	updateConfiguration(Configurations.ConfigurationPathVariables path, Configurations.UpdateConfigurationModel model)
org.springframework.http.ResponseEntity<?>	uploadConfiguration(Configurations.UploadConfigurationModel model)

Methods inherited from class java.lang.Object

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

Constructor Details

Configurations

public Configurations(FrankApiService frankApiService)

Method Details

getConfigurationXML

@AllowAllIbisUserRoles
@GetMapping(value="/configurations",
            produces="application/xml")
public org.springframework.http.ResponseEntity<?> getConfigurationXML(Configurations.ConfigurationParameters params)
                                                               throws ApiException

Throws:

ApiException

fullAction

@RolesAllowed({"IbisAdmin","IbisTester"})
@PutMapping(value="/configurations",
            produces="application/json",
            consumes="application/json")
public org.springframework.http.ResponseEntity<?> fullAction(@RequestBody
 Configurations.ActionModel model)
                                                      throws ApiException

Throws:

ApiException

getConfigurationByName

@AllowAllIbisUserRoles
@GetMapping(value="/configurations/{configuration}",
            produces="application/xml")
public org.springframework.http.ResponseEntity<?> getConfigurationByName(Configurations.ConfigurationPathVariables path,
 Configurations.ConfigurationParameters params)
                                                                  throws ApiException

Throws:

ApiException

getConfigurationHealth

@PermitAll
@GetMapping(value="/configurations/{configuration}/health",
            produces="application/json")
public org.springframework.http.ResponseEntity<?> getConfigurationHealth(Configurations.ConfigurationPathVariables path)
                                                                  throws ApiException

Throws:

ApiException

getConfigurationFlow

@AllowAllIbisUserRoles
@GetMapping("/configurations/{configuration}/flow")
public org.springframework.http.ResponseEntity<?> getConfigurationFlow(Configurations.ConfigurationPathVariables path)
                                                                throws ApiException

Throws:

ApiException

updateConfiguration

@RolesAllowed({"IbisDataAdmin","IbisAdmin","IbisTester"})
@PutMapping(value="/configurations/{configuration}",
            produces="application/json",
            consumes="application/json")
public org.springframework.http.ResponseEntity<?> updateConfiguration(Configurations.ConfigurationPathVariables path,
 @RequestBody
 Configurations.UpdateConfigurationModel model)
                                                               throws ApiException

Throws:

ApiException

getConfigurationDetailsByName

@AllowAllIbisUserRoles
@GetMapping(value="/configurations/{configuration}/versions",
            produces="application/json")
public org.springframework.http.ResponseEntity<?> getConfigurationDetailsByName(Configurations.ConfigurationPathVariables path,
 Configurations.ConfigurationParameters params)
                                                                         throws ApiException

Throws:

ApiException

manageConfiguration

@RolesAllowed({"IbisTester","IbisAdmin","IbisDataAdmin"})
@PutMapping(value="/configurations/{configuration}/versions/{version}",
            produces="application/json",
            consumes="application/json")
public org.springframework.http.ResponseEntity<?> manageConfiguration(Configurations.ConfigurationPathVariables path,
 Configurations.ConfigurationParameters params,
 @RequestBody
 Configurations.ManageConfigurationModel model)
                                                               throws ApiException

Throws:

ApiException

uploadConfiguration

@RolesAllowed({"IbisTester","IbisAdmin","IbisDataAdmin"})
@PostMapping(value="/configurations",
             produces="application/json")
public org.springframework.http.ResponseEntity<?> uploadConfiguration(Configurations.UploadConfigurationModel model)
                                                               throws ApiException

Throws:

ApiException

downloadConfiguration

@AllowAllIbisUserRoles
@GetMapping(value="/configurations/{configuration}/versions/{version}/download",
            produces="application/octet-stream")
public org.springframework.http.ResponseEntity<?> downloadConfiguration(Configurations.ConfigurationPathVariables path,
 Configurations.ConfigurationParameters params)
                                                                 throws ApiException

Throws:

ApiException

deleteConfiguration

@RolesAllowed({"IbisDataAdmin","IbisAdmin","IbisTester"})
@DeleteMapping("/configurations/{configuration}/versions/{version}")
public org.springframework.http.ResponseEntity<?> deleteConfiguration(Configurations.ConfigurationPathVariables path,
 Configurations.ConfigurationParameters params)
                                                               throws ApiException

Throws:

ApiException