All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.citrusframework.ws.client.WebServiceClient Maven / Gradle / Ivy
/*
* Copyright 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.citrusframework.ws.client;
import java.io.IOException;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import org.citrusframework.context.TestContext;
import org.citrusframework.endpoint.AbstractEndpoint;
import org.citrusframework.exceptions.CitrusRuntimeException;
import org.citrusframework.exceptions.MessageTimeoutException;
import org.citrusframework.message.ErrorHandlingStrategy;
import org.citrusframework.message.Message;
import org.citrusframework.message.MessageHeaders;
import org.citrusframework.message.correlation.CorrelationManager;
import org.citrusframework.message.correlation.PollingCorrelationManager;
import org.citrusframework.messaging.Producer;
import org.citrusframework.messaging.ReplyConsumer;
import org.citrusframework.messaging.SelectiveConsumer;
import org.citrusframework.util.ObjectHelper;
import org.citrusframework.ws.interceptor.LoggingClientInterceptor;
import org.citrusframework.ws.message.SoapMessage;
import org.citrusframework.ws.message.callback.SoapRequestMessageCallback;
import org.citrusframework.ws.message.callback.SoapResponseMessageCallback;
import org.citrusframework.xml.StringResult;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.ws.WebServiceMessage;
import org.springframework.ws.client.core.FaultMessageResolver;
import org.springframework.ws.client.core.SimpleFaultMessageResolver;
import org.springframework.ws.soap.client.core.SoapFaultMessageResolver;
/**
* Client sends SOAP WebService messages to some server endpoint via Http protocol. Client waits for synchronous
* SOAP response message.
* @since 1.4
*/
public class WebServiceClient extends AbstractEndpoint implements Producer, ReplyConsumer {
/** Logger */
private static final Logger logger = LoggerFactory.getLogger(WebServiceClient.class);
/** Store of reply messages */
private CorrelationManager correlationManager;
/**
* Default constructor initializing endpoint configuration.
*/
public WebServiceClient() {
this(new WebServiceEndpointConfiguration());
}
/**
* Constructor using endpoint configuration.
* @param endpointConfiguration
*/
public WebServiceClient(WebServiceEndpointConfiguration endpointConfiguration) {
super(endpointConfiguration);
this.correlationManager = new PollingCorrelationManager<>(endpointConfiguration, "Reply message did not arrive yet");
}
@Override
public WebServiceEndpointConfiguration getEndpointConfiguration() {
return (WebServiceEndpointConfiguration) super.getEndpointConfiguration();
}
@Override
public void send(Message message, TestContext context) {
ObjectHelper.assertNotNull(message, "Message is empty - unable to send empty message");
getEndpointConfiguration().getInterceptors()
.stream()
.filter(LoggingClientInterceptor.class::isInstance)
.map(LoggingClientInterceptor.class::cast)
.filter(interceptor -> !interceptor.hasMessageListeners())
.forEach(interceptor -> interceptor.setMessageListener(context.getMessageListeners()));
SoapMessage soapMessage;
if (message instanceof SoapMessage) {
soapMessage = (SoapMessage) message;
} else {
soapMessage = new SoapMessage(message);
}
String correlationKeyName = getEndpointConfiguration().getCorrelator().getCorrelationKeyName(getName());
String correlationKey = getEndpointConfiguration().getCorrelator().getCorrelationKey(soapMessage);
correlationManager.saveCorrelationKey(correlationKeyName, correlationKey, context);
final String endpointUri;
if (getEndpointConfiguration().getEndpointResolver() != null) {
endpointUri = getEndpointConfiguration().getEndpointResolver().resolveEndpointUri(soapMessage, getEndpointConfiguration().getDefaultUri());
} else { // use default uri
endpointUri = getEndpointConfiguration().getDefaultUri();
}
context.setVariable(MessageHeaders.MESSAGE_REPLY_TO + "_" + correlationKeyName, endpointUri);
if (logger.isDebugEnabled()) {
logger.debug("Sending SOAP message to endpoint: '" + endpointUri + "'");
logger.debug("Message to send is:\n" + soapMessage.toString());
}
if (!(soapMessage.getPayload() instanceof String)) {
throw new CitrusRuntimeException("Unsupported payload type '" + soapMessage.getPayload().getClass() +
"' Currently only 'java.lang.String' is supported as payload type.");
}
SoapRequestMessageCallback requestCallback = new SoapRequestMessageCallback(soapMessage, getEndpointConfiguration(), context);
SoapResponseMessageCallback responseCallback = new SoapResponseMessageCallback(getEndpointConfiguration(), context);
getEndpointConfiguration().getWebServiceTemplate().setFaultMessageResolver(new InternalFaultMessageResolver(correlationKey, endpointUri, context));
boolean result;
// send and receive message
if (getEndpointConfiguration().getEndpointResolver() != null) {
result = getEndpointConfiguration().getWebServiceTemplate().sendAndReceive(endpointUri, requestCallback, responseCallback);
} else { // use default endpoint uri
result = getEndpointConfiguration().getWebServiceTemplate().sendAndReceive(requestCallback, responseCallback);
}
logger.info("SOAP message was sent to endpoint: '" + endpointUri + "'");
if (result) {
logger.info("Received SOAP response on endpoint: '" + endpointUri + "'");
correlationManager.store(correlationKey, responseCallback.getResponse());
} else {
logger.info("Received no SOAP response from endpoint: '" + endpointUri + "'");
}
}
@Override
public Message receive(TestContext context) {
return receive(correlationManager.getCorrelationKey(
getEndpointConfiguration().getCorrelator().getCorrelationKeyName(getName()), context), context);
}
@Override
public Message receive(String selector, TestContext context) {
return receive(selector, context, getEndpointConfiguration().getTimeout());
}
@Override
public Message receive(TestContext context, long timeout) {
return receive(correlationManager.getCorrelationKey(
getEndpointConfiguration().getCorrelator().getCorrelationKeyName(getName()), context), context, timeout);
}
@Override
public Message receive(String selector, TestContext context, long timeout) {
Message message = correlationManager.find(selector, timeout);
String endpointUri;
if (context.getVariables().containsKey(MessageHeaders.MESSAGE_REPLY_TO + "_" + selector)) {
endpointUri = context.getVariable(MessageHeaders.MESSAGE_REPLY_TO + "_" + selector);
} else {
endpointUri = getName();
}
if (message == null) {
throw new MessageTimeoutException(timeout, endpointUri);
}
return message;
}
/**
* Creates a message producer for this endpoint for sending messages
* to this endpoint.
*/
@Override
public Producer createProducer() {
return this;
}
/**
* Creates a message consumer for this endpoint. Consumer receives
* messages on this endpoint.
*
* @return
*/
@Override
public SelectiveConsumer createConsumer() {
return this;
}
/**
* Handles error response messages constructing a proper response message
* which will be propagated to the respective endpoint consumer for
* further processing.
*/
private class InternalFaultMessageResolver implements FaultMessageResolver {
/** Request message associated with this response error handler */
private String correlationKey;
/** The endpoint that was initially invoked */
private String endpointUri;
/** Test context */
private TestContext context;
/**
* Default constructor provided with request message
* associated with this fault resolver and endpoint uri.
*/
public InternalFaultMessageResolver(String correlationKey, String endpointUri, TestContext context) {
this.correlationKey = correlationKey;
this.endpointUri = endpointUri;
this.context = context;
}
/**
* Handle fault response message according to error strategy.
*/
public void resolveFault(WebServiceMessage webServiceResponse) throws IOException {
if (getEndpointConfiguration().getErrorHandlingStrategy().equals(ErrorHandlingStrategy.PROPAGATE)) {
SoapResponseMessageCallback callback = new SoapResponseMessageCallback(getEndpointConfiguration(), context);
try {
callback.doWithMessage(webServiceResponse);
Message responseMessage = callback.getResponse();
if (webServiceResponse instanceof org.springframework.ws.soap.SoapMessage) {
TransformerFactory transformerFactory = TransformerFactory.newInstance();
Transformer transformer = transformerFactory.newTransformer();
StringResult faultPayload = new StringResult();
transformer.transform(((org.springframework.ws.soap.SoapMessage)webServiceResponse).getSoapBody().getFault().getSource(), faultPayload);
responseMessage.setPayload(faultPayload.toString());
}
logger.info("Received SOAP fault response on endpoint: '" + endpointUri + "'");
correlationManager.store(correlationKey, responseMessage);
} catch (TransformerException e) {
throw new CitrusRuntimeException("Failed to handle fault response message", e);
}
} else if (getEndpointConfiguration().getErrorHandlingStrategy().equals(ErrorHandlingStrategy.THROWS_EXCEPTION)) {
if (webServiceResponse instanceof org.springframework.ws.soap.SoapMessage) {
new SoapFaultMessageResolver().resolveFault(webServiceResponse);
} else {
new SimpleFaultMessageResolver().resolveFault(webServiceResponse);
}
} else {
throw new CitrusRuntimeException("Unsupported error strategy: " + getEndpointConfiguration().getErrorHandlingStrategy());
}
}
}
/**
* Sets the correlation manager.
* @param correlationManager
*/
public void setCorrelationManager(CorrelationManager correlationManager) {
this.correlationManager = correlationManager;
}
}
