Class ControlBusController

java.lang.Object

org.springframework.integration.http.management.ControlBusController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.InitializingBean

@RestController
@RequestMapping("/control-bus")
public class ControlBusController
extends Object
implements org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.InitializingBean

The REST Controller to provide the management API for Control Bus pattern.

Since:

6.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ControlBusController.CommandArgument
static final record	ControlBusController.ControlBusBean
static final record	ControlBusController.ControlBusCommand

Constructor Summary

Constructors

Constructor	Description
ControlBusController(org.springframework.integration.support.management.ControlBusCommandRegistry controlBusCommandRegistry, org.springframework.format.support.FormattingConversionService conversionService)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
List<ControlBusController.ControlBusBean>	getCommands()
@Nullable Object	invokeCommand(String command, List<ControlBusController.CommandArgument> arguments)
void	setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)

Methods inherited from class java.lang.Object

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

Constructor Details

ControlBusController

public ControlBusController(org.springframework.integration.support.management.ControlBusCommandRegistry controlBusCommandRegistry,
 org.springframework.format.support.FormattingConversionService conversionService)

Method Details

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
                    throws org.springframework.beans.BeansException

Specified by:

setBeanFactory in interface org.springframework.beans.factory.BeanFactoryAware

Throws:

org.springframework.beans.BeansException

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

getCommands

@GetMapping(name="getCommands")
public List<ControlBusController.ControlBusBean> getCommands()

invokeCommand

@PostMapping(name="invokeCommand",
             path="/{command}")
public @Nullable Object invokeCommand(@PathVariable
 String command,
 @RequestBody(required=false)
 List<ControlBusController.CommandArgument> arguments)