org.springframework.cloud.stream.binder

Interface ExtendedBindingProperties<C,P>

All Known Subinterfaces:

ExtendedPropertiesBinder<T,C,P>

All Known Implementing Classes:

KafkaMessageChannelBinder, RabbitMessageChannelBinder

public interface ExtendedBindingProperties<C,P>

Properties that extend the common binding properties for a particular binder implementation.

Author:

Marius Bogoevici, Mark Fisher, Soby Chacko

Method Summary

Modifier and Type	Method and Description
String	getDefaultsPrefix() Extended binding properties can define a default prefix to place all the extended common producer and consumer properties.
C	getExtendedConsumerProperties(String channelName)
P	getExtendedProducerProperties(String channelName)
Class<? extends BinderSpecificPropertiesProvider>	getExtendedPropertiesEntryClass() Extended properties class which should be a subclass of BinderSpecificPropertiesProvider against which default extended producer and consumer properties are resolved.

Method Detail

getExtendedConsumerProperties

C getExtendedConsumerProperties(String channelName)

getExtendedProducerProperties

P getExtendedProducerProperties(String channelName)

getDefaultsPrefix

String getDefaultsPrefix()

Extended binding properties can define a default prefix to place all the extended common producer and consumer properties. For example, if the binder type is foo it is convenient to specify common extended properties for the producer or consumer across multiple bindings in the form of `spring.cloud.stream.foo.default.producer.x=y` or `spring.cloud.stream.foo.default.consumer.x=y`. The binding process will use this defaults prefix to resolve any common extended producer and consumer properties.

Returns:

default prefix for extended properties

Since:

2.1.0

getExtendedPropertiesEntryClass

Class<? extends BinderSpecificPropertiesProvider> getExtendedPropertiesEntryClass()

Extended properties class which should be a subclass of BinderSpecificPropertiesProvider against which default extended producer and consumer properties are resolved.

Returns:

extended properties class that contains extended producer/consumer properties

Since:

2.1.0