INT-3928 Ensure WS Adapters work when @EnableWS

JIRA: https://jira.spring.io/browse/INT-3928

The `@EnableWS` provides the `DelegatingWsConfiguration` which registers only `DefaultMethodEndpointAdapter`
overriding the default strategies including required for the SI `MessageEndpoint` implementations `MessageEndpointAdapter`.
That prevents the normal behavior for the SI gateways.

Implement `IntegrationConfigurationInitializer` for the WS module and register `MessageEndpointAdapter` bean for SI WS support.
This commit is contained in:
Artem Bilan
2016-01-13 18:59:09 -05:00
committed by Gary Russell
parent b1a09f5b0d
commit 2dc443022b
3 changed files with 242 additions and 0 deletions

View File

@@ -0,0 +1,69 @@
/*
* Copyright 2016 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.integration.ws.config;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.BeanDefinitionBuilder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.integration.config.IntegrationConfigurationInitializer;
import org.springframework.ws.server.EndpointAdapter;
import org.springframework.ws.server.endpoint.adapter.MessageEndpointAdapter;
/**
* The {@link IntegrationConfigurationInitializer} implementation for the WebService module.
* Registers {@link MessageEndpointAdapter} bean, because the usage of
* {@link org.springframework.ws.config.annotation.EnableWs} switches off the registration for the
* {@link MessageEndpointAdapter} as one of the default strategies.
* The {@link org.springframework.ws.config.annotation.EnableWs}
* registers only the {@link org.springframework.ws.server.endpoint.adapter.DefaultMethodEndpointAdapter},
* which isn't appropriate for the {@link org.springframework.ws.server.endpoint.MessageEndpoint} implementations.
*
*
* @author Artem Bilan
* @since 4.3
* @see org.springframework.ws.config.annotation.EnableWs
* @see org.springframework.ws.server.MessageDispatcher
*/
public class WsIntegrationConfigurationInitializer implements IntegrationConfigurationInitializer {
private static final String MESSAGE_ENDPOINT_ADAPTER_BEAN_NAME = "integrationWsMessageEndpointAdapter";
private static final Log logger = LogFactory.getLog(WsIntegrationConfigurationInitializer.class);
@Override
public void initialize(ConfigurableListableBeanFactory beanFactory) throws BeansException {
if (beanFactory instanceof BeanDefinitionRegistry) {
if (beanFactory.getBeanNamesForType(EndpointAdapter.class, false, false).length > 0) {
BeanDefinitionBuilder requestMappingBuilder =
BeanDefinitionBuilder.genericBeanDefinition(MessageEndpointAdapter.class);
requestMappingBuilder.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
((BeanDefinitionRegistry) beanFactory).registerBeanDefinition(MESSAGE_ENDPOINT_ADAPTER_BEAN_NAME,
requestMappingBuilder.getBeanDefinition());
}
}
else {
logger.warn("'IntegrationRequestMappingHandlerMapping' isn't registered because 'beanFactory'" +
" isn't an instance of `BeanDefinitionRegistry`.");
}
}
}

View File

@@ -0,0 +1,2 @@
org.springframework.integration.config.IntegrationConfigurationInitializer=\
org.springframework.integration.ws.config.WsIntegrationConfigurationInitializer

View File

@@ -0,0 +1,171 @@
/*
* Copyright 2016 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.integration.ws;
import static org.hamcrest.Matchers.instanceOf;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
import java.io.StringWriter;
import javax.xml.transform.Result;
import javax.xml.transform.Source;
import javax.xml.transform.stream.StreamResult;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.w3c.dom.Element;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.expression.spel.standard.SpelExpressionParser;
import org.springframework.integration.annotation.IntegrationComponentScan;
import org.springframework.integration.annotation.MessagingGateway;
import org.springframework.integration.annotation.Transformer;
import org.springframework.integration.channel.DirectChannel;
import org.springframework.integration.channel.QueueChannel;
import org.springframework.integration.config.EnableIntegration;
import org.springframework.integration.transformer.ExpressionEvaluatingTransformer;
import org.springframework.messaging.Message;
import org.springframework.messaging.MessageChannel;
import org.springframework.messaging.PollableChannel;
import org.springframework.test.annotation.DirtiesContext;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.ws.config.annotation.EnableWs;
import org.springframework.ws.context.MessageContext;
import org.springframework.ws.server.EndpointMapping;
import org.springframework.ws.server.endpoint.MessageEndpoint;
import org.springframework.ws.server.endpoint.annotation.Endpoint;
import org.springframework.ws.server.endpoint.annotation.PayloadRoot;
import org.springframework.ws.server.endpoint.annotation.RequestPayload;
import org.springframework.ws.server.endpoint.mapping.UriEndpointMapping;
import org.springframework.ws.soap.SoapMessage;
import org.springframework.ws.soap.server.SoapMessageDispatcher;
import org.springframework.ws.transport.WebServiceMessageReceiver;
import org.springframework.xml.transform.StringSource;
/**
* @author Artem Bilan
* @since 4.3
*/
@ContextConfiguration
@RunWith(SpringJUnit4ClassRunner.class)
@DirtiesContext
public class WebServiceInboundGatewayJavaConfigTests {
@Autowired
private WebServiceMessageReceiver messageReceiver;
@Autowired
private PollableChannel webserviceRequestsQueue;
@Test
public void testWebServiceInboundGatewayJavaConfig() throws Exception {
MessageContext context = mock(MessageContext.class);
SoapMessage request = mock(SoapMessage.class);
SoapMessage response = mock(SoapMessage.class);
String input = "<hello/>";
Source payloadSource = new StringSource(input);
StringWriter output = new StringWriter();
Result payloadResult = new StreamResult(output);
when(context.getResponse()).thenReturn(response);
when(response.getPayloadResult()).thenReturn(payloadResult);
when(context.getRequest()).thenReturn(request);
when(request.getPayloadSource()).thenReturn(payloadSource);
this.messageReceiver.receive(context);
assertTrue(output.toString().endsWith(input));
context = mock(MessageContext.class);
request = mock(SoapMessage.class);
payloadSource = new StringSource("<order/>");
when(context.getRequest()).thenReturn(request);
when(request.getPayloadSource()).thenReturn(payloadSource);
this.messageReceiver.receive(context);
Message<?> receive = this.webserviceRequestsQueue.receive(10000);
assertNotNull(receive);
assertThat(receive.getPayload(), instanceOf(Element.class));
Element order = (Element) receive.getPayload();
assertEquals("order", order.getLocalName());
}
@Configuration
@EnableIntegration
@EnableWs
@IntegrationComponentScan
public static class ContextConfiguration {
@Bean
public WebServiceMessageReceiver messageDispatcher() {
return new SoapMessageDispatcher();
}
@Bean
public EndpointMapping uriEndpointMapping() {
UriEndpointMapping endpointMapping = new UriEndpointMapping();
endpointMapping.setDefaultEndpoint(wsGateway());
return endpointMapping;
}
@Bean
public MessageEndpoint wsGateway() {
SimpleWebServiceInboundGateway gateway = new SimpleWebServiceInboundGateway();
gateway.setRequestChannel(gatewayRequests());
return gateway;
}
@Bean
public MessageChannel gatewayRequests() {
return new DirectChannel();
}
@Bean
@Transformer(inputChannel = "gatewayRequests")
public ExpressionEvaluatingTransformer transformer() {
return new ExpressionEvaluatingTransformer(new SpelExpressionParser().parseExpression("payload.toString()"));
}
@Bean
public PollableChannel webserviceRequestsQueue() {
return new QueueChannel();
}
}
@Endpoint
@MessagingGateway(defaultRequestChannel = "webserviceRequestsQueue")
interface WebService {
@PayloadRoot(localPart = "order")
void order(@RequestPayload Element orderElement);
}
}