/*
* JBoss, Home of Professional Open Source.
* Copyright 2006, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.ws.tools.wsdl;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import javax.xml.namespace.QName;
import javax.xml.rpc.ParameterMode;
import javax.xml.ws.soap.SOAPBinding;
import org.jboss.ws.Constants;
import org.jboss.ws.core.soap.Style;
import org.jboss.ws.metadata.umdm.EndpointMetaData;
import org.jboss.ws.metadata.umdm.FaultMetaData;
import org.jboss.ws.metadata.umdm.OperationMetaData;
import org.jboss.ws.metadata.umdm.ParameterMetaData;
import org.jboss.ws.metadata.umdm.ServiceMetaData;
import org.jboss.ws.metadata.wsdl.WSDLBinding;
import org.jboss.ws.metadata.wsdl.WSDLBindingFault;
import org.jboss.ws.metadata.wsdl.WSDLBindingOperation;
import org.jboss.ws.metadata.wsdl.WSDLBindingOperationInput;
import org.jboss.ws.metadata.wsdl.WSDLBindingOperationOutput;
import org.jboss.ws.metadata.wsdl.WSDLDefinitions;
import org.jboss.ws.metadata.wsdl.WSDLDocumentation;
import org.jboss.ws.metadata.wsdl.WSDLEndpoint;
import org.jboss.ws.metadata.wsdl.WSDLExtensibilityElement;
import org.jboss.ws.metadata.wsdl.WSDLImport;
import org.jboss.ws.metadata.wsdl.WSDLInterface;
import org.jboss.ws.metadata.wsdl.WSDLInterfaceFault;
import org.jboss.ws.metadata.wsdl.WSDLInterfaceOperation;
import org.jboss.ws.metadata.wsdl.WSDLInterfaceOperationInput;
import org.jboss.ws.metadata.wsdl.WSDLInterfaceOperationOutfault;
import org.jboss.ws.metadata.wsdl.WSDLInterfaceOperationOutput;
import org.jboss.ws.metadata.wsdl.WSDLRPCPart;
import org.jboss.ws.metadata.wsdl.WSDLRPCSignatureItem;
import org.jboss.ws.metadata.wsdl.WSDLSOAPHeader;
import org.jboss.ws.metadata.wsdl.WSDLService;
import org.jboss.ws.metadata.wsdl.WSDLRPCSignatureItem.Direction;
import org.jboss.wsf.common.DOMUtils;
import org.w3c.dom.Element;
/**
* Generates a WSDL object model.
*
* @author <a href="mailto:jason.greene@jboss.com">Jason T. Greene</a>
*/
public abstract class WSDLGenerator
{
protected WSDLDefinitions wsdl;
protected abstract void processTypes();
protected Map<String,String> packageNamespaceMap = new HashMap<String,String>();
protected void processEndpoint(WSDLService service, EndpointMetaData endpoint)
{
WSDLEndpoint wsdlEndpoint = new WSDLEndpoint(service, endpoint.getPortName());
String address = endpoint.getEndpointAddress();
wsdlEndpoint.setAddress(address == null ? "REPLACE_WITH_ACTUAL_URL" : address);
service.addEndpoint(wsdlEndpoint);
QName interfaceQName = endpoint.getPortTypeName();
WSDLInterface wsdlInterface = new WSDLInterface(wsdl, interfaceQName);
wsdl.addInterface(wsdlInterface);
// Add imports
if (!interfaceQName.getNamespaceURI().equals(endpoint.getServiceMetaData().getServiceName().getNamespaceURI()))
{
WSDLImport wsdlImport = new WSDLImport(wsdl);
wsdlImport.setLocation(interfaceQName.getLocalPart() + "_PortType");
wsdlImport.setNamespace(interfaceQName.getNamespaceURI());
wsdl.addImport(wsdlImport);
wsdl.registerNamespaceURI(interfaceQName.getNamespaceURI(), null);
}
QName bindingQName = new QName(interfaceQName.getNamespaceURI(), interfaceQName.getLocalPart() + "Binding");
WSDLBinding wsdlBinding = new WSDLBinding(wsdl, bindingQName);
wsdlBinding.setInterfaceName(interfaceQName);
wsdlBinding.setType(endpoint.getBindingId());
wsdl.addBinding(wsdlBinding);
wsdlEndpoint.setBinding(bindingQName);
if (endpoint.getDocumentation() != null)
{
String prefix = wsdl.getPrefix(Constants.URI_JAXWS_WSDL_CUSTOMIZATIONS);
if (prefix == null)
{
prefix = "jaxws";
wsdl.registerNamespaceURI(Constants.URI_JAXWS_WSDL_CUSTOMIZATIONS, prefix);
}
Element javadocElement = DOMUtils.createElement(Constants.WSDL_ELEMENT_JAXWS_JAVADOC.getLocalPart(), prefix);
javadocElement.setTextContent(endpoint.getDocumentation());
Element classElement = DOMUtils.createElement(Constants.WSDL_ELEMENT_JAXWS_CLASS.getLocalPart(), prefix);
classElement.setAttribute("name", interfaceQName.getLocalPart());
classElement.appendChild(javadocElement);
Element bindingsElement = DOMUtils.createElement(Constants.WSDL_ELEMENT_JAXWS_BINDINGS.getLocalPart(), prefix);
bindingsElement.appendChild(classElement);
WSDLExtensibilityElement ext = new WSDLExtensibilityElement(Constants.URI_JAXWS_WSDL_CUSTOMIZATIONS, bindingsElement);
wsdlInterface.addExtensibilityElement(ext);
wsdlInterface.setDocumentationElement(new WSDLDocumentation(endpoint.getDocumentation()));
}
for (OperationMetaData operation : endpoint.getOperations())
{
processOperation(wsdlInterface, wsdlBinding, operation);
}
}
protected void processOperation(WSDLInterface wsdlInterface, WSDLBinding wsdlBinding, OperationMetaData operation)
{
WSDLInterfaceOperation interfaceOperation = new WSDLInterfaceOperation(wsdlInterface, operation.getQName());
WSDLBindingOperation bindingOperation = new WSDLBindingOperation(wsdlBinding);
interfaceOperation.setPattern(operation.isOneWay() ? Constants.WSDL20_PATTERN_IN_ONLY
: Constants.WSDL20_PATTERN_IN_OUT);
bindingOperation.setRef(operation.getQName());
bindingOperation.setSOAPAction(operation.getSOAPAction());
if (operation.getStyle() == Style.DOCUMENT)
processOperationDOC(interfaceOperation, bindingOperation, operation);
else
processOperationRPC(interfaceOperation, bindingOperation, operation);
for (FaultMetaData fault : operation.getFaults())
{
QName faultName = new QName(operation.getQName().getNamespaceURI(), fault.getXmlName().getLocalPart());
WSDLInterfaceFault interfaceFault = new WSDLInterfaceFault(wsdlInterface, faultName);
interfaceFault.setElement(fault.getXmlName());
wsdlInterface.addFault(interfaceFault);
WSDLInterfaceOperationOutfault outfault = new WSDLInterfaceOperationOutfault(interfaceOperation);
String ns = getNamespace(fault.getJavaType(), operation.getQName().getNamespaceURI());
QName outFaultName = new QName(ns, fault.getXmlName().getLocalPart());
outfault.setRef(outFaultName);
interfaceOperation.addOutfault(outfault);
WSDLBindingFault bindingFault = new WSDLBindingFault(wsdlBinding);
bindingFault.setRef(faultName);
wsdlBinding.addFault(bindingFault);
}
// process optional documentation
if (operation.getDocumentation() != null)
{
String prefix = wsdl.getPrefix(Constants.URI_JAXWS_WSDL_CUSTOMIZATIONS);
if (prefix == null)
{
prefix = "jaxws";
wsdl.registerNamespaceURI(Constants.URI_JAXWS_WSDL_CUSTOMIZATIONS, prefix);
}
Element javadocElement = DOMUtils.createElement(Constants.WSDL_ELEMENT_JAXWS_JAVADOC.getLocalPart(), prefix);
javadocElement.setTextContent(operation.getDocumentation());
Element methodElement = DOMUtils.createElement(Constants.WSDL_ELEMENT_JAXWS_METHOD.getLocalPart(), prefix);
methodElement.setAttribute("name", operation.getQName().getLocalPart());
methodElement.appendChild(javadocElement);
Element bindingsElement = DOMUtils.createElement(Constants.WSDL_ELEMENT_JAXWS_BINDINGS.getLocalPart(), prefix);
bindingsElement.appendChild(methodElement);
WSDLExtensibilityElement ext = new WSDLExtensibilityElement(Constants.URI_JAXWS_WSDL_CUSTOMIZATIONS, bindingsElement);
interfaceOperation.addExtensibilityElement(ext);
interfaceOperation.setDocumentationElement(new WSDLDocumentation(operation.getDocumentation()));
}
wsdlInterface.addOperation(interfaceOperation);
wsdlBinding.addOperation(bindingOperation);
}
protected void addSignatureItem(WSDLInterfaceOperation operation, ParameterMetaData param, boolean isReturn)
{
Direction direction;
if (isReturn)
{
direction = Direction.RETURN;
}
else if (param.getMode() == ParameterMode.INOUT)
{
direction = Direction.INOUT;
}
else if (param.getMode() == ParameterMode.OUT)
{
direction = Direction.OUT;
}
else
{
direction = Direction.IN;
}
operation.addRpcSignatureItem(new WSDLRPCSignatureItem(param.getPartName(), direction));
}
protected void processOperationDOC(WSDLInterfaceOperation interfaceOperation, WSDLBindingOperation bindingOperation, OperationMetaData operation)
{
interfaceOperation.setStyle(Constants.URI_STYLE_DOCUMENT);
WSDLInterfaceOperationInput input = new WSDLInterfaceOperationInput(interfaceOperation);
WSDLBindingOperationInput bindingInput = new WSDLBindingOperationInput(bindingOperation);
WSDLInterfaceOperationOutput output = null;
WSDLBindingOperationOutput bindingOutput = null;
boolean twoWay = !operation.isOneWay();
if (twoWay)
{
output = new WSDLInterfaceOperationOutput(interfaceOperation);
bindingOutput = new WSDLBindingOperationOutput(bindingOperation);
ParameterMetaData returnParameter = operation.getReturnParameter();
if (returnParameter != null)
{
QName xmlName = returnParameter.getXmlName();
String partName = returnParameter.getPartName();
if (returnParameter.isInHeader())
{
WSDLSOAPHeader header = new WSDLSOAPHeader(xmlName, partName);
header.setIncludeInSignature(true);
bindingOutput.addSoapHeader(header);
}
else
{
output.setElement(xmlName);
output.setPartName(partName);
}
addSignatureItem(interfaceOperation, returnParameter, true);
}
// If there is no return parameter, it will most likely be set later with an INOUT or OUT parameter.
// Otherwise, a null element means there is a 0 body element part, which is allowed by BP 1.0
interfaceOperation.addOutput(output);
bindingOperation.addOutput(bindingOutput);
}
for (ParameterMetaData param : operation.getParameters())
{
if (param.isInHeader())
{
WSDLSOAPHeader header = new WSDLSOAPHeader(param.getXmlName(), param.getPartName());
header.setIncludeInSignature(true);
if (param.getMode() != ParameterMode.OUT)
bindingInput.addSoapHeader(header);
if (twoWay && param.getMode() != ParameterMode.IN)
bindingOutput.addSoapHeader(header);
}
else
{
if (param.getMode() != ParameterMode.OUT)
{
input.setElement(param.getXmlName());
input.setPartName(param.getPartName());
}
if (twoWay && param.getMode() != ParameterMode.IN)
{
output.setElement(param.getXmlName());
output.setPartName(param.getPartName());
}
}
addSignatureItem(interfaceOperation, param, false);
}
interfaceOperation.addInput(input);
bindingOperation.addInput(bindingInput);
}
protected void processOperationRPC(WSDLInterfaceOperation interfaceOperation, WSDLBindingOperation bindingOperation, OperationMetaData operation)
{
interfaceOperation.setStyle(Constants.URI_STYLE_RPC);
WSDLInterfaceOperationInput input = new WSDLInterfaceOperationInput(interfaceOperation);
WSDLBindingOperationInput bindingInput = new WSDLBindingOperationInput(bindingOperation);
QName operationName = operation.getQName();
input.setElement(operationName);
WSDLInterfaceOperationOutput output = null;
WSDLBindingOperationOutput bindingOutput = null;
boolean twoWay = !operation.isOneWay();
if (twoWay)
{
output = new WSDLInterfaceOperationOutput(interfaceOperation);
bindingOutput = new WSDLBindingOperationOutput(bindingOperation);
output.setElement(new QName(operationName.getNamespaceURI(), operationName.getLocalPart() + "Response"));
ParameterMetaData returnParameter = operation.getReturnParameter();
if (returnParameter != null)
{
QName xmlName = returnParameter.getXmlName();
String partName = returnParameter.getPartName();
if (returnParameter.isInHeader())
{
WSDLSOAPHeader header = new WSDLSOAPHeader(xmlName, partName);
header.setIncludeInSignature(true);
bindingOutput.addSoapHeader(header);
}
else
{
QName xmlType = returnParameter.getXmlType();
String ns = getNamespace(returnParameter.getJavaType(), xmlType.getNamespaceURI());
QName newXmlType = new QName(ns, xmlType.getLocalPart());
WSDLRPCPart part = new WSDLRPCPart(partName, newXmlType);
output.addChildPart(part);
}
addSignatureItem(interfaceOperation, returnParameter, true);
}
interfaceOperation.addOutput(output);
bindingOperation.addOutput(bindingOutput);
}
for (ParameterMetaData param : operation.getParameters())
{
if (param.isInHeader())
{
WSDLSOAPHeader header = new WSDLSOAPHeader(param.getXmlName(), param.getPartName());
header.setIncludeInSignature(true);
if (param.getMode() != ParameterMode.OUT)
bindingInput.addSoapHeader(header);
if (twoWay && param.getMode() != ParameterMode.IN)
bindingOutput.addSoapHeader(header);
}
else
{
QName xmlType = param.getXmlType();
String ns = getNamespace(param.getJavaType(), xmlType.getNamespaceURI());
QName newXmlType = new QName(ns, xmlType.getLocalPart());
WSDLRPCPart part = new WSDLRPCPart(param.getPartName(), newXmlType);
if (param.getMode() != ParameterMode.OUT)
input.addChildPart(part);
if (twoWay && param.getMode() != ParameterMode.IN)
output.addChildPart(part);
}
addSignatureItem(interfaceOperation, param, false);
}
interfaceOperation.addInput(input);
bindingOperation.addInput(bindingInput);
}
protected void processService(ServiceMetaData service)
{
WSDLService wsdlService = new WSDLService(wsdl, service.getServiceName());
wsdl.addService(wsdlService);
EndpointMetaData endpoint = null;
for (Iterator<EndpointMetaData> iter = service.getEndpoints().iterator(); iter.hasNext();)
{
endpoint = iter.next();
processEndpoint(wsdlService, endpoint);
}
if (endpoint == null)
throw new IllegalStateException("A service must have an endpoint");
wsdlService.setInterfaceName(endpoint.getPortName());
}
/**
* Generate a WSDL object model from the passed in ServiceMetaData.
*
* @param service the service
* @return the WSDL object model
*/
public WSDLDefinitions generate(ServiceMetaData service)
{
// For now only WSDL 1.1
wsdl = new WSDLDefinitions();
wsdl.setWsdlNamespace(Constants.NS_WSDL11);
// One WSDL per service
String ns = service.getServiceName().getNamespaceURI();
wsdl.setTargetNamespace(ns);
wsdl.registerNamespaceURI(ns, "tns");
wsdl.registerNamespaceURI(Constants.NS_SCHEMA_XSD, "xsd");
// Register global namespaces
if (packageNamespaceMap != null)
{
Set<String> keys = packageNamespaceMap.keySet();
Iterator<String> iter = keys.iterator();
while (iter != null && iter.hasNext())
{
String pkg = iter.next();
wsdl.registerNamespaceURI(packageNamespaceMap.get(pkg), null);
}
}
String soapURI = null;
String soapPrefix = null;
for (EndpointMetaData ep : service.getEndpoints())
{
String bindingId = ep.getBindingId();
if (bindingId.startsWith(SOAPBinding.SOAP11HTTP_BINDING))
{
soapPrefix = "soap";
soapURI = Constants.NS_SOAP11;
}
else if (bindingId.startsWith(SOAPBinding.SOAP12HTTP_BINDING))
{
soapPrefix = "soap12";
soapURI = Constants.NS_SOAP12;
}
}
if (soapURI != null && soapPrefix != null)
wsdl.registerNamespaceURI(soapURI, soapPrefix);
processTypes();
processService(service);
return wsdl;
}
protected String getNamespace(String packageName, String defaultNS)
{
String retNS = defaultNS;
//Get it from global config if it is overriden
if (packageNamespaceMap != null)
{
String ns = packageNamespaceMap.get(packageName);
if (ns != null)
{
retNS = ns;
}
}
return retNS;
}
protected String getNamespace(String packageName)
{
return getNamespace(packageName, wsdl.getTargetNamespace());
}
protected String getNamespace(Class type, String defaultNS)
{
while (type.isArray())
{
type = type.getComponentType();
}
Package pkg = type.getPackage();
String pkgName = null;
if (pkg != null)
{
pkgName = pkg.getName();
}
return getNamespace(pkgName, defaultNS);
}
protected String getJustPackageName(String classname)
{
int index = classname.lastIndexOf(".");
if (index < 0)
index = classname.length();
return classname.substring(0,index);
}
}