Package org.frankframework.console.controllers

Class Adapters

java.lang.Object

org.frankframework.console.controllers.Adapters

@RestController
public class Adapters
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Adapters.AdapterPathVariables
static final record	Adapters.GetAdapterParams
static final record	Adapters.UpdateAdapterOrReceiverModel
static final record	Adapters.UpdateAdaptersModel

Constructor Summary

Constructors

Constructor	Description
Adapters(FrankApiService frankApiService)

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<?>	getAdapter(Adapters.AdapterPathVariables path, Adapters.GetAdapterParams params)
org.springframework.http.ResponseEntity<?>	getAdapterFlow(Adapters.AdapterPathVariables path)
org.springframework.http.ResponseEntity<?>	getAdapterHealth(Adapters.AdapterPathVariables path)
org.springframework.http.ResponseEntity<?>	getAdapters(Adapters.GetAdapterParams params)
org.springframework.http.ResponseEntity<?>	getAdapterStatistics(Adapters.AdapterPathVariables path)
org.springframework.http.ResponseEntity<?>	updateAdapter(Adapters.AdapterPathVariables path, Adapters.UpdateAdapterOrReceiverModel model)
org.springframework.http.ResponseEntity<?>	updateAdapters(Adapters.UpdateAdaptersModel model)
org.springframework.http.ResponseEntity<?>	updateReceiver(Adapters.AdapterPathVariables path, Adapters.UpdateAdapterOrReceiverModel json)

Methods inherited from class java.lang.Object

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

Constructor Details

Adapters

public Adapters(FrankApiService frankApiService)

Method Details

getAdapters

@AllowAllIbisUserRoles
@GetMapping(value="/adapters",
            produces="application/json")
public org.springframework.http.ResponseEntity<?> getAdapters(Adapters.GetAdapterParams params)

getAdapter

@AllowAllIbisUserRoles
@GetMapping(value="/configurations/{configuration}/adapters/{name}",
            produces="application/json")
public org.springframework.http.ResponseEntity<?> getAdapter(Adapters.AdapterPathVariables path,
 Adapters.GetAdapterParams params)

getAdapterHealth

@PermitAll
@GetMapping(value="/configurations/{configuration}/adapters/{name}/health",
            produces="application/json")
public org.springframework.http.ResponseEntity<?> getAdapterHealth(Adapters.AdapterPathVariables path)

updateAdapters

@RolesAllowed({"IbisDataAdmin","IbisAdmin","IbisTester"})
@PutMapping(value="/adapters",
            produces="application/json",
            consumes="application/json")
public org.springframework.http.ResponseEntity<?> updateAdapters(@RequestBody
 Adapters.UpdateAdaptersModel model)

updateAdapter

@RolesAllowed({"IbisDataAdmin","IbisAdmin","IbisTester"})
@PutMapping(value="/configurations/{configuration}/adapters/{adapter}",
            produces="application/json",
            consumes="application/json")
public org.springframework.http.ResponseEntity<?> updateAdapter(Adapters.AdapterPathVariables path,
 @RequestBody
 Adapters.UpdateAdapterOrReceiverModel model)

updateReceiver

@RolesAllowed({"IbisDataAdmin","IbisAdmin","IbisTester"})
@PutMapping(value="/configurations/{configuration}/adapters/{adapter}/receivers/{receiver}",
            produces="application/json",
            consumes="application/json")
public org.springframework.http.ResponseEntity<?> updateReceiver(Adapters.AdapterPathVariables path,
 @RequestBody
 Adapters.UpdateAdapterOrReceiverModel json)

getAdapterFlow

@AllowAllIbisUserRoles
@GetMapping("/configurations/{configuration}/adapters/{adapter}/flow")
public org.springframework.http.ResponseEntity<?> getAdapterFlow(Adapters.AdapterPathVariables path)
                                                          throws ApiException

Throws:

ApiException

getAdapterStatistics

@AllowAllIbisUserRoles
@GetMapping(value="/configurations/{configuration}/adapters/{adapter}/statistics",
            produces="application/json")
public org.springframework.http.ResponseEntity<?> getAdapterStatistics(Adapters.AdapterPathVariables path)