Package org.springframework.integration.support.management

Class ControlBusCommandRegistry

java.lang.Object

org.springframework.integration.support.management.ControlBusCommandRegistry

All Implemented Interfaces:

Aware, BeanPostProcessor, DestructionAwareBeanPostProcessor, SmartInitializingSingleton, ApplicationContextAware

public class ControlBusCommandRegistry
extends Object
implements ApplicationContextAware, SmartInitializingSingleton, DestructionAwareBeanPostProcessor

A global component to serve Control Bus command and respective SpEL expression relationships.

Since:

6.4

Author:

Artem Bilan

See Also:

• ControlBusMethodFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ControlBusCommandRegistry.CommandMethod	The Java Bean to represent a Control Bus command as a bean method with its parameter types.

Constructor Summary

Constructors

Constructor	Description
ControlBusCommandRegistry()

Method Summary

Modifier and Type	Method	Description
void	afterSingletonsInstantiated()
Map<String,Map<ControlBusCommandRegistry.CommandMethod,String>>	getCommands()	Return registered Control Bus commands.
Expression	getExpressionForCommand(String command, Class<?>... parameterTypes)	Obtain a SpEL expression for the command to call with parameter types.
Object	postProcessAfterInitialization(Object bean, String beanName)
void	postProcessBeforeDestruction(Object bean, String beanName)
void	registerControlBusCommands(String beanName, Object bean)	Manually register Control Bus commands (if any) for a specific bean.
boolean	requiresDestruction(Object bean)
void	setApplicationContext(ApplicationContext applicationContext)
void	setEagerInitialization(boolean eagerInitialization)	Set to true to turn on Control Bus commands loading after application context initialization.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.config.BeanPostProcessor

postProcessBeforeInitialization

Constructor Details

ControlBusCommandRegistry

public ControlBusCommandRegistry()

Method Details

setEagerInitialization

public void setEagerInitialization(boolean eagerInitialization)

Set to true to turn on Control Bus commands loading after application context initialization.

Parameters:

eagerInitialization - true to initialize this registry eagerly.

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

Specified by:

afterSingletonsInstantiated in interface SmartInitializingSingleton

postProcessAfterInitialization

public Object postProcessAfterInitialization(Object bean,
 String beanName)
                                      throws BeansException

Specified by:

postProcessAfterInitialization in interface BeanPostProcessor

Throws:

BeansException

registerControlBusCommands

public void registerControlBusCommands(String beanName,
 Object bean)

Manually register Control Bus commands (if any) for a specific bean. The bean must be in instance of Lifecycle, or CustomizableThreadCreator, or marked with the ManagedResource, or IntegrationManagedResource annotation.

Parameters:

beanName - the bean name for registration

bean - the bean for registration

requiresDestruction

public boolean requiresDestruction(Object bean)

Specified by:

requiresDestruction in interface DestructionAwareBeanPostProcessor

postProcessBeforeDestruction

public void postProcessBeforeDestruction(Object bean,
 String beanName)
                                  throws BeansException

Specified by:

postProcessBeforeDestruction in interface DestructionAwareBeanPostProcessor

Throws:

BeansException

getCommands

public Map<String,Map<ControlBusCommandRegistry.CommandMethod,String>> getCommands()

Return registered Control Bus commands.

Returns:

registered commands.

getExpressionForCommand

public Expression getExpressionForCommand(String command,
 Class<?>... parameterTypes)

Obtain a SpEL expression for the command to call with parameter types. The command must be in format beanName.methodName. (Or @beanName.methodName() for backward compatibility with simple expressions.) If beanName is a complex literal, it has to be wrapped into single quotes, e.g. 'some.complex.bean-name'. The target method to call must fit into the ControlBusMethodFilter requirements and match with the provided parameter types.

Parameters:

command - the command to call.

parameterTypes - the parameter types for the target method to call.

Returns:

the SpEL expression for the provided command.

Throws:

IllegalArgumentException - if provided command does not match to Control Bus requirements or target method contract.