Skip to content

Use default client properties when reading from properties file #369

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 21, 2018
Merged

Use default client properties when reading from properties file #369

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
28 changes: 16 additions & 12 deletions src/main/java/com/rabbitmq/client/ConnectionFactoryConfigurator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,10 @@
* but also from the classpath, by using the <code>classpath:</code> prefix
* in the location.
*
* If default client properties should be set, set the <code>use.default.client.properties</code>
* key to <code>true</code>. Custom client properties can be set by using
* the <code>client.properties.</code>, e.g. <code>client.properties.app.name</code>.
* Client properties can be set by using
* the <code>client.properties.</code> prefix, e.g. <code>client.properties.app.name</code>.
* Default client properties and custom client properties are merged. To remove
* a default client property, set its key to an empty value.
*
* @since 4.4.0
* @see ConnectionFactory#load(String, String)
Expand All @@ -63,7 +64,6 @@ public class ConnectionFactoryConfigurator {
public static final String CONNECTION_TIMEOUT = "connection.timeout";
public static final String HANDSHAKE_TIMEOUT = "handshake.timeout";
public static final String SHUTDOWN_TIMEOUT = "shutdown.timeout";
public static final String USE_DEFAULT_CLIENT_PROPERTIES = "use.default.client.properties";
public static final String CLIENT_PROPERTIES_PREFIX = "client.properties.";
public static final String CONNECTION_RECOVERY_ENABLED = "connection.recovery.enabled";
public static final String TOPOLOGY_RECOVERY_ENABLED = "topology.recovery.enabled";
Expand Down Expand Up @@ -169,17 +169,21 @@ public static void load(ConnectionFactory cf, Map<String, String> properties, St
}

Map<String, Object> clientProperties = new HashMap<String, Object>();
String useDefaultClientProperties = properties.get(prefix + USE_DEFAULT_CLIENT_PROPERTIES);
if (useDefaultClientProperties != null && Boolean.valueOf(useDefaultClientProperties)) {
clientProperties.putAll(AMQConnection.defaultClientProperties());
}
Map<String, Object> defaultClientProperties = AMQConnection.defaultClientProperties();
clientProperties.putAll(defaultClientProperties);

for (Map.Entry<String, String> entry : properties.entrySet()) {
if (entry.getKey().startsWith(prefix + CLIENT_PROPERTIES_PREFIX)) {
clientProperties.put(
entry.getKey().substring((prefix + CLIENT_PROPERTIES_PREFIX).length()),
entry.getValue()
);
String clientPropertyKey = entry.getKey().substring((prefix + CLIENT_PROPERTIES_PREFIX).length());
if (defaultClientProperties.containsKey(clientPropertyKey) && (entry.getValue() == null || entry.getValue().trim().isEmpty())) {
// if default property and value is empty, remove this property
clientProperties.remove(clientPropertyKey);
} else {
clientProperties.put(
clientPropertyKey,
entry.getValue()
);
}
}
}
cf.setClientProperties(clientProperties);
Expand Down
26 changes: 19 additions & 7 deletions src/test/java/com/rabbitmq/client/test/PropertyFileInitialisationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,22 +91,34 @@ public static Object[] data() {
assertThat(cf.getPort(), is(5673));
}

@Test public void propertyInitialisationIncludeDefaultClientProperties() {
@Test public void propertyInitialisationIncludeDefaultClientPropertiesByDefault() {
cf.load(new HashMap<String, String>());
assertThat(cf.getClientProperties().entrySet(), hasSize(defaultClientProperties().size()));
}

@Test public void propertyInitialisationAddCustomClientProperty() {
cf.load(new HashMap<String, String>() {{
put("rabbitmq.use.default.client.properties", "true");
put("rabbitmq.client.properties.foo", "bar");
}});
assertThat(cf.getClientProperties().entrySet(), hasSize(defaultClientProperties().size() + 1));
assertThat(cf.getClientProperties().get("foo").toString(), is("bar"));
}

@Test public void propertyInitialisationDoNotIncludeDefaultClientProperties() {
@Test public void propertyInitialisationGetRidOfDefaultClientPropertyWithEmptyValue() {
final String key = defaultClientProperties().entrySet().iterator().next().getKey();
cf.load(new HashMap<String, String>() {{
put("rabbitmq.use.default.client.properties", "false");
put("rabbitmq.client.properties.foo", "bar");
put("rabbitmq.client.properties." + key, "");
}});
assertThat(cf.getClientProperties().entrySet(), hasSize(1));
assertThat(cf.getClientProperties().get("foo").toString(), is("bar"));
assertThat(cf.getClientProperties().entrySet(), hasSize(defaultClientProperties().size() - 1));
}

@Test public void propertyInitialisationOverrideDefaultClientProperty() {
final String key = defaultClientProperties().entrySet().iterator().next().getKey();
cf.load(new HashMap<String, String>() {{
put("rabbitmq.client.properties." + key, "whatever");
}});
assertThat(cf.getClientProperties().entrySet(), hasSize(defaultClientProperties().size()));
assertThat(cf.getClientProperties().get(key).toString(), is("whatever"));
}

@Test public void propertyInitialisationDoNotUseNio() throws Exception {
Expand Down