SpringCloud/spring-cloud-stream
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated property prefixes

Browse Source
This commit is contained in:
Marius Bogoevici
2016-03-21 19:37:02 -04:00
parent cadfd48a1f
commit 04a7fe83a5
1 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
spring-cloud-stream-docs/src/main/asciidoc/spring-cloud-stream-overview.adoc
View File

@@ -10,9 +10,9 @@ such as creating and running stream applications.
== Introducing Spring Cloud Stream
Spring Cloud Stream is a framework for building message-driven microservices.
Spring Cloud Stream builds upon Spring Boot to create DevOps friendly microservice applications and Spring Integration to provide connectivity to message brokers.
Spring Cloud Stream provides an opinionated configuration of message brokers, introducing the concepts of persistent pub/sub semantics, consumer groups and partitions across several middleware vendors.
This opinionated configuration provides the basis to create stream processing application.
Spring Cloud Stream builds upon Spring Boot to create DevOps friendly microservice applications and Spring Integration to provide connectivity to message brokers.
Spring Cloud Stream provides an opinionated configuration of message brokers, introducing the concepts of persistent pub/sub semantics, consumer groups and partitions across several middleware vendors.
This opinionated configuration provides the basis to create stream processing applications.
By adding `@EnableBinding` to your main application, you get immediate connectivity to a message broker and by adding `@StreamListener` to a method, you will receive events for stream processing.
@@ -438,7 +438,7 @@ public class TransformProcessor {
}
----
NOTE: Content type headers can be either set by external applications in the case of Rabbit MQ, and they are supported as part of an extended internal protocol by Spring Cloud Stream for any type of transport (even the ones that do not support headers normally, like Kafka).
NOTE: Content type headers can be set by external applications in the case of Rabbit MQ, and they are supported as part of an extended internal protocol by Spring Cloud Stream for any type of transport (even the ones that do not support headers normally, like Kafka).
=== Binder SPI
@@ -588,29 +588,29 @@ The binder supports the all Spring Boot properties for Rabbit MQ configuration.
In addition to that, it also supports the following properties:
spring.cloud.stream.binder.rabbit.addresses::
spring.cloud.stream.rabbit.binder.addresses::
A comma-separated list of RabbitMQ server addresses (used only for clustering and in conjunction with `nodes`). Default empty.
spring.cloud.stream.binder.rabbit.adminAddresses. Default empty.
spring.cloud.stream.rabbit.binder.adminAddresses. Default empty.
A comma-separated list of RabbitMQ management plugin URLs - only used when nodes contains more than one entry. Entries in this list must correspond to the corresponding entry in addresses. Default empty.
spring.cloud.stream.binder.rabbit.nodes::
spring.cloud.stream.rabbit.binder.nodes::
A comma-separated list of RabbitMQ node names; when more than one entry, used to locate the server address where a queue is located. Entries in this list must correspond to the corresponding entry in addresses. Default empty.
spring.cloud.stream.binder.rabbit.username::
spring.cloud.stream.rabbit.rabbit.username::
The user name. Default `null`.
spring.cloud.stream.binder.rabbit.password::
spring.cloud.stream.rabbit.binder.password::
The password. Default `null`.
spring.cloud.stream.binder.rabbit.vhost::
spring.cloud.stream.rabbit.binder.vhost::
The virtual host. Default `null`.
spring.cloud.stream.binder.rabbit.useSSL::
spring.cloud.stream.rabbit.binder.useSSL::
True if Rabbit MQ should use SSL.
spring.cloud.stream.binder.rabbit.sslPropertiesLocation::
spring.cloud.stream.rabbit.binder.sslPropertiesLocation::
The location of the SSL properties file, when certificate exchange is used.
spring.cloud.stream.binder.rabbit.compressionLevel::
spring.cloud.stream.rabbit.binder.compressionLevel::
Compression level for compressed bindings. Defaults to `1` (BEST_LEVEL). See `java.util.zip.Deflater`.
==== Rabbit MQ Consumer Properties
The following properties are available for Rabbit consumers only and
must be prefixed with `spring.cloud.stream.bindings.<channelName>.`
must be prefixed with `spring.cloud.stream.rabbit.bindings.<channelName>.consumer` .
acknowledgeMode::
The acknowledge mode. Default `AUTO`.
@@ -640,7 +640,7 @@ txSize::
==== Rabbit Producer Properties
The following properties are available for Rabbit producers only and
must be prefixed with `spring.cloud.stream.bindings.<channelName>.`
must be prefixed with `spring.cloud.stream.rabbit.bindings.<channelName>.producer` .
autoBindDlq::
Whether to automatically declare the DLQ and bind it to the binder DLX. Default `false`.
@@ -667,27 +667,27 @@ replyHeaderPatterns::
==== Kafka binder properties
spring.cloud.stream.binder.kafka.brokers::
spring.cloud.stream.kafka.binder.brokers::
A list of brokers that the Kafka binder will connect to. Default `localhost`.
spring.cloud.stream.binder.kafka.defaultBrokerPort::
spring.cloud.stream.kafka.binder.defaultBrokerPort::
The list of brokers allows to specify hosts with or without port information, i.e. `host1,host2:port2`. This configuration sets the default port when no port is configured in the broker list. Default `9092`.
spring.cloud.stream.binder.kafka.zkNodes::
spring.cloud.stream.kafka.binder.zkNodes::
A list of Zookeeper nodes for the Kafka binder to connect to. Default `localhost`.
spring.cloud.stream.binder.kafka.defaultZkPort::
spring.cloud.stream.kafka.binder.defaultZkPort::
The list of Zookeeper nodes allows to specify hosts with or without port information, i.e. `host1,host2:port2`. This configuration sets the default port when no port is configured in the node list. Default `2181`.
spring.cloud.stream.binder.kafka.headers::
spring.cloud.stream.kafka.binder.headers::
The list of custom that will be transported by the binder. Default empty.
spring.cloud.stream.binder.kafka.offsetUpdateTimeWindow::
spring.cloud.stream.kafka.binder.offsetUpdateTimeWindow::
The frequency in milliseconds with which offsets are saved. Ignored if `0`. Default `10000`.
spring.cloud.stream.binder.kafka.offsetUpdateCount::
spring.cloud.stream.kafka.binder.offsetUpdateCount::
The frequency in number of updates, which which consumed offsets are persisted. Ignored if `0`. Default `0`. Mutually exclusive with `offsetUpdateTimeWindow`.
spring.cloud.stream.binder.kafka.requiredAcks::
spring.cloud.stream.kafka.binder.requiredAcks::
The number of required acks on the broker.
==== Kafka Consumer Properties
The following properties are available for Kafka consumers only and
must be prefixed with `spring.cloud.stream.bindings.<channelName>.`
must be prefixed with `spring.cloud.stream.kafka.bindings.<channelName>.consumer` .
autoCommitOffset::
True to autocommit offsets when a message has been processed. If set to false, an `Acknowledgment` header will be available in the message headers for late acknowledgment. Default `true`.
@@ -703,7 +703,7 @@ minPartitionCount::
==== Kafka Producer Properties
The following properties are available for Kafka producers only and
must be prefixed with `spring.cloud.stream.bindings.<channelName>.`
must be prefixed with `spring.cloud.stream.kafka.bindings.<channelName>.producer` .
bufferSize::
This is an upper limit of how much data the Kafka Producer will attempt to batch before sending – specified in bytes. Default `16384`.