Spring/spring-integration
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

JMX: Quote object name values if not identifiers

Browse Source 
https://www.oracle.com/technetwork/java/javase/tech/best-practices-jsp-136021.html

The set of characters in a value is also limited. If special characters may
occur, it is recommended that the value be quoted, using ObjectName.quote. If
the value for a given key is sometimes quoted, then it should always be quoted.
By default, if a value is a string (rather than a number, say), then it should
be quoted unless you are sure that it will never contain special characters.

Practically, some special characters are allowed, but we will standardize on
allowed characters in java identifiers.

In 5.0.x, this is enabled using `spring.integration.properties`.
This commit is contained in:
Gary Russell
2018-10-09 14:56:31 -04:00
committed by Artem Bilan
parent 7403e36c1e
commit c111e1be6a
6 changed files with 49 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
spring-integration-jmx/src/main/java/org/springframework/integration/monitor/IntegrationMBeanExporter.java
View File

@@ -28,6 +28,7 @@ import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicLong;
import java.util.concurrent.atomic.AtomicReference;
import javax.lang.model.SourceVersion;
import javax.management.DynamicMBean;
import javax.management.JMException;
import javax.management.ObjectName;
@@ -157,6 +158,8 @@ public class IntegrationMBeanExporter extends MBeanExporter implements Applicati
private final AtomicBoolean shuttingDown = new AtomicBoolean();
private boolean quoteNames;
public IntegrationMBeanExporter() {
super();
@@ -216,6 +219,14 @@ public class IntegrationMBeanExporter extends MBeanExporter implements Applicati
@Override
public void afterSingletonsInstantiated() {
if (this.applicationContext.containsBean(IntegrationContextUtils.INTEGRATION_GLOBAL_PROPERTIES_BEAN_NAME)) {
Properties props = this.applicationContext
.getBean(IntegrationContextUtils.INTEGRATION_GLOBAL_PROPERTIES_BEAN_NAME, Properties.class);
String prop = props.getProperty("spring.integration.jmx.quote.names");
if (prop != null) {
this.quoteNames = Boolean.parseBoolean(prop);
}
}
Map<String, MessageHandlerMetrics> messageHandlers =
this.applicationContext.getBeansOfType(MessageHandlerMetrics.class);
for (Entry<String, MessageHandlerMetrics> entry : messageHandlers.entrySet()) {
@@ -744,28 +755,43 @@ public class IntegrationMBeanExporter extends MBeanExporter implements Applicati
}
private String getChannelBeanKey(String channel) {
String name = "" + channel;
if (name.startsWith("org.springframework.integration")) {
name = name + ",source=anonymous";
String extra = "";
if (channel.startsWith("org.springframework.integration")) {
extra = ",source=anonymous";
}
return String.format(this.domain + ":type=MessageChannel,name=%s" + getStaticNames(), name);
return String.format(this.domain + ":type=MessageChannel,name=%s%s" + getStaticNames(),
quoteIfNecessary(channel), extra);
}
private String getHandlerBeanKey(MessageHandlerMetrics handler) {
// This ordering of keys seems to work with default settings of JConsole
return String.format(this.domain + ":type=MessageHandler,name=%s,bean=%s" + getStaticNames(),
handler.getManagedName(), handler.getManagedType());
quoteIfNecessary(handler.getManagedName()), quoteIfNecessary(handler.getManagedType()));
}
private String getSourceBeanKey(MessageSourceMetrics source) {
// This ordering of keys seems to work with default settings of JConsole
return String.format(this.domain + ":type=MessageSource,name=%s,bean=%s" + getStaticNames(),
source.getManagedName(), source.getManagedType());
quoteIfNecessary(source.getManagedName()), quoteIfNecessary(source.getManagedType()));
}
private String getEndpointBeanKey(AbstractEndpoint endpoint, String name, String source) {
// This ordering of keys seems to work with default settings of JConsole
return String.format(this.domain + ":type=ManagedEndpoint,name=%s,bean=%s" + getStaticNames(), name, source);
return String.format(this.domain + ":type=ManagedEndpoint,name=%s,bean=%s" + getStaticNames(),
quoteIfNecessary(name), source);
}
/*
* https://www.oracle.com/technetwork/java/javase/tech/best-practices-jsp-136021.html
*
* The set of characters in a value is also limited. If special characters may
* occur, it is recommended that the value be quoted, using ObjectName.quote. If
* the value for a given key is sometimes quoted, then it should always be quoted.
* By default, if a value is a string (rather than a number, say), then it should
* be quoted unless you are sure that it will never contain special characters.
*/
private String quoteIfNecessary(String name) {
return SourceVersion.isName(name) ? name : this.quoteNames ? ObjectName.quote(name) : name;
}
private String getStaticNames() {

2
spring-integration-jmx/src/test/java/org/springframework/integration/jmx/config/NotificationPublishingChannelAdapterParserTests-context.xml
View File

@@ -23,6 +23,8 @@
<si:channel id="channel"/>
<si:channel id="org.springframework.integration.test.anon"/>
<jmx:notification-publishing-channel-adapter
id="adapter" channel="channel"
object-name="test.publisher:name=publisher"

10
spring-integration-jmx/src/test/java/org/springframework/integration/jmx/config/NotificationPublishingChannelAdapterParserTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2016 the original author or authors.
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -139,8 +139,12 @@ public class NotificationPublishingChannelAdapterParserTests {
assertEquals("test.type", notification.getType());
assertNull(notification.getUserData());
Set<ObjectName> names = server
.queryNames(new ObjectName("*:type=MessageHandler," + "name=chainWithJmxNotificationPublishing$child."
+ "jmx-notification-publishing-channel-adapter-within-chain,*"), null);
.queryNames(new ObjectName("*:type=MessageHandler," + "name=\"chainWithJmxNotificationPublishing$child."
+ "jmx-notification-publishing-channel-adapter-within-chain\",*"), null);
assertEquals(1, names.size());
names = server
.queryNames(new ObjectName("*:type=MessageChannel,"
+ "name=org.springframework.integration.test.anon,source=anonymous,*"), null);
assertEquals(1, names.size());
}

4
spring-integration-jmx/src/test/java/org/springframework/integration/monitor/MessagingGatewaySupportRegistrationTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2015-2016 the original author or authors.
* Copyright 2015-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -60,7 +60,7 @@ public class MessagingGatewaySupportRegistrationTests {
names = this.server.queryNames(new ObjectName("org.springframework.integration:*,type=MessageSource,name=foo"),
null);
assertEquals(1, names.size());
names = this.server.queryNames(new ObjectName("org.springframework.integration:*,name=foo#2"), null);
names = this.server.queryNames(new ObjectName("org.springframework.integration:*,name=\"foo#2\""), null);
assertEquals(1, names.size());
}

1
spring-integration-jmx/src/test/resources/META-INF/spring.integration.properties Normal file
View File

@@ -0,0 +1 @@
spring.integration.jmx.quote.names=true

4
src/reference/asciidoc/jmx.adoc
View File

@@ -301,6 +301,10 @@ NOTE: The default naming strategy is a http://docs.spring.io/spring/docs/current
The exporter propagates the `default-domain` to that object to allow it to generate a fallback object name if parsing of the bean key fails.
If your custom naming strategy is a `MetadataNamingStrategy` (or subclass), the exporter will *not* propagate the `default-domain`; you will need to configure it on your strategy bean.
Starting with version 5.0.9; any bean names (represented by the `name` key in the object name) can be quoted if they contain any characters that are not allowed in a Java identifier (or period `.`).
This requires setting `spring.integration.jmx.quote.names=true` in a `META-INF/spring.integration.properties` file on the class path.
In 5.1 it will not be configurable.
[[jmx-42-improvements]]
===== JMX Improvements