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.
com.predic8.membrane.core.interceptor.soap.WebServiceExplorerInterceptor Maven / Gradle / Ivy
/* Copyright 2012 predic8 GmbH, www.predic8.com
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 com.predic8.membrane.core.interceptor.soap;
import groovy.xml.MarkupBuilder;
import java.io.StringWriter;
import java.io.Writer;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Pattern;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Required;
import com.googlecode.jatl.Html;
import com.predic8.membrane.annot.MCAttribute;
import com.predic8.membrane.annot.MCElement;
import com.predic8.membrane.core.Constants;
import com.predic8.membrane.core.exchange.Exchange;
import com.predic8.membrane.core.http.Request;
import com.predic8.membrane.core.http.Response;
import com.predic8.membrane.core.interceptor.Outcome;
import com.predic8.membrane.core.interceptor.administration.Mapping;
import com.predic8.membrane.core.interceptor.rest.QueryParameter;
import com.predic8.membrane.core.interceptor.rest.RESTInterceptor;
import com.predic8.membrane.core.resolver.ResolverMap;
import com.predic8.membrane.core.rules.SOAPProxy;
import com.predic8.wsdl.Binding;
import com.predic8.wsdl.Definitions;
import com.predic8.wsdl.Documentation;
import com.predic8.wsdl.Operation;
import com.predic8.wsdl.Part;
import com.predic8.wsdl.Port;
import com.predic8.wsdl.PortType;
import com.predic8.wsdl.Service;
import com.predic8.wsdl.WSDLParser;
import com.predic8.wsdl.WSDLParserContext;
import com.predic8.wstool.creator.RequestTemplateCreator;
import com.predic8.wstool.creator.SOARequestCreator;
@MCElement(name="webServiceExplorer")
public class WebServiceExplorerInterceptor extends RESTInterceptor {
private static Logger log = LoggerFactory.getLogger(WebServiceExplorerInterceptor.class.getName());
private String wsdl;
private String portName;
public WebServiceExplorerInterceptor() {
name = "Web Service Explorer";
}
@Override
public Outcome handleRequest(Exchange exc) throws Exception {
if (exc.getRequest().getMethod().equals("GET"))
if (!isWSDLRequest(exc.getRequest()))
return super.handleRequest(exc);
return Outcome.CONTINUE;
}
private static final Pattern wsdlRequest = Pattern.compile(".*\\?(wsdl|xsd=.*)", Pattern.CASE_INSENSITIVE);
private boolean isWSDLRequest(Request request) {
return wsdlRequest.matcher(request.getUri()).matches();
}
public String getWsdl() {
return wsdl;
}
@Required
@MCAttribute
public void setWsdl(String wsdl) {
this.wsdl = wsdl;
this.parsedWSDL = null;
}
public String getPortName() {
return portName;
}
@MCAttribute
public void setPortName(String portName) {
this.portName = portName;
}
private volatile Definitions parsedWSDL;
private Definitions getParsedWSDL() {
if (parsedWSDL != null)
return parsedWSDL;
WSDLParserContext ctx = new WSDLParserContext();
ctx.setInput(ResolverMap.combine(router.getBaseLocation(), wsdl));
WSDLParser wsdlParser = new WSDLParser();
wsdlParser.setResourceResolver(router.getResolverMap().toExternalResolver().toExternalResolver());
return parsedWSDL = wsdlParser.parse(ctx);
}
@Mapping("[^?]*/operation/([^/?]+)/([^/?]+)/([^/?]+)")
public Response createOperationResponse(QueryParameter params, String relativeRootPath) throws Exception {
try {
final String bindingName = params.getGroup(1);
final String portName = params.getGroup(2);
final String operationName = params.getGroup(3);
final Definitions w = getParsedWSDL();
final Service service = getService(w);
StringWriter sw = new StringWriter();
new StandardPage(sw, null) {
@Override
protected void createContent() {
h1().text("Service Proxy for " + service.getName());
h2().text("Operation: " + operationName).end();
h3().text("Sample Request").end();
pre().text(generateSampleRequest(portName, operationName, bindingName, w)).end();
}
};
return Response.ok(sw.toString()).build();
} catch (IllegalArgumentException e) {
log.error("", e);
return Response.internalServerError().build();
}
}
private Service getService(Definitions d) {
if (d.getServices().size() != 1)
throw new IllegalArgumentException("WSDL needs to have exactly one service for SOAPUIInterceptor to work.");
return d.getServices().get(0);
}
private String getClientURL(Exchange exc) {
// TODO: move this to some central location
try {
String uri = exc.getHandler().getContextPath(exc) + exc.getRequestURI();
String host = exc.getRequest().getHeader().getHost();
if (host != null) {
if (host.contains(":"))
host = host.substring(0, host.indexOf(":"));
boolean https = exc.getRule().getSslInboundContext() != null;
uri = new URL(https ? "https" : "http", host, exc.getHandler().getLocalPort(), uri).toString();
}
return uri;
} catch (MalformedURLException e) {
log.debug("Malformed URL", e);
return exc.getRequest().getUri();
}
}
@Mapping("(?!.*operation)([^?]*)")
public Response createSOAPUIResponse(QueryParameter params, final String relativeRootPath, final Exchange exc) throws Exception {
try {
final String myPath = router.getUriFactory().create(exc.getRequestURI()).getPath();
final Definitions w = getParsedWSDL();
final Service service = getService(w);
final Port port = SOAPProxy.selectPort(service.getPorts(), portName);
final List ports = getPortsByLocation(service, port);
StringWriter sw = new StringWriter();
new StandardPage(sw, service.getName()) {
@Override
protected void createContent() {
h1().text("Service Proxy: " + service.getName()).end();
p();
text("Target Namespace: " + w.getTargetNamespace());
br().end();
String wsdlLink = getClientURL(exc) + "?wsdl";
text("WSDL: ").a().href(wsdlLink).text(wsdlLink).end();
end();
for (PortType pt : w.getPortTypes()) {
h2().text("Port Type: " + pt.getName()).end();
Documentation d = pt.getDocumentation();
if (d != null) {
p().text("Documentation: " + d.toString()).end();
}
}
Binding binding = port.getBinding();
PortType portType = binding.getPortType();
List bindingOperations = getOperationsByBinding(w, binding);
if (bindingOperations.isEmpty())
p().text("There are no operations defined.").end();
else
createOperationsTable(w, bindingOperations, binding, portType);
h2().text("Virtual Endpoint").end();
p().a().href(getClientURL(exc)).text(getClientURL(exc)).end().end();
h2().text("Target Endpoints").end();
if (service.getPorts().isEmpty())
p().text("There are no endpoints defined.").end();
else
createEndpointTable(service.getPorts(), ports);
}
private void createOperationsTable(Definitions w, List bindingOperations, Binding binding, PortType portType) {
table().cellspacing("0").cellpadding("0").border(""+1);
tr();
th().text("Operation").end();
th().text("Input").end();
th().text("Output").end();
end();
for (Operation o : bindingOperations) {
tr();
td();
if ("HTTP".equals(getProtocolVersion(binding))) {
text(o.getName());
} else {
String link = myPath + "/operation/" + binding.getName() + "/" + portType.getName() + "/" + o.getName();
a().href(link).text(o.getName()).end();
}
end();
td();
for (Part p : o.getInput().getMessage().getParts())
text(p.getElement().getName());
end();
td();
for (Part p : o.getOutput().getMessage().getParts())
text(p.getElement().getName());
end();
end();
}
end();
}
private void createEndpointTable(List ports, List matchingPorts) {
table().cellspacing("0").cellpadding("0").border(""+1);
tr();
th().text("Port Name").end();
th().text("Protocol").end();
th().text("URL").end();
end();
for (Port p : ports) {
tr();
td().text(p.getName()).end();
td().text(getProtocolVersion(p.getBinding())).end();
td().text(p.getAddress().getLocation()).end();
td();
if (matchingPorts.contains(p))
text("*");
end();
end();
}
end();
p().small().text("* available through this proxy").end().end();
}
};
return Response.ok(sw.toString()).build();
} catch (IllegalArgumentException e) {
log.error("", e);
return Response.internalServerError().build();
}
}
private abstract class StandardPage extends Html {
public StandardPage(Writer writer, String title) {
super(writer);
html();
head();
title().text(Constants.PRODUCT_NAME + (title == null ? "" : ": " + title)).end();
style();
raw("");
end();
end();
body();
createContent();
p().classAttr("footer").raw(Constants.HTML_FOOTER).end();
end();
end();
}
protected abstract void createContent();
}
private List getOperationsByBinding(final Definitions w, Binding binding) {
List bindingOperations = new ArrayList();
for (Operation o : w.getOperations())
if (binding.getOperation(o.getName()) != null)
bindingOperations.add(o);
return bindingOperations;
}
private List getPortsByLocation(Service service, Port port) {
String location = port.getAddress().getLocation();
if (location == null)
throw new IllegalArgumentException("Location not set for port in WSDL.");
final List ports = new ArrayList();
for (Port p : service.getPorts())
if (location.equals(p.getAddress().getLocation()))
ports.add(p);
return ports;
}
private String getProtocolVersion(Binding binding) {
String transport = binding.getBinding().getElementName().getNamespaceURI();
if (Constants.WSDL_SOAP11_NS.equals(transport))
transport = "SOAP 1.1";
if (Constants.WSDL_SOAP12_NS.equals(transport))
transport = "SOAP 1.2";
if (Constants.WSDL_HTTP_NS.equals(transport))
transport = "HTTP";
return transport;
}
private String generateSampleRequest(final String portName, final String operationName,
final String bindingName, final Definitions w) {
StringWriter writer = new StringWriter();
SOARequestCreator creator = new SOARequestCreator(w, new RequestTemplateCreator(), new MarkupBuilder(writer));
creator.createRequest(portName, operationName, bindingName);
return writer.toString();
}
@Override
public String getShortDescription() {
return "Displays a graphical UI describing the web service when accessed using GET requests.";
}
}
