/* | |
* Licensed to the Apache Software Foundation (ASF) under one | |
* or more contributor license agreements. See the NOTICE file | |
* distributed with this work for additional information | |
* regarding copyright ownership. The ASF licenses this file | |
* to you 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.apache.axis2.jaxws.provider.soapmsg; | |
import org.apache.axis2.jaxws.TestLogger; | |
import javax.xml.namespace.QName; | |
import javax.xml.soap.AttachmentPart; | |
import javax.xml.soap.Detail; | |
import javax.xml.soap.MessageFactory; | |
import javax.xml.soap.Name; | |
import javax.xml.soap.Node; | |
import javax.xml.soap.SOAPBody; | |
import javax.xml.soap.SOAPConstants; | |
import javax.xml.soap.SOAPElement; | |
import javax.xml.soap.SOAPFactory; | |
import javax.xml.soap.SOAPFault; | |
import javax.xml.soap.SOAPHeader; | |
import javax.xml.soap.SOAPHeaderElement; | |
import javax.xml.soap.SOAPMessage; | |
import javax.xml.transform.Result; | |
import javax.xml.transform.Transformer; | |
import javax.xml.transform.TransformerFactory; | |
import javax.xml.transform.stream.StreamResult; | |
import javax.xml.transform.stream.StreamSource; | |
import javax.xml.ws.BindingType; | |
import javax.xml.ws.Provider; | |
import javax.xml.ws.Service; | |
import javax.xml.ws.ServiceMode; | |
import javax.xml.ws.WebServiceException; | |
import javax.xml.ws.WebServiceProvider; | |
import javax.xml.ws.soap.SOAPBinding; | |
import javax.xml.ws.soap.SOAPFaultException; | |
import java.io.ByteArrayInputStream; | |
import java.io.ByteArrayOutputStream; | |
import java.util.Iterator; | |
@WebServiceProvider(serviceName="SoapMessageProviderService", | |
targetNamespace="http://soapmsg.provider.jaxws.axis2.apache.org", | |
wsdlLocation="META-INF/ProviderSOAPMessage.wsdl", | |
portName="SoapMessageProviderPort") | |
@BindingType(SOAPBinding.SOAP11HTTP_BINDING) | |
@ServiceMode(value=Service.Mode.MESSAGE) | |
public class SoapMessageProvider implements Provider<SOAPMessage> { | |
String responseMsgStart = "<?xml version=\"1.0\" encoding=\"UTF-8\"?><soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\"><soapenv:Header/><soapenv:Body>"; | |
String responseMsgEnd = "</soapenv:Body></soapenv:Envelope>"; | |
// Requests and Response values of invoke_str and return_str | |
// These constants are referenced by the SoapMessageProviderTest and SoapMessageProvider | |
public static String RESPONSE_NAME = "ReturnType"; | |
public static String RESPONSE_DATA_NAME = "return_str"; | |
public static String REQUEST_NAME = "invokeOp"; | |
public static String REQUEST_DATA_NAME = "invoke_str"; | |
public static String XML_REQUEST = "xml request"; | |
public static String XML_RESPONSE = "xml response"; | |
public static String XML_EMPTYBODY_REQUEST = "xml empty body request"; | |
public static String XML_CHECKHEADERS_REQUEST = "xml check headers request"; | |
public static String XML_CHECKHEADERS_RESPONSE= "xml check headers response"; | |
public static String XML_ATTACHMENT_REQUEST = "xml and attachment request"; | |
public static String XML_ATTACHMENT_RESPONSE = "xml and attachment response"; | |
public static String XML_MTOM_REQUEST = "xml and mtom request"; | |
public static String XML_MTOM_RESPONSE = "xml and mtom response"; | |
public static String XML_SWAREF_REQUEST = "xml and swaref request"; | |
public static String XML_SWAREF_RESPONSE = "xml and swaref response"; | |
public static String XML_FAULT_REQUEST = "xml fault"; | |
public static String XML_WSE_REQUEST = "xml wse fault"; | |
private String XML_RETURN = "<ns2:ReturnType xmlns:ns2=\"http://test\"><return_str>" + | |
SoapMessageProvider.XML_RESPONSE + | |
"</return_str></ns2:ReturnType>"; | |
private String ATTACHMENT_RETURN = "<ns2:ReturnType xmlns:ns2=\"http://test\"><return_str>" + | |
SoapMessageProvider.XML_ATTACHMENT_RESPONSE + | |
"</return_str></ns2:ReturnType>"; | |
private String MTOM_RETURN = "<ns2:ReturnType xmlns:ns2=\"http://test\"><return_str>" + | |
SoapMessageProvider.XML_MTOM_RESPONSE + | |
"</return_str>" + | |
SoapMessageProvider.MTOM_REF + | |
"</ns2:ReturnType>"; | |
private String SWAREF_RETURN = "<ns2:ReturnType xmlns:ns2=\"http://test\"><return_str>" + | |
SoapMessageProvider.XML_SWAREF_RESPONSE + | |
"</return_str>" + | |
SoapMessageProvider.SWAREF_REF + | |
"</ns2:ReturnType>"; | |
private String CHECKHEADERS_RETURN = "<ns2:ReturnType xmlns:ns2=\"http://test\"><return_str>" + | |
SoapMessageProvider.XML_CHECKHEADERS_RESPONSE + | |
"</return_str>" + | |
"</ns2:ReturnType>"; | |
public static String TEXT_XML_ATTACHMENT = "<myAttachment>Hello World</myAttachment>"; | |
public static String ID = "helloWorld123"; | |
public static String MTOM_REF = "<data>" + | |
"<xop:Include href='cid:" + ID + "' xmlns:xop='http://www.w3.org/2004/08/xop/include' />" + | |
"</data>"; | |
public static String SWAREF_REF = "<data>" + | |
"cid:" + ID + | |
"</data>"; | |
public static final QName FOO_HEADER_QNAME = new QName("http://sample1", "foo", "pre1"); | |
public static final QName BAR_HEADER_QNAME = new QName("http://sample2", "bar", "pre2"); | |
public static final QName BAT_HEADER_QNAME = new QName("http://sample3", "bat", "pre3"); | |
public static final String FOO_HEADER_CONTENT = "foo content"; | |
public static final String BAR_HEADER_CONTENT1 = "bar content1"; | |
public static final String BAR_HEADER_CONTENT2 = "bar content2"; | |
public static final String BAT_HEADER_CONTENT = "bat content"; | |
public SOAPMessage invoke(SOAPMessage soapMessage) throws SOAPFaultException { | |
TestLogger.logger.debug(">> SoapMessageProvider: Request received."); | |
try{ | |
// Look at the incoming request message | |
//System.out.println(">> Request on Server:"); | |
//soapMessage.writeTo(System.out); | |
//System.out.println("\n"); | |
// Get the discrimination element. This performs basic assertions on the received message | |
SOAPElement discElement = assertRequestXML(soapMessage); | |
// Use the data element text to determine the type of response to send | |
SOAPMessage response = null; | |
// TODO AXIS2 SAAJ should (but does not) support the getTextContent(); | |
// String text = dataElement.getTextContent(); | |
String text = discElement.getValue(); | |
if (XML_REQUEST.equals(text)) { | |
response = getXMLResponse(soapMessage, discElement); | |
} else if (XML_EMPTYBODY_REQUEST.equals(text)) { | |
response = getXMLEmptyBodyResponse(soapMessage, discElement); | |
} else if (XML_CHECKHEADERS_REQUEST.equals(text)) { | |
response = getXMLCheckHeadersResponse(soapMessage, discElement); | |
} else if (XML_ATTACHMENT_REQUEST.equals(text)) { | |
response = getXMLAttachmentResponse(soapMessage, discElement); | |
} else if (XML_MTOM_REQUEST.equals(text)) { | |
response = getXMLMTOMResponse(soapMessage, discElement); | |
} else if (XML_SWAREF_REQUEST.equals(text)) { | |
response = getXMLSWARefResponse(soapMessage, discElement); | |
} else if (XML_FAULT_REQUEST.equals(text)) { | |
throwSOAPFaultException(); | |
} else if (XML_WSE_REQUEST.equals(text)) { | |
throwWebServiceException(); | |
} else { | |
// We should not get here | |
TestLogger.logger.debug("Unknown Type of Message"); | |
assertTrue(false); | |
} | |
// Write out the Message | |
TestLogger.logger.debug(">> Response being sent by Server:"); | |
//response.writeTo(System.out); | |
//System.out.println("\n"); | |
return response; | |
} catch (WebServiceException wse) { | |
throw wse; | |
} catch(Exception e){ | |
TestLogger.logger | |
.debug("***ERROR: In SoapMessageProvider.invoke: Caught exception " + e); | |
e.printStackTrace(); | |
} | |
return null; | |
} | |
/** | |
* Common assertion checking of the request | |
* @param msg | |
* @return SOAPElement representing the data element | |
*/ | |
private SOAPElement assertRequestXML(SOAPMessage msg) throws Exception { | |
assertTrue(msg != null); | |
SOAPBody body = msg.getSOAPBody(); | |
assertTrue(body != null); | |
Node invokeElement = (Node) body.getFirstChild(); | |
assertTrue(invokeElement instanceof SOAPElement); | |
assertTrue(SoapMessageProvider.REQUEST_NAME.equals(invokeElement.getLocalName())); | |
Node discElement = (Node) invokeElement.getFirstChild(); | |
assertTrue(discElement instanceof SOAPElement); | |
assertTrue(SoapMessageProvider.REQUEST_DATA_NAME.equals(discElement.getLocalName())); | |
String text = discElement.getValue(); | |
assertTrue(text != null); | |
assertTrue(text.length() > 0); | |
TestLogger.logger.debug("Request Message Type is:" + text); | |
return (SOAPElement) discElement; | |
} | |
/** | |
* Get the response for an XML only request | |
* @param request | |
* @param dataElement | |
* @return SOAPMessage | |
*/ | |
private SOAPMessage getXMLResponse(SOAPMessage request, SOAPElement dataElement) throws Exception { | |
SOAPMessage response; | |
// Transport header check | |
assertTrue(request.getContentDescription() != null); | |
assertTrue(request.getContentDescription().equals(SoapMessageProvider.XML_REQUEST)); | |
// Additional assertion checks | |
assertTrue(countAttachments(request) == 0); | |
// Build the Response | |
MessageFactory factory = MessageFactory.newInstance(); | |
String responseXML = responseMsgStart + XML_RETURN + responseMsgEnd; | |
response = factory.createMessage(null, new ByteArrayInputStream(responseXML.getBytes())); | |
// Set a content description | |
response.setContentDescription(SoapMessageProvider.XML_RESPONSE); | |
return response; | |
} | |
/** | |
* Get the response for an XML only request | |
* @param request | |
* @param dataElement | |
* @return SOAPMessage | |
*/ | |
private SOAPMessage getXMLEmptyBodyResponse(SOAPMessage request, SOAPElement dataElement) throws Exception { | |
SOAPMessage response; | |
// Additional assertion checks | |
assertTrue(countAttachments(request) == 0); | |
// Build the Response | |
MessageFactory factory = MessageFactory.newInstance(); | |
response = factory.createMessage(); | |
return response; | |
} | |
/** | |
* Get the response for an XML check headers request | |
* @param request | |
* @param dataElement | |
* @return SOAPMessage | |
*/ | |
private SOAPMessage getXMLCheckHeadersResponse(SOAPMessage request, | |
SOAPElement dataElement) throws Exception { | |
SOAPMessage response; | |
// Additional assertion checks | |
assertTrue(countAttachments(request) == 0); | |
// Check for specific headers | |
SOAPHeader sh = request.getSOAPHeader(); | |
assertTrue(sh != null); | |
SOAPHeaderElement she = (SOAPHeaderElement) | |
sh.getChildElements(FOO_HEADER_QNAME).next(); | |
assertTrue(she != null); | |
assertTrue(she instanceof SOAPHeaderElement); | |
String text = she.getValue(); | |
assertTrue(FOO_HEADER_CONTENT.equals(text)); | |
Iterator it = sh.getChildElements(BAR_HEADER_QNAME); | |
she = (SOAPHeaderElement) it.next(); | |
assertTrue(she != null); | |
assertTrue(she instanceof SOAPHeaderElement); | |
text = she.getValue(); | |
assertTrue(BAR_HEADER_CONTENT1.equals(text)); | |
she = (SOAPHeaderElement) it.next(); | |
assertTrue(she != null); | |
assertTrue(she instanceof SOAPHeaderElement); | |
text = she.getValue(); | |
assertTrue(BAR_HEADER_CONTENT2.equals(text)); | |
assertTrue(!sh.getChildElements(BAT_HEADER_QNAME).hasNext()); | |
// Build the Response | |
MessageFactory factory = MessageFactory.newInstance(); | |
String responseXML = responseMsgStart + CHECKHEADERS_RETURN + responseMsgEnd; | |
response = factory.createMessage(null, new ByteArrayInputStream(responseXML.getBytes())); | |
response.getSOAPHeader().addHeaderElement(BAR_HEADER_QNAME). | |
addTextNode(BAR_HEADER_CONTENT1); | |
response.getSOAPHeader().addHeaderElement(BAR_HEADER_QNAME). | |
addTextNode(BAR_HEADER_CONTENT2); | |
response.getSOAPHeader().addHeaderElement(BAT_HEADER_QNAME). | |
addTextNode(BAT_HEADER_CONTENT); | |
return response; | |
} | |
/** | |
* Get the response for an XML and an Attachment request | |
* @param request | |
* @param dataElement | |
* @return SOAPMessage | |
*/ | |
private SOAPMessage getXMLAttachmentResponse(SOAPMessage request, SOAPElement dataElement) throws Exception { | |
SOAPMessage response; | |
// Additional assertion checks | |
assertTrue(countAttachments(request) == 1); | |
AttachmentPart requestAP = (AttachmentPart) request.getAttachments().next(); | |
StreamSource contentSS = (StreamSource) requestAP.getContent(); | |
String content = getAsString(contentSS); | |
assertTrue(content.contains(SoapMessageProvider.TEXT_XML_ATTACHMENT)); | |
// Build the Response | |
MessageFactory factory = MessageFactory.newInstance(); | |
String responseXML = responseMsgStart + ATTACHMENT_RETURN + responseMsgEnd; | |
response = factory.createMessage(null, new ByteArrayInputStream(responseXML.getBytes())); | |
// Create and attach the attachment | |
AttachmentPart ap = response.createAttachmentPart(SoapMessageProvider.TEXT_XML_ATTACHMENT, "text/xml"); | |
ap.setContentId(ID); | |
response.addAttachmentPart(ap); | |
return response; | |
} | |
/** | |
* Get the response for an XML and an MTOM Attachment request | |
* @param request | |
* @param dataElement | |
* @return SOAPMessage | |
*/ | |
private SOAPMessage getXMLMTOMResponse(SOAPMessage request, SOAPElement dataElement) throws Exception { | |
SOAPMessage response; | |
TestLogger.logger.debug("Received MTOM Message"); | |
// Additional assertion checks | |
assertTrue(countAttachments(request) == 1); | |
AttachmentPart requestAP = (AttachmentPart) request.getAttachments().next(); | |
StreamSource contentSS = (StreamSource) requestAP.getContent(); | |
String content = getAsString(contentSS); | |
assertTrue(content.contains(SoapMessageProvider.TEXT_XML_ATTACHMENT)); | |
TestLogger.logger.debug("The MTOM Request Message appears correct."); | |
// Build the Response | |
MessageFactory factory = MessageFactory.newInstance(); | |
String responseXML = responseMsgStart + MTOM_RETURN + responseMsgEnd; | |
response = factory.createMessage(null, new ByteArrayInputStream(responseXML.getBytes())); | |
// Create and attach the attachment | |
AttachmentPart ap = response.createAttachmentPart(SoapMessageProvider.TEXT_XML_ATTACHMENT, "text/xml"); | |
ap.setContentId(ID); | |
response.addAttachmentPart(ap); | |
TestLogger.logger.debug("Returning the Response Message"); | |
return response; | |
} | |
/** | |
* Get the response for an XML and an MTOM Attachment request | |
* @param request | |
* @param dataElement | |
* @return SOAPMessage | |
*/ | |
private SOAPMessage getXMLSWARefResponse(SOAPMessage request, SOAPElement dataElement) throws Exception { | |
SOAPMessage response; | |
// Additional assertion checks | |
assertTrue(countAttachments(request) == 1); | |
AttachmentPart requestAP = (AttachmentPart) request.getAttachments().next(); | |
assertTrue(requestAP.getContentId().equals(ID)); | |
StreamSource contentSS = (StreamSource) requestAP.getContent(); | |
String content = getAsString(contentSS); | |
assertTrue(content.contains(SoapMessageProvider.TEXT_XML_ATTACHMENT)); | |
// Build the Response | |
MessageFactory factory = MessageFactory.newInstance(); | |
String responseXML = responseMsgStart + SWAREF_RETURN + responseMsgEnd; | |
response = factory.createMessage(null, new ByteArrayInputStream(responseXML.getBytes())); | |
// Create and attach the attachment | |
AttachmentPart ap = response.createAttachmentPart(SoapMessageProvider.TEXT_XML_ATTACHMENT, "text/xml"); | |
ap.setContentId(ID); | |
response.addAttachmentPart(ap); | |
return response; | |
} | |
private void throwSOAPFaultException() throws SOAPFaultException { | |
try { | |
MessageFactory mf = MessageFactory.newInstance(); | |
SOAPFactory sf = SOAPFactory.newInstance(); | |
SOAPMessage m = mf.createMessage(); | |
SOAPBody body = m.getSOAPBody(); | |
SOAPFault fault = body.addFault(); | |
QName faultCode = new QName(SOAPConstants.URI_NS_SOAP_1_1_ENVELOPE, "Client"); | |
fault.setFaultCode(faultCode); | |
fault.setFaultString("sample fault"); | |
Detail detail = fault.addDetail(); | |
Name deName = sf.createName("detailEntry"); | |
SOAPElement detailEntry = detail.addDetailEntry(deName); | |
detailEntry.addTextNode("sample detail"); | |
fault.setFaultActor("sample actor"); | |
SOAPFaultException sfe = new SOAPFaultException(fault); | |
throw sfe; | |
} catch (SOAPFaultException e) { | |
throw e; | |
} catch (Exception e) { | |
throw new RuntimeException(e); | |
} | |
} | |
private void throwWebServiceException() throws WebServiceException { | |
throw new WebServiceException("A WSE was thrown"); | |
} | |
/** | |
* Count Attachments | |
* @param msg | |
* @return | |
*/ | |
private int countAttachments(SOAPMessage msg) { | |
Iterator it = msg.getAttachments(); | |
int count = 0; | |
assertTrue(it != null); | |
while (it.hasNext()) { | |
it.next(); | |
count++; | |
} | |
return count; | |
} | |
public static String getAsString(StreamSource ss) throws Exception { | |
ByteArrayOutputStream out = new ByteArrayOutputStream(); | |
Result result = new StreamResult(out); | |
Transformer transformer = TransformerFactory.newInstance().newTransformer(); | |
transformer.transform(ss, result); | |
String text = new String(out.toByteArray()); | |
return text; | |
} | |
private void assertTrue(boolean testAssertion) { | |
if (!testAssertion) { | |
throw new RuntimeException("Assertion false"); | |
} | |
} | |
} |