Skip to content

Improve connections document #3077

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 28, 2025
Merged

Improve connections document #3077

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/reference/antora/antora-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ asciidoc:
- '@asciidoctor/tabs'
- '@springio/asciidoctor-extensions'
- '@springio/asciidoctor-extensions/javadoc-extension'
- '@springio/asciidoctor-extensions/configuration-properties-extension'
sourcemap: true
urls:
latest_version_segment: ''
Expand Down
61 changes: 35 additions & 26 deletions src/reference/antora/modules/ROOT/pages/amqp/connections.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ public ConnectionFactory rabbitConnectionFactory(ConnectionNameStrategy cns) {
The property must exist in the application context's `Environment`.

NOTE: When using Spring Boot and its autoconfigured connection factory, you need only declare the `ConnectionNameStrategy` `@Bean`.
Boot auto-detects the bean and wires it into the factory.
Spring Boot auto-detects the bean and wires it into the factory.

[[blocked-connections-and-resource-constraints]]
== Blocked Connections and Resource Constraints
Expand Down Expand Up @@ -332,8 +332,11 @@ Other setters delegate to the underlying factory.
Previously, you had to configure the SSL options programmatically.
The following example shows how to configure a `RabbitConnectionFactoryBean`:

[tabs]
======
Java::
+
[source,java,role=primary]
.Java
----
@Bean
RabbitConnectionFactoryBean rabbitConnectionFactory() {
Expand All @@ -351,34 +354,40 @@ CachingConnectionFactory connectionFactory(ConnectionFactory rabbitConnectionFac
return ccf;
}
----
[source,properties,role=secondary]
.Boot application.properties
----
spring.rabbitmq.ssl.enabled:true
spring.rabbitmq.ssl.keyStore=...
spring.rabbitmq.ssl.keyStoreType=jks
spring.rabbitmq.ssl.keyStorePassword=...
spring.rabbitmq.ssl.trustStore=...
spring.rabbitmq.ssl.trustStoreType=jks
spring.rabbitmq.ssl.trustStorePassword=...
spring.rabbitmq.host=...
...
----
XML::
+
[source,xml,role=secondary]
.XML
----
<rabbit:connection-factory id="rabbitConnectionFactory"
connection-factory="clientConnectionFactory"
<bean id="rabbitConnectionFactory"
class="org.springframework.amqp.rabbit.connection.RabbitConnectionFactoryBean">
<property name="useSSL" value="true" />
<property name="sslPropertiesLocation" value="classpath:secrets/rabbitSSL.properties"/>
</bean>

<rabbit:connection-factory id="connectionFactory"
connection-factory="rabbitConnectionFactory"
host="${host}"
port="${port}"
virtual-host="${vhost}"
username="${username}" password="${password}" />
----
======

<bean id="clientConnectionFactory"
class="org.springframework.amqp.rabbit.connection.RabbitConnectionFactoryBean">
<property name="useSSL" value="true" />
<property name="sslPropertiesLocation" value="classpath:secrets/rabbitSSL.properties"/>
</bean>
Spring Boot application file (`.yaml` or `.properties`)

[configprops%novalidate,yaml]
----
spring:
rabbitmq:
host: ...
ssl:
keyStoreType: jks
trustStoreType: jks
keyStore: ...
trustStore: ...
trustStorePassword: ...
keyStorePassword: ...
enabled: true
----

See the https://www.rabbitmq.com/ssl.html[RabbitMQ Documentation] for information about configuring SSL.
Expand Down Expand Up @@ -622,7 +631,7 @@ To add `WebFlux` to the class path:
compile 'org.springframework.amqp:spring-rabbit'
----

You can also use other REST technology by implementing `LocalizedQueueConnectionFactory.NodeLocator` and overriding its `createClient, ``restCall`, and optionally, `close` methods.
You can also use other REST technology by implementing javadoc:org.springframework.amqp.rabbit.connection.LocalizedQueueConnectionFactory#setNodeLocator(org.springframework.amqp.rabbit.connection.NodeLocator)[LocalizedQueueConnectionFactory#setNodeLocator] and overriding its `createClient`, `restCall`, and optionally, `close` methods.

[source, java]
----
Expand All @@ -634,9 +643,9 @@ lqcf.setNodeLocator(new NodeLocator<MyClient>() {
}

@Override
public HashMap<String, Object> restCall(MyClient client, URI uri) {
public Map<String, Object> restCall(MyClient client, String baseUri, String vhost, String queue) throws URISyntaxException {
...
});
}

});
----
Expand Down