Package org.springframework.integration.router

Interface RecipientListRouterManagement

All Known Implementing Classes:

RecipientListRouter

@ManagedResource
@IntegrationManagedResource
public interface RecipientListRouterManagement

Exposes adding/removing individual recipients operations for RecipientListRouter. This can be used with a control-bus and JMX.

Since:

4.1

Author:

Liujiong, Gary Russell, Artem Bilan

Method Summary

Modifier and Type	Method	Description
void	addRecipient(String channelName)	Add a recipient with channelName.
void	addRecipient(String channelName, String selectorExpression)	Add a recipient with channelName and expression.
Collection<?>	getRecipients()
int	removeRecipient(String channelName)	Remove all recipients that match the channelName.
int	removeRecipient(String channelName, String selectorExpression)	Remove all recipients that match the channelName and expression.
void	replaceRecipients(Properties recipientMappings)	Replace recipient.
void	setRecipientMappings(Map<String,String> recipientMappings)	Set recipients.

Method Details

addRecipient

@ManagedOperation
void addRecipient(String channelName,
 String selectorExpression)

Add a recipient with channelName and expression. The expression follows only SimpleEvaluationContext.forReadOnlyDataBinding() capabilities. Otherwise, use non-managed RecipientListRouter.addRecipient(String, MessageSelector) API with more control over execution.

Parameters:

channelName - The channel name.

selectorExpression - The expression to filter the incoming message.

addRecipient

@ManagedOperation
void addRecipient(String channelName)

Add a recipient with channelName.

Parameters:

channelName - The channel name.

removeRecipient

@ManagedOperation
int removeRecipient(String channelName)

Remove all recipients that match the channelName.

Parameters:

channelName - The channel name.

Returns:

The number of recipients removed.

removeRecipient

@ManagedOperation
int removeRecipient(String channelName,
 String selectorExpression)

Remove all recipients that match the channelName and expression.

Parameters:

channelName - The channel name.

selectorExpression - The expression to filter the incoming message

Returns:

The number of recipients removed.

getRecipients

@ManagedAttribute
Collection<?> getRecipients()

Returns:

an unmodifiable collection of recipients.

replaceRecipients

@ManagedOperation
void replaceRecipients(Properties recipientMappings)

Replace recipient. The expression follows only SimpleEvaluationContext.forReadOnlyDataBinding() capabilities. Otherwise, use non-managed RecipientListRouter.addRecipient(String, MessageSelector) API with more control over execution.

Parameters:

recipientMappings - contain channelName and expression.

setRecipientMappings

@ManagedAttribute
void setRecipientMappings(Map<String,String> recipientMappings)

Set recipients. The expression follows only SimpleEvaluationContext.forReadOnlyDataBinding() capabilities. Otherwise, use non-managed RecipientListRouter.setRecipients(List) API with more control over execution.

Parameters:

recipientMappings - contain channelName and expression.