INT-1240 'operation name' and 'object name' is now required

This commit is contained in:
Oleg Zhurakousky
2010-07-19 04:07:22 +00:00
parent f331442974
commit 70788ee097
7 changed files with 197 additions and 220 deletions

View File

@@ -152,38 +152,35 @@ public class OperationInvokingMessageHandler extends AbstractReplyProducingMessa
}
/**
* First checks for the presence of a {@link JmxHeaders#OBJECT_NAME} header,
* then falls back to this handler's {@link #defaultObjectName} if available.
* First checks if defaultObjectName is set, otherwise falls back on {@link JmxHeaders#OBJECT_NAME} header.
*/
private ObjectName resolveObjectName(Message<?> message) {
ObjectName objectName = null;
Object objectNameHeader = message.getHeaders().get(JmxHeaders.OBJECT_NAME);
if (objectNameHeader instanceof ObjectName) {
objectName = (ObjectName) objectNameHeader;
}
else if (objectNameHeader instanceof String) {
try {
objectName = ObjectNameManager.getInstance(objectNameHeader);
ObjectName objectName = this.defaultObjectName;
if (objectName == null){
Object objectNameHeader = message.getHeaders().get(JmxHeaders.OBJECT_NAME);
if (objectNameHeader instanceof ObjectName) {
objectName = (ObjectName) objectNameHeader;
}
catch (MalformedObjectNameException e) {
throw new IllegalArgumentException(e);
else if (objectNameHeader instanceof String) {
try {
objectName = ObjectNameManager.getInstance(objectNameHeader);
}
catch (MalformedObjectNameException e) {
throw new IllegalArgumentException(e);
}
}
}
else {
objectName = this.defaultObjectName;
}
Assert.notNull(objectName, "Failed to resolve ObjectName.");
return objectName;
}
/**
* First checks for the presence of a {@link JmxHeaders#OPERATION_NAME} header,
* then falls back to this handler's {@link #defaultOperationName} if available.
* First checks if defaultOperationName is set, otherwise falls back on {@link JmxHeaders#OPERATION_NAME} header.
*/
private String resolveOperationName(Message<?> message) {
String operationName = message.getHeaders().get(JmxHeaders.OPERATION_NAME, String.class);
if (operationName == null) {
operationName = this.defaultOperationName;
String operationName = this.defaultOperationName;
if (operationName == null){
operationName = message.getHeaders().get(JmxHeaders.OPERATION_NAME, String.class);
}
Assert.notNull(operationName, "Failed to resolve operation name.");
return operationName;

View File

@@ -26,15 +26,16 @@
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence minOccurs="0" maxOccurs="1">
<xsd:element ref="integration:poller"/>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:string" use="optional"/>
<xsd:attribute name="channel" type="xsd:string" use="optional"/>
<xsd:attribute name="mbean-server" type="xsd:string" default="mbeanServer"/>
<xsd:attribute name="object-name" type="xsd:string" use="required"/>
<xsd:attribute name="attribute-name" type="xsd:string" use="required"/>
<xsd:attribute name="auto-startup" type="xsd:string" default="true"/>
<xsd:complexContent>
<xsd:extension base="adapterType">
<xsd:sequence minOccurs="0" maxOccurs="1">
<xsd:element ref="integration:poller"/>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:ID" />
<xsd:attribute name="attribute-name" type="xsd:string" use="required"/>
<xsd:attribute name="auto-startup" type="xsd:string" default="true"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<xsd:element name="operation-invoking-outbound-gateway">
@@ -44,12 +45,13 @@
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="id" type="xsd:string" use="optional"/>
<xsd:attribute name="request-channel" type="xsd:string" use="required"/>
<xsd:attribute name="reply-channel" type="xsd:string" use="optional"/>
<xsd:attribute name="mbean-server" type="xsd:string" default="mbeanServer"/>
<xsd:attribute name="default-object-name" type="xsd:string" use="optional"/>
<xsd:attribute name="default-operation-name" type="xsd:string" use="optional"/>
<xsd:complexContent>
<xsd:extension base="operationInvokingType">
<xsd:attribute name="id" type="xsd:ID"/>
<xsd:attribute name="request-channel" type="xsd:string" use="required"/>
<xsd:attribute name="reply-channel" type="xsd:string" use="optional"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
@@ -60,11 +62,12 @@
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="id" type="xsd:string" use="optional"/>
<xsd:attribute name="channel" type="xsd:string" use="optional"/>
<xsd:attribute name="mbean-server" type="xsd:string" default="mbeanServer"/>
<xsd:attribute name="default-object-name" type="xsd:string" use="optional"/>
<xsd:attribute name="default-operation-name" type="xsd:string" use="optional"/>
<xsd:complexContent>
<xsd:extension base="operationInvokingType">
<xsd:attribute name="id" type="xsd:ID"/>
<xsd:attribute name="channel" type="xsd:string" use="optional"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
@@ -75,13 +78,14 @@
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="id" type="xsd:string" use="optional"/>
<xsd:attribute name="channel" type="xsd:string" use="required"/>
<xsd:attribute name="mbean-server" type="xsd:string" default="mbeanServer"/>
<xsd:attribute name="object-name" type="xsd:string" use="required"/>
<xsd:attribute name="notification-filter" type="xsd:string" use="optional"/>
<xsd:attribute name="handback" type="xsd:string" use="optional"/>
<xsd:attribute name="send-timeout" type="xsd:string" use="optional"/>
<xsd:complexContent>
<xsd:extension base="adapterType">
<xsd:attribute name="id" type="xsd:ID" />
<xsd:attribute name="notification-filter" type="xsd:string" use="optional"/>
<xsd:attribute name="handback" type="xsd:string" use="optional"/>
<xsd:attribute name="send-timeout" type="xsd:string" use="optional"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
@@ -92,10 +96,12 @@
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="id" type="xsd:string" use="optional"/>
<xsd:attribute name="channel" type="xsd:string" use="required"/>
<xsd:attribute name="object-name" type="xsd:string" use="required"/>
<xsd:attribute name="default-notification-type" type="xsd:string" use="optional"/>
<xsd:complexContent>
<xsd:extension base="adapterType">
<xsd:attribute name="id" type="xsd:ID" />
<xsd:attribute name="default-notification-type" type="xsd:string" use="optional"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
@@ -107,35 +113,70 @@
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:attribute name="id" use="optional"/>
<xsd:attribute name="mbean-server" use="optional">
<xsd:annotation>
<xsd:documentation>
The MBeanServer to which this Control Bus should export MBeans.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="domain" use="optional">
<xsd:annotation>
<xsd:documentation>
The domain name for the MBeans exported by this Control Bus.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="operation-channel" use="optional">
<xsd:annotation>
<xsd:documentation>
The Message Channel that can be used to send operation commands to
this Control Bus. It must implement SubscribableChannel.
</xsd:documentation>
<xsd:appinfo>
<tool:annotation>
<tool:expected-type type="org.springframework.integration.channel.SubscribableChannel"/>
</tool:annotation>
</xsd:appinfo>
</xsd:annotation>
</xsd:attribute>
<xsd:complexContent>
<xsd:extension base="mbeanServerIdentifyerType">
<xsd:attribute name="id" type="xsd:ID" />
<xsd:attribute name="domain" use="optional">
<xsd:annotation>
<xsd:documentation>
The domain name for the MBeans exported by this Control Bus.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="operation-channel" use="optional">
<xsd:annotation>
<xsd:documentation>
The Message Channel that can be used to send operation commands to
this Control Bus. It must implement SubscribableChannel.
</xsd:documentation>
<xsd:appinfo>
<tool:annotation>
<tool:expected-type type="org.springframework.integration.channel.SubscribableChannel"/>
</tool:annotation>
</xsd:appinfo>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<xsd:complexType name="adapterType">
<xsd:annotation>
<xsd:documentation>
Defines inbound operation invoking type
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="mbeanServerIdentifyerType">
<xsd:attribute name="channel" type="xsd:string" use="required"/>
<xsd:attribute name="object-name" type="xsd:string" use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="operationInvokingType">
<xsd:annotation>
<xsd:documentation>
Defines outbound operation invoking type
</xsd:documentation>
</xsd:annotation>
<xsd:complexContent>
<xsd:extension base="mbeanServerIdentifyerType">
<xsd:attribute name="default-object-name" type="xsd:string" use="required"/>
<xsd:attribute name="default-operation-name" type="xsd:string" use="required"/>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<xsd:complexType name="mbeanServerIdentifyerType">
<xsd:attribute name="mbean-server" type="xsd:string" default="mbeanServer">
<xsd:annotation>
<xsd:documentation>
Defines the name of the MBeanServer bean to connect to.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
</xsd:schema>

View File

@@ -71,12 +71,12 @@ public class OperationInvokingMessageHandlerTests {
handler.setServer(this.server);
handler.setDefaultObjectName(this.objectName);
handler.setOutputChannel(outputChannel);
handler.setDefaultOperationName("x");
handler.afterPropertiesSet();
Map<String, Object> params = new HashMap<String, Object>();
params.put("p1", "foo");
params.put("p2", "bar");
Message<?> message = MessageBuilder.withPayload(params)
.setHeader(JmxHeaders.OPERATION_NAME, "x").build();
Message<?> message = MessageBuilder.withPayload(params).build();
handler.handleMessage(message);
Message<?> reply = outputChannel.receive(0);
assertNotNull(reply);
@@ -90,9 +90,9 @@ public class OperationInvokingMessageHandlerTests {
handler.setServer(this.server);
handler.setDefaultObjectName(this.objectName);
handler.setOutputChannel(outputChannel);
handler.setDefaultOperationName("y");
handler.afterPropertiesSet();
Message<?> message = MessageBuilder.withPayload("foo")
.setHeader(JmxHeaders.OPERATION_NAME, "y").build();
Message<?> message = MessageBuilder.withPayload("foo").build();
handler.handleMessage(message);
}
@@ -103,11 +103,11 @@ public class OperationInvokingMessageHandlerTests {
handler.setServer(this.server);
handler.setDefaultObjectName(this.objectName);
handler.setOutputChannel(outputChannel);
handler.setDefaultOperationName("x");
handler.afterPropertiesSet();
Map<String, Object> params = new HashMap<String, Object>();
params.put("p1", "foo");
Message<?> message = MessageBuilder.withPayload(params)
.setHeader(JmxHeaders.OPERATION_NAME, "x").build();
Message<?> message = MessageBuilder.withPayload(params).build();
handler.handleMessage(message);
Message<?> reply = outputChannel.receive(0);
assertNotNull(reply);
@@ -121,10 +121,10 @@ public class OperationInvokingMessageHandlerTests {
handler.setServer(this.server);
handler.setDefaultObjectName(this.objectName);
handler.setOutputChannel(outputChannel);
handler.setDefaultOperationName("x");
handler.afterPropertiesSet();
List<Object> params = Arrays.asList(new Object[] { "foo", new Integer(123) });
Message<?> message = MessageBuilder.withPayload(params)
.setHeader(JmxHeaders.OPERATION_NAME, "x").build();
Message<?> message = MessageBuilder.withPayload(params).build();
handler.handleMessage(message);
Message<?> reply = outputChannel.receive(0);
assertNotNull(reply);

View File

@@ -16,14 +16,10 @@
<context:mbean-export/>
<context:mbean-server/>
<jmx:operation-invoking-channel-adapter id="withDefaultsChannel"
default-object-name="org.springframework.integration.jmx.config:type=TestBean,name=testBeanForDefaults"
<jmx:operation-invoking-channel-adapter id="input"
default-object-name="org.springframework.integration.jmx.config:type=TestBean,name=testBeanAdapter"
default-operation-name="test"/>
<jmx:operation-invoking-channel-adapter id="withoutDefaultsChannel"/>
<bean id="testBeanForDefaults" class="org.springframework.integration.jmx.config.TestBean"/>
<bean id="testBeanForNoDefaults" class="org.springframework.integration.jmx.config.TestBean"/>
<bean id="testBeanAdapter" class="org.springframework.integration.jmx.config.TestBean"/>
</beans>

View File

@@ -21,7 +21,6 @@ import static org.junit.Assert.assertEquals;
import org.junit.After;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.integration.core.Message;
import org.springframework.integration.core.MessageChannel;
@@ -33,6 +32,7 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
/**
* @author Mark Fisher
* @author Oleg Zhurakousky
* @since 2.0
*/
@ContextConfiguration
@@ -40,54 +40,39 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
public class OperationInvokingChannelAdapterParserTests {
@Autowired
private MessageChannel withDefaultsChannel;
private MessageChannel input;
@Autowired
private MessageChannel withoutDefaultsChannel;
@Autowired
private TestBean testBeanForDefaults;
@Autowired
private TestBean testBeanForNoDefaults;
private TestBean testBean;
@After
public void resetLists() {
testBeanForDefaults.messages.clear();
testBeanForNoDefaults.messages.clear();
testBean.messages.clear();
}
@Test
public void adapterWithDefaults() throws Exception {
assertEquals(0, testBeanForDefaults.messages.size());
assertEquals(0, testBeanForNoDefaults.messages.size());
withDefaultsChannel.send(new StringMessage("test1"));
withDefaultsChannel.send(new StringMessage("test2"));
withDefaultsChannel.send(new StringMessage("test3"));
assertEquals(3, testBeanForDefaults.messages.size());
assertEquals(0, testBeanForNoDefaults.messages.size());
assertEquals(0, testBean.messages.size());
input.send(new StringMessage("test1"));
input.send(new StringMessage("test2"));
input.send(new StringMessage("test3"));
assertEquals(3, testBean.messages.size());
}
@Test
public void adapterWithoutDefaults() throws Exception {
assertEquals(0, testBeanForDefaults.messages.size());
assertEquals(0, testBeanForNoDefaults.messages.size());
withoutDefaultsChannel.send(createMessageWithHeaders("1"));
withoutDefaultsChannel.send(createMessageWithHeaders("2"));
withoutDefaultsChannel.send(createMessageWithHeaders("3"));
assertEquals(0, testBeanForDefaults.messages.size());
assertEquals(3, testBeanForNoDefaults.messages.size());
// Headers should be ignored
public void adapterWitJmxHeaders() throws Exception {
assertEquals(0, testBean.messages.size());
input.send(this.createMessage("1"));
input.send(this.createMessage("2"));
input.send(this.createMessage("3"));
assertEquals(3, testBean.messages.size());
}
private static Message<String> createMessageWithHeaders(String payload) {
String objectName = "org.springframework.integration.jmx.config:name=testBeanForNoDefaults,type=TestBean";
private Message<?> createMessage(String payload){
return MessageBuilder.withPayload(payload)
.setHeader(JmxHeaders.OBJECT_NAME, objectName)
.setHeader(JmxHeaders.OPERATION_NAME, "test")
.build();
.setHeader(JmxHeaders.OBJECT_NAME, "org.springframework.integration.jmx.config:type=TestBean,name=foo")
.setHeader(JmxHeaders.OPERATION_NAME, "blah").build();
}
}

View File

@@ -16,39 +16,26 @@
<context:mbean-export/>
<context:mbean-server/>
<si:channel id="noDefaultInput"/>
<si:channel id="withReplyChannel"/>
<si:channel id="noDefaultOutput">
<si:channel id="withReplyChannelOutput">
<si:queue/>
</si:channel>
<si:channel id="noDefaultInputA"/>
<si:channel id="withNoReplyChannel"/>
<si:channel id="noDefaultOutputA">
<si:channel id="withNoReplyChannelOutput">
<si:queue/>
</si:channel>
<si:channel id="defaultInput"/>
<si:channel id="defaultOutput">
<si:queue/>
</si:channel>
<jmx:operation-invoking-outbound-gateway request-channel="defaultInput"
reply-channel="defaultOutput"
default-object-name="org.springframework.integration.jmx.config:type=TestBean,name=testBeanForDefaultsGateway"
<jmx:operation-invoking-outbound-gateway request-channel="withReplyChannel"
reply-channel="withReplyChannelOutput"
default-object-name="org.springframework.integration.jmx.config:type=TestBean,name=testBeanGateway"
default-operation-name="testWithReturn"/>
<jmx:operation-invoking-outbound-gateway request-channel="noDefaultInput"
reply-channel="noDefaultOutput"/>
<jmx:operation-invoking-outbound-gateway request-channel="noDefaultInputA"/>
<jmx:operation-invoking-outbound-gateway request-channel="withNoReplyChannel"
default-object-name="org.springframework.integration.jmx.config:type=TestBean,name=testBeanGateway"
default-operation-name="testWithReturn"/>
<bean id="testBeanForNoDefaultsGateway" class="org.springframework.integration.jmx.config.TestBean"/>
<bean id="testBeanForDefaultsGateway" class="org.springframework.integration.jmx.config.TestBean"/>
<bean id="testBeanGateway" class="org.springframework.integration.jmx.config.TestBean"/>
</beans>

View File

@@ -41,83 +41,54 @@ import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@RunWith(SpringJUnit4ClassRunner.class)
public class OperationInvokingOutboundGatewayTests {
@Autowired
@Qualifier("noDefaultInput")
private MessageChannel noDefaultInput;
@Qualifier("withReplyChannel")
private MessageChannel withReplyChannel;
@Autowired
@Qualifier("withReplyChannelOutput")
private PollableChannel withReplyChannelOutput;
@Autowired
@Qualifier("noDefaultOutput")
private PollableChannel noDefaultOutput;
@Qualifier("withNoReplyChannel")
private MessageChannel withNoReplyChannel;
@Autowired
@Qualifier("noDefaultInputA")
private MessageChannel noDefaultInputA;
@Qualifier("withNoReplyChannelOutput")
private PollableChannel withNoReplyChannelOutput;
@Autowired
@Qualifier("noDefaultOutputA")
private PollableChannel noDefaultOutputA;
@Autowired
@Qualifier("defaultInput")
private MessageChannel defaultInput;
@Autowired
@Qualifier("defaultOutput")
private PollableChannel defaultOutput;
@Autowired
private TestBean testBeanForDefaultsGateway;
private TestBean testBean;
@Autowired
private TestBean testBeanForNoDefaultsGateway;
@After
public void resetLists() {
testBeanForDefaultsGateway.messages.clear();
testBeanForNoDefaultsGateway.messages.clear();
testBean.messages.clear();
}
@Test
public void adapterWithoutNoDefaultsAndReturn() throws Exception {
noDefaultInput.send(createMessageWithHeadersForReturnCase("1"));
assertEquals(1, ((List<?>)noDefaultOutput.receive().getPayload()).size());
noDefaultInput.send(createMessageWithHeadersForReturnCase("2"));
assertEquals(2, ((List<?>)noDefaultOutput.receive().getPayload()).size());
noDefaultInput.send(createMessageWithHeadersForReturnCase("3"));
assertEquals(3, ((List<?>)noDefaultOutput.receive().getPayload()).size());
public void gatewayWithReplyChannel() throws Exception {
withReplyChannel.send(new StringMessage("1"));
assertEquals(1, ((List<?>)withReplyChannelOutput.receive().getPayload()).size());
withReplyChannel.send(new StringMessage("2"));
assertEquals(2, ((List<?>)withReplyChannelOutput.receive().getPayload()).size());
withReplyChannel.send(new StringMessage("3"));
assertEquals(3, ((List<?>)withReplyChannelOutput.receive().getPayload()).size());
}
@Test
public void adapterWithoutNoDefaultsAndReturnAndReplyChannel() throws Exception {
noDefaultInputA.send(createMessageWithHeadersForReturnCaseAndReplyChannel("1", noDefaultOutputA));
assertEquals(1, ((List<?>)noDefaultOutputA.receive().getPayload()).size());
noDefaultInputA.send(createMessageWithHeadersForReturnCaseAndReplyChannel("2", noDefaultOutputA));
assertEquals(2, ((List<?>)noDefaultOutputA.receive().getPayload()).size());
noDefaultInputA.send(createMessageWithHeadersForReturnCaseAndReplyChannel("3", noDefaultOutputA));
assertEquals(3, ((List<?>)noDefaultOutputA.receive().getPayload()).size());
}
@Test
public void adapterWithoutDefaultsAndReturn() throws Exception {
defaultInput.send(new StringMessage("1"));
assertEquals(1, ((List<?>)defaultOutput.receive().getPayload()).size());
defaultInput.send(new StringMessage("2"));
assertEquals(2, ((List<?>)defaultOutput.receive().getPayload()).size());
defaultInput.send(new StringMessage("3"));
assertEquals(3, ((List<?>)defaultOutput.receive().getPayload()).size());
}
private static Message<String> createMessageWithHeadersForReturnCase(String payload) {
String objectName = "org.springframework.integration.jmx.config:name=testBeanForNoDefaultsGateway,type=TestBean";
return MessageBuilder.withPayload(payload)
.setHeader(JmxHeaders.OBJECT_NAME, objectName)
.setHeader(JmxHeaders.OPERATION_NAME, "testWithReturn")
.build();
}
private static Message<String> createMessageWithHeadersForReturnCaseAndReplyChannel(String payload, MessageChannel replyChannel) {
String objectName = "org.springframework.integration.jmx.config:name=testBeanForNoDefaultsGateway,type=TestBean";
return MessageBuilder.withPayload(payload)
.setHeader(JmxHeaders.OBJECT_NAME, objectName)
.setHeader(JmxHeaders.OPERATION_NAME, "testWithReturn")
.setReplyChannel(replyChannel)
.build();
}
// @Test
// public void adapterWithoutNoDefaultsAndReturnAndReplyChannel() throws Exception {
// noDefaultInputA.send(createMessageWithHeadersForReturnCaseAndReplyChannel("1", noDefaultOutputA));
// assertEquals(1, ((List<?>)noDefaultOutputA.receive().getPayload()).size());
// noDefaultInputA.send(createMessageWithHeadersForReturnCaseAndReplyChannel("2", noDefaultOutputA));
// assertEquals(2, ((List<?>)noDefaultOutputA.receive().getPayload()).size());
// noDefaultInputA.send(createMessageWithHeadersForReturnCaseAndReplyChannel("3", noDefaultOutputA));
// assertEquals(3, ((List<?>)noDefaultOutputA.receive().getPayload()).size());
// }
//
// @Test
// public void adapterWithoutDefaultsAndReturn() throws Exception {
// defaultInput.send(new StringMessage("1"));
// assertEquals(1, ((List<?>)defaultOutput.receive().getPayload()).size());
// defaultInput.send(new StringMessage("2"));
// assertEquals(2, ((List<?>)defaultOutput.receive().getPayload()).size());
// defaultInput.send(new StringMessage("3"));
// assertEquals(3, ((List<?>)defaultOutput.receive().getPayload()).size());
// }
}