org.springframework.cloud.stream.provisioning

Interface ProvisioningProvider<C extends ConsumerProperties,P extends ProducerProperties>

Type Parameters:

C - the consumer properties type

P - the producer properties type

public interface ProvisioningProvider<C extends ConsumerProperties,P extends ProducerProperties>

Provisioning SPI that allows the users to provision destinations such as queues and topics. This SPI will allow the binders to be separated from any provisioning concerns and only focus on setting up endpoints for sending/receiving messages. Implementations must implement the following methods:

• provisionProducerDestination(String, ProducerProperties)
• provisionConsumerDestination(String, String, ConsumerProperties)

Since:

1.2

Author:

Soby Chacko

Method Summary

Modifier and Type	Method and Description
ConsumerDestination	provisionConsumerDestination(String name, String group, C properties) Creates the middleware destination on the physical broker for the consumer to consume data.
ProducerDestination	provisionProducerDestination(String name, P properties) Creates middleware destination on the physical broker for the producer to send data.

Method Detail

provisionProducerDestination

ProducerDestination provisionProducerDestination(String name,
                                                 P properties)
                                          throws ProvisioningException

Creates middleware destination on the physical broker for the producer to send data. The implementation is middleware-specific.

Parameters:

name - the name of the producer destination

properties - producer properties

Returns:

reference to ProducerDestination that represents a producer

Throws:

ProvisioningException - on underlying provisioning errors from the middleware

provisionConsumerDestination

ConsumerDestination provisionConsumerDestination(String name,
                                                 String group,
                                                 C properties)
                                          throws ProvisioningException

Creates the middleware destination on the physical broker for the consumer to consume data. The implementation is middleware-specific.

Parameters:

name - the name of the destination

group - the consumer group

properties - consumer properties

Returns:

reference to ConsumerDestination that represents a consumer

Throws:

ProvisioningException - on underlying provisioning errors from the middleware