| /* |
| * Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code 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 General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package com.sun.tools.internal.ws.processor.generator; |
| |
| import com.sun.codemodel.internal.*; |
| import com.sun.tools.internal.ws.api.TJavaGeneratorExtension; |
| import com.sun.tools.internal.ws.processor.model.*; |
| import com.sun.tools.internal.ws.processor.model.java.JavaInterface; |
| import com.sun.tools.internal.ws.processor.model.java.JavaMethod; |
| import com.sun.tools.internal.ws.processor.model.java.JavaParameter; |
| import com.sun.tools.internal.ws.processor.model.jaxb.JAXBType; |
| import com.sun.tools.internal.ws.processor.model.jaxb.JAXBTypeAndAnnotation; |
| import com.sun.tools.internal.ws.wscompile.ErrorReceiver; |
| import com.sun.tools.internal.ws.wscompile.Options; |
| import com.sun.tools.internal.ws.wscompile.WsimportOptions; |
| import com.sun.tools.internal.ws.wsdl.document.soap.SOAPStyle; |
| import com.sun.tools.internal.ws.wsdl.document.PortType; |
| import com.sun.tools.internal.ws.resources.GeneratorMessages; |
| |
| import javax.jws.WebMethod; |
| import javax.jws.WebParam; |
| import javax.jws.WebService; |
| import javax.jws.soap.SOAPBinding; |
| import javax.xml.bind.annotation.XmlSeeAlso; |
| import javax.xml.namespace.QName; |
| import javax.xml.ws.Holder; |
| import java.util.ArrayList; |
| import java.util.List; |
| |
| import org.xml.sax.Locator; |
| |
| public class SeiGenerator extends GeneratorBase { |
| private TJavaGeneratorExtension extension; |
| private List<TJavaGeneratorExtension> extensionHandlers; |
| |
| public static void generate(Model model, WsimportOptions options, ErrorReceiver receiver, TJavaGeneratorExtension... extensions){ |
| SeiGenerator seiGenerator = new SeiGenerator(); |
| seiGenerator.init(model, options, receiver, extensions); |
| seiGenerator.doGeneration(); |
| } |
| |
| public void init(Model model, WsimportOptions options, ErrorReceiver receiver, TJavaGeneratorExtension... extensions) { |
| init(model, options, receiver); |
| extensionHandlers = new ArrayList<TJavaGeneratorExtension>(); |
| |
| // register handlers for default extensions |
| |
| // 2.2 Spec requires generation of @Action when wsam:Action is explicitly stated in wsdl |
| if (options.target.isLaterThan(Options.Target.V2_2)) { |
| register(new W3CAddressingJavaGeneratorExtension()); |
| } |
| |
| for (TJavaGeneratorExtension j : extensions) { |
| register(j); |
| } |
| |
| this.extension = new JavaGeneratorExtensionFacade(extensionHandlers.toArray(new TJavaGeneratorExtension[extensionHandlers.size()])); |
| } |
| |
| private void write(Port port) { |
| JavaInterface intf = port.getJavaInterface(); |
| String className = Names.customJavaTypeClassName(intf); |
| |
| if (donotOverride && GeneratorUtil.classExists(options, className)) { |
| log("Class " + className + " exists. Not overriding."); |
| return; |
| } |
| |
| |
| JDefinedClass cls; |
| try { |
| cls = getClass(className, ClassType.INTERFACE); |
| } catch (JClassAlreadyExistsException e) { |
| QName portTypeName = |
| (QName) port.getProperty( |
| ModelProperties.PROPERTY_WSDL_PORT_TYPE_NAME); |
| Locator loc = null; |
| if(portTypeName != null){ |
| PortType pt = port.portTypes.get(portTypeName); |
| if (pt!=null) { |
| loc = pt.getLocator(); |
| } |
| } |
| receiver.error(loc, GeneratorMessages.GENERATOR_SEI_CLASS_ALREADY_EXIST(intf.getName(), portTypeName)); |
| return; |
| } |
| // If the class has methods it has already been defined |
| // so skip it. |
| if (!cls.methods().isEmpty()) { |
| return; |
| } |
| |
| //write class comment - JAXWS warning |
| JDocComment comment = cls.javadoc(); |
| |
| String ptDoc = intf.getJavaDoc(); |
| if(ptDoc != null){ |
| comment.add(ptDoc); |
| comment.add("\n\n"); |
| } |
| |
| for(String doc:getJAXWSClassComment()){ |
| comment.add(doc); |
| } |
| |
| |
| //@WebService |
| JAnnotationUse webServiceAnn = cls.annotate(cm.ref(WebService.class)); |
| writeWebServiceAnnotation(port, webServiceAnn); |
| |
| //@HandlerChain |
| writeHandlerConfig(Names.customJavaTypeClassName(port.getJavaInterface()), cls, options); |
| |
| //@SOAPBinding |
| writeSOAPBinding(port, cls); |
| |
| //@XmlSeeAlso |
| if (options.target.isLaterThan(Options.Target.V2_1)) { |
| writeXmlSeeAlso(cls); |
| } |
| |
| for (Operation operation: port.getOperations()) { |
| JavaMethod method = operation.getJavaMethod(); |
| |
| //@WebMethod |
| JMethod m; |
| JDocComment methodDoc; |
| String methodJavaDoc = operation.getJavaDoc(); |
| if(method.getReturnType().getName().equals("void")){ |
| m = cls.method(JMod.PUBLIC, void.class, method.getName()); |
| methodDoc = m.javadoc(); |
| }else { |
| JAXBTypeAndAnnotation retType = method.getReturnType().getType(); |
| m = cls.method(JMod.PUBLIC, retType.getType(), method.getName()); |
| retType.annotate(m); |
| methodDoc = m.javadoc(); |
| JCommentPart ret = methodDoc.addReturn(); |
| ret.add("returns "+retType.getName()); |
| } |
| if (methodJavaDoc != null) { |
| methodDoc.add(methodJavaDoc); |
| } |
| |
| writeWebMethod(operation, m); |
| JClass holder = cm.ref(Holder.class); |
| for (JavaParameter parameter: method.getParametersList()) { |
| JVar var; |
| JAXBTypeAndAnnotation paramType = parameter.getType().getType(); |
| if (parameter.isHolder()) { |
| var = m.param(holder.narrow(paramType.getType().boxify()), parameter.getName()); |
| }else{ |
| var = m.param(paramType.getType(), parameter.getName()); |
| } |
| |
| //annotate parameter with JAXB annotations |
| paramType.annotate(var); |
| methodDoc.addParam(var); |
| JAnnotationUse paramAnn = var.annotate(cm.ref(WebParam.class)); |
| writeWebParam(operation, parameter, paramAnn); |
| } |
| com.sun.tools.internal.ws.wsdl.document.Operation wsdlOp = operation.getWSDLPortTypeOperation(); |
| for(Fault fault:operation.getFaultsSet()){ |
| m._throws(fault.getExceptionClass()); |
| methodDoc.addThrows(fault.getExceptionClass()); |
| wsdlOp.putFault(fault.getWsdlFaultName(), fault.getExceptionClass()); |
| } |
| |
| //It should be the last thing to invoke after JMethod is built completely |
| extension.writeMethodAnnotations(wsdlOp, m); |
| } |
| } |
| |
| private void writeXmlSeeAlso(JDefinedClass cls) { |
| if (model.getJAXBModel().getS2JJAXBModel() != null) { |
| List<JClass> objectFactories = model.getJAXBModel().getS2JJAXBModel().getAllObjectFactories(); |
| |
| //if there are no object facotires, dont generate @XmlSeeAlso |
| if (objectFactories.isEmpty()) { |
| return; |
| } |
| |
| JAnnotationUse xmlSeeAlso = cls.annotate(cm.ref(XmlSeeAlso.class)); |
| JAnnotationArrayMember paramArray = xmlSeeAlso.paramArray("value"); |
| for (JClass of : objectFactories) { |
| paramArray = paramArray.param(of); |
| } |
| } |
| |
| } |
| |
| private void writeWebMethod(Operation operation, JMethod m) { |
| Response response = operation.getResponse(); |
| JAnnotationUse webMethodAnn = m.annotate(cm.ref(WebMethod.class)); |
| String operationName = (operation instanceof AsyncOperation)? |
| ((AsyncOperation)operation).getNormalOperation().getName().getLocalPart(): |
| operation.getName().getLocalPart(); |
| |
| if(!m.name().equals(operationName)){ |
| webMethodAnn.param("operationName", operationName); |
| } |
| |
| if (operation.getSOAPAction() != null && operation.getSOAPAction().length() > 0){ |
| webMethodAnn.param("action", operation.getSOAPAction()); |
| } |
| |
| if (operation.getResponse() == null){ |
| m.annotate(javax.jws.Oneway.class); |
| }else if (!operation.getJavaMethod().getReturnType().getName().equals("void") && |
| operation.getResponse().getParametersList().size() > 0){ |
| Block block; |
| String resultName = null; |
| String nsURI = null; |
| if (operation.getResponse().getBodyBlocks().hasNext()) { |
| block = operation.getResponse().getBodyBlocks().next(); |
| resultName = block.getName().getLocalPart(); |
| if(isDocStyle || block.getLocation() == Block.HEADER){ |
| nsURI = block.getName().getNamespaceURI(); |
| } |
| } |
| |
| for (Parameter parameter : operation.getResponse().getParametersList()) { |
| if (parameter.getParameterIndex() == -1) { |
| if(operation.isWrapped()||!isDocStyle){ |
| if(parameter.getBlock().getLocation() == Block.HEADER){ |
| resultName = parameter.getBlock().getName().getLocalPart(); |
| }else{ |
| resultName = parameter.getName(); |
| } |
| if (isDocStyle || (parameter.getBlock().getLocation() == Block.HEADER)) { |
| nsURI = parameter.getType().getName().getNamespaceURI(); |
| } |
| }else if(isDocStyle){ |
| JAXBType t = (JAXBType)parameter.getType(); |
| resultName = t.getName().getLocalPart(); |
| nsURI = t.getName().getNamespaceURI(); |
| } |
| if(!(operation instanceof AsyncOperation)){ |
| JAnnotationUse wr = null; |
| |
| if(!resultName.equals("return")){ |
| wr = m.annotate(javax.jws.WebResult.class); |
| wr.param("name", resultName); |
| } |
| if (nsURI != null || (isDocStyle && operation.isWrapped())) { |
| if(wr == null) { |
| wr = m.annotate(javax.jws.WebResult.class); |
| } |
| wr.param("targetNamespace", nsURI); |
| } |
| //doclit wrapped could have additional headers |
| if(!(isDocStyle && operation.isWrapped()) || |
| (parameter.getBlock().getLocation() == Block.HEADER)){ |
| if (wr == null) { |
| wr = m.annotate(javax.jws.WebResult.class); |
| } |
| wr.param("partName", parameter.getName()); |
| } |
| if(parameter.getBlock().getLocation() == Block.HEADER){ |
| if (wr == null) { |
| wr = m.annotate(javax.jws.WebResult.class); |
| } |
| wr.param("header",true); |
| } |
| } |
| } |
| |
| } |
| } |
| |
| //DOC/BARE |
| if (!sameParamStyle) { |
| if(!operation.isWrapped()) { |
| JAnnotationUse sb = m.annotate(SOAPBinding.class); |
| sb.param("parameterStyle", SOAPBinding.ParameterStyle.BARE); |
| } |
| } |
| |
| if (operation.isWrapped() && operation.getStyle().equals(SOAPStyle.DOCUMENT)) { |
| Block reqBlock = operation.getRequest().getBodyBlocks().next(); |
| JAnnotationUse reqW = m.annotate(javax.xml.ws.RequestWrapper.class); |
| reqW.param("localName", reqBlock.getName().getLocalPart()); |
| reqW.param("targetNamespace", reqBlock.getName().getNamespaceURI()); |
| reqW.param("className", reqBlock.getType().getJavaType().getName()); |
| |
| if (response != null) { |
| JAnnotationUse resW = m.annotate(javax.xml.ws.ResponseWrapper.class); |
| Block resBlock = response.getBodyBlocks().next(); |
| resW.param("localName", resBlock.getName().getLocalPart()); |
| resW.param("targetNamespace", resBlock.getName().getNamespaceURI()); |
| resW.param("className", resBlock.getType().getJavaType().getName()); |
| } |
| } |
| } |
| |
| private boolean isMessageParam(Parameter param, Message message) { |
| Block block = param.getBlock(); |
| |
| return (message.getBodyBlockCount() > 0 && block.equals(message.getBodyBlocks().next())) || |
| (message.getHeaderBlockCount() > 0 && |
| block.equals(message.getHeaderBlocks().next())); |
| } |
| |
| private boolean isHeaderParam(Parameter param, Message message) { |
| if (message.getHeaderBlockCount() == 0) { |
| return false; |
| } |
| |
| for (Block headerBlock : message.getHeaderBlocksMap().values()) { |
| if (param.getBlock().equals(headerBlock)) { |
| return true; |
| } |
| } |
| |
| return false; |
| } |
| |
| private boolean isAttachmentParam(Parameter param, Message message){ |
| if (message.getAttachmentBlockCount() == 0) { |
| return false; |
| } |
| |
| for (Block attBlock : message.getAttachmentBlocksMap().values()) { |
| if (param.getBlock().equals(attBlock)) { |
| return true; |
| } |
| } |
| |
| return false; |
| } |
| |
| private boolean isUnboundParam(Parameter param, Message message){ |
| if (message.getUnboundBlocksCount() == 0) { |
| return false; |
| } |
| |
| for (Block unboundBlock : message.getUnboundBlocksMap().values()) { |
| if (param.getBlock().equals(unboundBlock)) { |
| return true; |
| } |
| } |
| |
| return false; |
| } |
| |
| private void writeWebParam(Operation operation, JavaParameter javaParameter, JAnnotationUse paramAnno) { |
| Parameter param = javaParameter.getParameter(); |
| Request req = operation.getRequest(); |
| Response res = operation.getResponse(); |
| |
| boolean header = isHeaderParam(param, req) || |
| (res != null && isHeaderParam(param, res)); |
| |
| String name; |
| boolean isWrapped = operation.isWrapped(); |
| |
| if ((param.getBlock().getLocation() == Block.HEADER) || (isDocStyle && !isWrapped)) { |
| name = param.getBlock().getName().getLocalPart(); |
| } else { |
| name = param.getName(); |
| } |
| |
| paramAnno.param("name", name); |
| |
| String ns= null; |
| |
| if (isDocStyle) { |
| ns = param.getBlock().getName().getNamespaceURI(); // its bare nsuri |
| if(isWrapped){ |
| ns = param.getType().getName().getNamespaceURI(); |
| } |
| }else if(header){ |
| ns = param.getBlock().getName().getNamespaceURI(); |
| } |
| |
| if (ns != null || (isDocStyle && isWrapped)) { |
| paramAnno.param("targetNamespace", ns); |
| } |
| |
| if (header) { |
| paramAnno.param("header", true); |
| } |
| |
| if (param.isINOUT()){ |
| paramAnno.param("mode", javax.jws.WebParam.Mode.INOUT); |
| }else if ((res != null) && (isMessageParam(param, res) || isHeaderParam(param, res) || isAttachmentParam(param, res) || |
| isUnboundParam(param,res) || param.isOUT())){ |
| paramAnno.param("mode", javax.jws.WebParam.Mode.OUT); |
| } |
| |
| //doclit wrapped could have additional headers |
| if (!(isDocStyle && isWrapped) || header) { |
| paramAnno.param("partName", javaParameter.getParameter().getName()); |
| } |
| } |
| |
| private boolean isDocStyle = true; |
| private boolean sameParamStyle = true; |
| private void writeSOAPBinding(Port port, JDefinedClass cls) { |
| JAnnotationUse soapBindingAnn = null; |
| isDocStyle = port.getStyle() == null || port.getStyle().equals(SOAPStyle.DOCUMENT); |
| if(!isDocStyle){ |
| soapBindingAnn = cls.annotate(SOAPBinding.class); |
| soapBindingAnn.param("style", SOAPBinding.Style.RPC); |
| port.setWrapped(true); |
| } |
| if(isDocStyle){ |
| boolean first = true; |
| boolean isWrapper = true; |
| for(Operation operation:port.getOperations()){ |
| if(first){ |
| isWrapper = operation.isWrapped(); |
| first = false; |
| continue; |
| } |
| sameParamStyle = (isWrapper == operation.isWrapped()); |
| if (!sameParamStyle) { |
| break; |
| } |
| } |
| if (sameParamStyle) { |
| port.setWrapped(isWrapper); |
| } |
| } |
| if(sameParamStyle && !port.isWrapped()){ |
| if (soapBindingAnn == null) { |
| soapBindingAnn = cls.annotate(SOAPBinding.class); |
| } |
| soapBindingAnn.param("parameterStyle", SOAPBinding.ParameterStyle.BARE); |
| } |
| } |
| |
| private void writeWebServiceAnnotation(Port port, JAnnotationUse wsa) { |
| QName name = (QName) port.getProperty(ModelProperties.PROPERTY_WSDL_PORT_TYPE_NAME); |
| wsa.param("name", name.getLocalPart()); |
| wsa.param("targetNamespace", name.getNamespaceURI()); |
| } |
| |
| @Override |
| public void visit(Model model) throws Exception { |
| for(Service s:model.getServices()){ |
| s.accept(this); |
| } |
| } |
| |
| @Override |
| public void visit(Service service) throws Exception { |
| String jd = model.getJavaDoc(); |
| if(jd != null){ |
| JPackage pkg = cm._package(options.defaultPackage); |
| pkg.javadoc().add(jd); |
| } |
| |
| for(Port p:service.getPorts()){ |
| visitPort(service, p); |
| } |
| } |
| |
| private void visitPort(Service service, Port port) { |
| if (port.isProvider()) { |
| return; // Not generating for Provider based endpoint |
| } |
| write(port); |
| } |
| |
| private void register(TJavaGeneratorExtension h) { |
| extensionHandlers.add(h); |
| } |
| } |
