package ca.ucalgary.services;
import org.w3c.dom.*;
import ca.ucalgary.services.util.*;
import javax.servlet.http.*;
import javax.servlet.ServletException;
import javax.servlet.ServletInputStream;
import javax.xml.namespace.QName;
import javax.xml.parsers.*;
import javax.xml.transform.*;
import javax.xml.transform.stream.StreamSource;
import javax.xml.ws.*;
import java.net.URL;
import java.util.logging.*;
import java.util.*;
import java.io.*;
/**
* Provides an HTML interface for invoking SOAP-based Web Services. The appearance and functionality of the class
* can be extended using stylesheets and registering a DataRecorder (e.g. Daggoo registers PBERecorder to get
* its functionality), please see the documentation at http://biomoby.open-bio.org/CVS_CONTENT/moby-live/Java/docs/soapServlet.html
*/
public class SoapServlet extends WrappingServlet{
private static final String ARRAY_TYPE_SENTINEL = "ar_TyPe";
private static final String BASIC_TYPE_SENTINEL = "baSIc_TyPe";
private static final String BASIC_NAME_SENTINEL = "baSIc_naMe";
public static final String DOC_PARAM_SENTINEL = "_is_doc_style";
private static final String DEFERRED_NAMESPACE_URI = "http://my.deferred.sentinel.for.schema.references/";
public static final String INDENTATION_XSL_RESOURCE = "ca/ucalgary/services/resources/indent.xsl";
private static final String COMMA_OPTION = "comma (,)";
private static final String NEW_LINE_OPTION = "new line";
private static final String TAB_OPTION = "tab";
private static final String COLON_OPTION = "colon (:)";
private static final String SEMICOLON_OPTION = "semi-colon (;)";
private static final String SLASH_OPTION = "slash (/)";
private static final String WHITESPACE_OPTION = "any whitespace";
private static final String DQUOTE_OPTION = "double quotes ("...")";
private static final String SQUOTE_OPTION = "single quotes ('...')";
private static DocumentBuilder docBuilder;
private static Logger logger = Logger.getLogger(SoapServlet.class.getName());
static{
DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
dbf.setNamespaceAware(true);
try{
docBuilder = dbf.newDocumentBuilder();
} catch(Exception e){
e.printStackTrace();
}
}
public void init() throws javax.servlet.ServletException{
super.init();
TransformerFactory transformerFactory = TransformerFactory.newInstance();
try{
URL u = getClass().getClassLoader().getResource(INDENTATION_XSL_RESOURCE);
if(u != null){
// for pretty copying of SOAP response XML
setResponseTransformer(transformerFactory.newTransformer(new StreamSource(u.openStream())));
}
else{
// verbatim copy as backup plan
setResponseTransformer(transformerFactory.newTransformer());
}
} catch (Exception e){
logger.log(Level.SEVERE,
"Could not create an XSLT transformer: " + e,
e);
}
}
/**
* Post is for service submission (if the wsdl URL is provided)
*/
public void callService(HttpServletRequest request,
HttpServletResponse response,
URL url, //url of wsdl file
PrintStream out){
String serviceSpec = request.getParameter(SERVICE_SPEC_PARAM);
if(serviceSpec == null || serviceSpec.trim().length() == 0){
out.print("Error\n"+
"\n"+
"No '"+SERVICE_SPEC_PARAM+"' parameter (specifying " +
"the service/port/operation/action/use) was specified in the POST request");
return;
}
String[] serviceSpecs = serviceSpec.split(" ");
if(serviceSpecs.length != 10){
out.print("Error\n"+
"\n"+
"The '"+SERVICE_SPEC_PARAM+"' parameter (specifying " +
"the service/port/operation/action/use) did not contain 10 space-separated values as expected");
return;
}
QName serviceQName = new QName(serviceSpecs[0], serviceSpecs[1]);
Service service = null;
try{
service = Service.create(url, serviceQName);
} catch(Exception e){
out.print("Error\n"+
"\n"+
"" + e.getClass().getName() + " while using JAX-WS to create a handle for " +
"the service " + serviceQName +
", either the WSDL or the expected service name is wrong
");
e.printStackTrace(out);
out.print("
");
return;
}
QName portQName = new QName(serviceSpecs[2], serviceSpecs[3]);
Dispatch dispatch = null;
try{
dispatch = service.createDispatch(portQName,
Source.class,
Service.Mode.PAYLOAD);
} catch(Exception e){
out.print("Error\n"+
"\n"+
"" +
e.getClass().getName() + " while using JAX-WS to create a dispatch for a port on " +
"the service " + serviceQName + ", either the WSDL or the WSDLConfig's " +
"portQName parsed (" + portQName + ") is wrong:
");
e.printStackTrace(out);
out.print("
");
return;
}
String messageNSURI = serviceSpecs[4];
String messageName = serviceSpecs[5];
String soapAction = serviceSpecs[6];
String opName = serviceSpecs[7];
String style = serviceSpecs[8]; // doc or rpc
String use = serviceSpecs[9]; // literal or encoded
QName qName = "rpc".equals(style) ?
new QName(messageNSURI, opName) :
new QName(messageNSURI, messageName);
SourceMap source = new SourceMap(qName, use);
// Populate the input data
for (Enumeration e = request.getParameterNames(); e.hasMoreElements();){
String paramName = (String) e.nextElement();
if(SERVICE_SPEC_PARAM.equals(paramName) ||
SRC_PARAM.equals(paramName) ||
ID_PARAM.equals(paramName)){
continue;
}
if(paramName.startsWith(ARRAY_TYPE_SENTINEL+":")){
continue;
}
//System.err.println("Checking param "+paramName);
String value = request.getParameter(paramName);
if(paramName.endsWith(":opt")){
if(value == null || value.trim().length() == 0){
continue;
}
paramName = paramName.substring(0, paramName.length()-4);
}
if(value == null){
continue;
}
String delimiter = request.getParameter(ARRAY_TYPE_SENTINEL+":"+paramName);
if(delimiter != null && delimiter.trim().length() != 0){
String[] values = null;
if(delimiter.equals(DQUOTE_OPTION) || delimiter.equals(SQUOTE_OPTION)){
value = value.trim();
if(delimiter.equals(DQUOTE_OPTION) && !value.startsWith("\"")){
out.print("Error\n"+
"\n"+
"" +
"The delimiter for field " + paramName + " was double quotes" +
" but the value does not start with a double quote");
}
if(delimiter.equals(SQUOTE_OPTION) && !value.startsWith("'")){
out.print("Error\n"+
"\n"+
"" +
"The delimiter for field " + paramName + " was single quotes" +
" but the value does not start with a single quote");
}
if(delimiter.equals(DQUOTE_OPTION) && !value.endsWith("\"")){
out.print("Error\n"+
"\n"+
"" +
"The delimiter for field " + paramName + " was double quotes" +
" but the value does not end with a double quote");
}
if(delimiter.equals(SQUOTE_OPTION) && !value.endsWith("'")){
out.print("Error\n"+
"\n"+
"" +
"The delimiter for field " + paramName + " was single quotes" +
" but the value does not end with a single quote");
}
if(value.length() < 2){
continue; // consider it empty
}
else if(value.length() == 2){
values = new String[]{""};
}
else{
String d = delimiter.equals(DQUOTE_OPTION) ? "\"" : "'";
values = value.substring(1, value.length()-2).split(d+".*?"+d);
}
}
else{
String regex = null;
if(delimiter.equals(WHITESPACE_OPTION)){
regex = "\\s+";
}
else if(delimiter.equals(COMMA_OPTION)){
regex = ",";
}
else if(delimiter.equals(NEW_LINE_OPTION)){
regex = "\\r?\\n";
}
else if(delimiter.equals(TAB_OPTION)){
regex = "\\t";
}
else if(delimiter.equals(COLON_OPTION)){
regex = ":";
}
else if(delimiter.equals(SEMICOLON_OPTION)){
regex = ";";
}
else if(delimiter.equals(SLASH_OPTION)){
regex = "/";
}
else{
regex = delimiter; // take as-is
}
values = value.split(regex);
}
//System.err.println("encoding param "+paramName+", values ");
//for(String v: values){
// System.err.println("\""+v+"\"");
//}
source.put(paramName, values);
}
else{ // single value
//System.err.println("encoding param "+paramName+", value \""+value+"\"");
source.put(paramName, value);
}
}
if(recorder != null){ //PBE needs to know what the input looked like
recorder.setInputSource(request, source);
}
// Some servers need the soap action set to know what method to invoke
if(soapAction != null && soapAction.length() != 0){
Map context = dispatch.getRequestContext();
context.put(Dispatch.SOAPACTION_USE_PROPERTY, Boolean.TRUE);
context.put(Dispatch.SOAPACTION_URI_PROPERTY, soapAction);
}
// Call the service
Source resultSource = dispatch.invoke(source);
String answer = null;
// let the recorder do whatever is necessary for semantically wrapping the service
if(recorder != null){
try{
answer = recorder.markupResponse(resultSource, request);
} catch(Exception e){
//todo
answer = "
";
}
}
else{
// Does two duties: fixes indentation, and outputs to a Java stream we can print easily
ByteArrayOutputStream stringResult = new ByteArrayOutputStream();
try{
Transformer responseTransformer = getResponseTransformer();
synchronized(responseTransformer){
responseTransformer.transform(resultSource,
new javax.xml.transform.stream.StreamResult(stringResult));
}
} catch(Exception e){
out.print("Error\n"+
"\n"+
"" +
e.getClass().getName() + " while transforming response from " +
"the service " + serviceQName + " (probably an internal error):
");
e.printStackTrace(out);
out.print("
");
return;
}
// Now, we don't want to show the output directly, instead escape all markup
// so the end-user sees it
answer = "
"+stringResult.toString().replaceAll("<", "<")+"
";
}
out.print("Service Response\n"+
"\n" +
""+answer+"");
}
// Asks for the WSDL file
private void writeInputForm(HttpServletRequest request,
HttpServletResponse response,
PrintStream out){
out.print("Generic SOAP Client\n");
out.print("Enter the URL of the WSDL file below: ");
}
// Presents the WSDL file as a CGI form
protected void writeServiceForm(HttpServletRequest request,
HttpServletResponse response,
URL url,
PrintStream out){
// Normal web-browser form fill-in, ask for the WSDL to wrap
// Useful so this servlet can standalone and borker WSDL services.
if(url == null){
writeInputForm(request, response, out);
return;
}
try{
out.print("Input interface for WSDL Services at " + url +
"\n");
if(recorder != null){
out.print(recorder.getHead(request));
}
// allow the recorder to insert any body events required
out.print("\n\n");
if(recorder != null){
out.print(recorder.getBody(request));
}
// Use JAX-WS to get the service and port list
// Verify if the service info was actually parsed properly by trying to use it with JAX-WS
Document wsdlDoc = docBuilder.parse(url.openStream());
// Before we do anything else, let's inplace edit the DOM for any import or include statements
doImports(wsdlDoc, url);
NodeList serviceElements = wsdlDoc.getDocumentElement().getElementsByTagNameNS("http://schemas.xmlsoap.org/wsdl/",
"service");
if(serviceElements == null || serviceElements.getLength() == 0){
out.print("Could not find any service elements in the WSDL namespace (" +
"http://schemas.xmlsoap.org/wsdl/) in the given WSDL file (" +
url + ")");
return;
}
int anonCount = 0; // used to generate unique names for anonymously declared parts of the WSDL def
for(int i = 0; i < serviceElements.getLength(); i++){
Element serviceElement = (Element) serviceElements.item(i);
String serviceName = serviceElement.getAttribute("name");
if(serviceName == null || serviceName.trim().length() == 0){
out.print("A service element in the WSDL file (" +
url + ") did not have a 'name' attribute.