io.nats.cloud.stream.binder

Class NatsChannelBinder

java.lang.Object

org.springframework.cloud.stream.binder.AbstractBinder<org.springframework.messaging.MessageChannel,C,P>

org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<NatsConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<NatsProducerProperties>,NatsChannelProvisioner>

io.nats.cloud.stream.binder.NatsChannelBinder

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.cloud.stream.binder.Binder<org.springframework.messaging.MessageChannel,org.springframework.cloud.stream.binder.ExtendedConsumerProperties<NatsConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<NatsProducerProperties>>, org.springframework.cloud.stream.binder.ExtendedBindingProperties<NatsConsumerProperties,NatsProducerProperties>, org.springframework.cloud.stream.binder.ExtendedPropertiesBinder<org.springframework.messaging.MessageChannel,NatsConsumerProperties,NatsProducerProperties>, org.springframework.cloud.stream.binder.PollableConsumerBinder<org.springframework.messaging.MessageHandler,org.springframework.cloud.stream.binder.ExtendedConsumerProperties<NatsConsumerProperties>>, org.springframework.context.ApplicationContextAware, org.springframework.context.ApplicationEventPublisherAware

public class NatsChannelBinder
extends org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<NatsConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<NatsProducerProperties>,NatsChannelProvisioner>
implements org.springframework.cloud.stream.binder.ExtendedPropertiesBinder<org.springframework.messaging.MessageChannel,NatsConsumerProperties,NatsProducerProperties>

A NATS channel binder provides a NATS connection to the code attached to it.

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder

org.springframework.cloud.stream.binder.AbstractMessageChannelBinder.ErrorInfrastructure, org.springframework.cloud.stream.binder.AbstractMessageChannelBinder.PolledConsumerResources

Field Summary

Fields inherited from class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder

provisioningProvider

Constructor Summary

Constructors

Constructor and Description
NatsChannelBinder(NatsExtendedBindingProperties bindingProperties, NatsBinderConfigurationProperties properties, NatsProperties natsProperties, NatsChannelProvisioner provisioningProvider, io.nats.client.ConnectionListener connectionListener, io.nats.client.ErrorListener errorListener) Create a binder with the specified properties.

Method Summary

Modifier and Type	Method and Description
protected org.springframework.integration.core.MessageProducer	createConsumerEndpoint(org.springframework.cloud.stream.provisioning.ConsumerDestination destination, String group, org.springframework.cloud.stream.binder.ExtendedConsumerProperties<NatsConsumerProperties> properties)
protected org.springframework.cloud.stream.binder.AbstractMessageChannelBinder.PolledConsumerResources	createPolledConsumerResources(String name, String group, org.springframework.cloud.stream.provisioning.ConsumerDestination destination, org.springframework.cloud.stream.binder.ExtendedConsumerProperties<NatsConsumerProperties> consumerProperties)
protected org.springframework.messaging.MessageHandler	createProducerMessageHandler(org.springframework.cloud.stream.provisioning.ProducerDestination destination, org.springframework.cloud.stream.binder.ExtendedProducerProperties<NatsProducerProperties> producerProperties, org.springframework.messaging.MessageChannel errorChannel)
io.nats.client.Connection	getConnection()
String	getDefaultsPrefix()
NatsConsumerProperties	getExtendedConsumerProperties(String channelName)
NatsProducerProperties	getExtendedProducerProperties(String channelName)
Class<? extends org.springframework.cloud.stream.binder.BinderSpecificPropertiesProvider>	getExtendedPropertiesEntryClass()

Methods inherited from class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder

afterUnbindConsumer, afterUnbindProducer, bindPollableConsumer, createProducerMessageHandler, doBindConsumer, doBindProducer, errorsBaseName, errorsBaseName, getApplicationEventPublisher, getContainerCustomizer, getDefaultErrorMessageHandler, getErrorBridgeName, getErrorBridgeName, getErrorMessageHandler, getErrorMessageHandlerName, getErrorMessageStrategy, getErrorRecovererName, getMessageSourceCustomizer, getPolledConsumerErrorMessageHandler, getPolledConsumerRecoveryCallback, onInit, postProcessOutputChannel, postProcessPollableSource, registerErrorInfrastructure, registerErrorInfrastructure, setApplicationEventPublisher, setConsumerEndpointCustomizer, setProducerMessageHandlerCustomizer, useNativeEncoding

Methods inherited from class org.springframework.cloud.stream.binder.AbstractBinder

afterPropertiesSet, applyPrefix, bindConsumer, bindProducer, buildRetryTemplate, constructDLQName, getApplicationContext, getBeanFactory, getEvaluationContext, groupedName, setApplicationContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.cloud.stream.binder.Binder

bindConsumer, bindProducer

Methods inherited from interface org.springframework.cloud.stream.binder.ExtendedBindingProperties

getBindings

Constructor Detail

NatsChannelBinder

public NatsChannelBinder(NatsExtendedBindingProperties bindingProperties,
                         NatsBinderConfigurationProperties properties,
                         NatsProperties natsProperties,
                         NatsChannelProvisioner provisioningProvider,
                         io.nats.client.ConnectionListener connectionListener,
                         io.nats.client.ErrorListener errorListener)

Create a binder with the specified properties. It is expected that either the NatsBinderConfigurationProperties will have a server url set, or the NatsProperties will. They are preferred in that order, and only one server URL or server URL list is used. The NatsProperties are considered global and a backup. If a connection or error listener is provided it is used, otherwise a default logging listener is assigned to avoid silent errors.

Parameters:

bindingProperties - extended properties for future use

properties - primary properties

natsProperties - backup global properties

provisioningProvider - provisioner for destination names

connectionListener - custom connection listener

errorListener - custom error listener

Method Detail

getConnection

public io.nats.client.Connection getConnection()

Returns:

NATS connection

createProducerMessageHandler

protected org.springframework.messaging.MessageHandler createProducerMessageHandler(org.springframework.cloud.stream.provisioning.ProducerDestination destination,
                                                                                    org.springframework.cloud.stream.binder.ExtendedProducerProperties<NatsProducerProperties> producerProperties,
                                                                                    org.springframework.messaging.MessageChannel errorChannel)

Specified by:

createProducerMessageHandler in class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<NatsConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<NatsProducerProperties>,NatsChannelProvisioner>

createConsumerEndpoint

protected org.springframework.integration.core.MessageProducer createConsumerEndpoint(org.springframework.cloud.stream.provisioning.ConsumerDestination destination,
                                                                                      String group,
                                                                                      org.springframework.cloud.stream.binder.ExtendedConsumerProperties<NatsConsumerProperties> properties)

Specified by:

createConsumerEndpoint in class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<NatsConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<NatsProducerProperties>,NatsChannelProvisioner>

createPolledConsumerResources

protected org.springframework.cloud.stream.binder.AbstractMessageChannelBinder.PolledConsumerResources createPolledConsumerResources(String name,
                                                                                                                                     String group,
                                                                                                                                     org.springframework.cloud.stream.provisioning.ConsumerDestination destination,
                                                                                                                                     org.springframework.cloud.stream.binder.ExtendedConsumerProperties<NatsConsumerProperties> consumerProperties)

Overrides:

createPolledConsumerResources in class org.springframework.cloud.stream.binder.AbstractMessageChannelBinder<org.springframework.cloud.stream.binder.ExtendedConsumerProperties<NatsConsumerProperties>,org.springframework.cloud.stream.binder.ExtendedProducerProperties<NatsProducerProperties>,NatsChannelProvisioner>

getExtendedConsumerProperties

public NatsConsumerProperties getExtendedConsumerProperties(String channelName)

Specified by:

getExtendedConsumerProperties in interface org.springframework.cloud.stream.binder.ExtendedBindingProperties<NatsConsumerProperties,NatsProducerProperties>

getExtendedProducerProperties

public NatsProducerProperties getExtendedProducerProperties(String channelName)

Specified by:

getExtendedProducerProperties in interface org.springframework.cloud.stream.binder.ExtendedBindingProperties<NatsConsumerProperties,NatsProducerProperties>

getDefaultsPrefix

public String getDefaultsPrefix()

Specified by:

getDefaultsPrefix in interface org.springframework.cloud.stream.binder.ExtendedBindingProperties<NatsConsumerProperties,NatsProducerProperties>

getExtendedPropertiesEntryClass

public Class<? extends org.springframework.cloud.stream.binder.BinderSpecificPropertiesProvider> getExtendedPropertiesEntryClass()

Specified by:

getExtendedPropertiesEntryClass in interface org.springframework.cloud.stream.binder.ExtendedBindingProperties<NatsConsumerProperties,NatsProducerProperties>