/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.tools.ws.processor.modeler.annotation;
import com.sun.mirror.declaration.*;
import com.sun.mirror.type.*;
import com.sun.mirror.util.SimpleDeclarationVisitor;
import com.sun.mirror.util.SourcePosition;
import com.sun.tools.ws.processor.model.Port;
import com.sun.tools.ws.processor.modeler.JavaSimpleTypeCreator;
import com.sun.tools.ws.processor.modeler.annotation.AnnotationProcessorContext.SEIContext;
import com.sun.tools.ws.resources.WebserviceapMessages;
import com.sun.tools.ws.util.ClassNameInfo;
import com.sun.tools.ws.wsdl.document.soap.SOAPStyle;
import com.sun.tools.ws.wsdl.document.soap.SOAPUse;
import com.sun.xml.ws.developer.Stateful;
import com.sun.xml.ws.model.RuntimeModeler;
import com.sun.xml.ws.util.localization.Localizable;
import javax.jws.*;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.ParameterStyle;
import java.util.Collection;
import java.util.HashSet;
import java.util.Set;
import java.util.Stack;
/**
*
* @author WS Development Team
*/
public abstract class WebServiceVisitor extends SimpleDeclarationVisitor implements WebServiceConstants {
protected ModelBuilder builder;
protected String wsdlNamespace;
protected String typeNamespace;
protected Stack<SOAPBinding> soapBindingStack;
protected SOAPBinding typeDeclSOAPBinding;
protected SOAPUse soapUse = SOAPUse.LITERAL;
protected SOAPStyle soapStyle = SOAPStyle.DOCUMENT;
protected boolean wrapped = true;
protected HandlerChain hChain;
protected Port port;
protected String serviceImplName;
protected String endpointInterfaceName;
protected AnnotationProcessorContext context;
protected SEIContext seiContext;
protected boolean processingSEI = false;
protected String serviceName;
protected String packageName;
protected String portName;
protected boolean endpointReferencesInterface = false;
protected boolean hasWebMethods = false;
protected JavaSimpleTypeCreator simpleTypeCreator;
protected TypeDeclaration typeDecl;
protected Set<String> processedMethods;
protected boolean pushedSOAPBinding = false;
protected static final String ANNOTATION_ELEMENT_ERROR = "webserviceap.endpointinteface.plus.element";
public WebServiceVisitor(ModelBuilder builder, AnnotationProcessorContext context) {
this.builder = builder;
this.context = context;
this.simpleTypeCreator = new JavaSimpleTypeCreator();
soapBindingStack = new Stack<SOAPBinding>();
processedMethods = new HashSet<String>();
}
public void visitInterfaceDeclaration(InterfaceDeclaration d) {
WebService webService = d.getAnnotation(WebService.class);
if (!shouldProcessWebService(webService, d))
return;
if (builder.checkAndSetProcessed(d))
return;
typeDecl = d;
if (endpointInterfaceName != null && !endpointInterfaceName.equals(d.getQualifiedName())) {
builder.onError(d.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_ENDPOINTINTERFACES_DO_NOT_MATCH(endpointInterfaceName, d.getQualifiedName()));
}
verifySEIAnnotations(webService, d);
endpointInterfaceName = d.getQualifiedName();
processingSEI = true;
preProcessWebService(webService, d);
processWebService(webService, d);
postProcessWebService(webService, d);
}
public void visitClassDeclaration(ClassDeclaration d) {
WebService webService = d.getAnnotation(WebService.class);
if (!shouldProcessWebService(webService, d))
return;
if (builder.checkAndSetProcessed(d))
return;
typeDeclSOAPBinding = d.getAnnotation(SOAPBinding.class);
typeDecl = d;
if (serviceImplName == null)
serviceImplName = d.getQualifiedName();
String endpointInterfaceName = webService != null ? webService.endpointInterface() : null;
if (endpointInterfaceName != null && endpointInterfaceName.length() > 0) {
SourcePosition pos = pos = d.getPosition();
checkForInvalidImplAnnotation(d, SOAPBinding.class);
if (webService.name().length() > 0)
annotationError(pos, WebserviceapMessages.localizableWEBSERVICEAP_ENDPOINTINTEFACE_PLUS_ELEMENT("name"));
endpointReferencesInterface = true;
verifyImplAnnotations(d);
inspectEndpointInterface(endpointInterfaceName, d);
serviceImplName = null;
return;
}
processingSEI = false;
preProcessWebService(webService, d);
processWebService(webService, d);
serviceImplName = null;
postProcessWebService(webService, d);
serviceImplName = null;
}
protected void verifySEIAnnotations(WebService webService, InterfaceDeclaration d) {
if (webService.endpointInterface().length() > 0) {
builder.onError(d.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_ENDPOINTINTERFACE_ON_INTERFACE(d.getQualifiedName(), webService.endpointInterface()));
}
if (webService.serviceName().length() > 0) {
builder.onError(d.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_INVALID_SEI_ANNOTATION_ELEMENT("serviceName", d.getQualifiedName()));
}
if (webService.portName().length() > 0) {
builder.onError(d.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_INVALID_SEI_ANNOTATION_ELEMENT("portName", d.getQualifiedName()));
}
}
protected void verifyImplAnnotations(ClassDeclaration d) {
for (MethodDeclaration method : d.getMethods()) {
checkForInvalidImplAnnotation(method, WebMethod.class);
checkForInvalidImplAnnotation(method, Oneway.class);
checkForInvalidImplAnnotation(method, WebResult.class);
for (ParameterDeclaration param : method.getParameters()) {
checkForInvalidImplAnnotation(param, WebParam.class);
}
}
}
protected void checkForInvalidSEIAnnotation(InterfaceDeclaration d, Class annotationClass) {
Object annotation = d.getAnnotation(annotationClass);
if (annotation != null) {
SourcePosition pos = d.getPosition();
annotationError(pos, WebserviceapMessages.localizableWEBSERVICEAP_INVALID_SEI_ANNOTATION(annotationClass.getName(), d.getQualifiedName()));
}
}
protected void checkForInvalidImplAnnotation(Declaration d, Class annotationClass) {
Object annotation = d.getAnnotation(annotationClass);
if (annotation != null) {
SourcePosition pos = d.getPosition();
annotationError(pos, WebserviceapMessages.localizableWEBSERVICEAP_ENDPOINTINTEFACE_PLUS_ANNOTATION(annotationClass.getName()));
}
}
protected void annotationError(SourcePosition pos, Localizable message) {
builder.onError(pos, message);
}
protected void preProcessWebService(WebService webService, TypeDeclaration d) {
processedMethods = new HashSet<String>();
seiContext = context.getSEIContext(d);
String targetNamespace = null;
if (webService != null)
targetNamespace = webService.targetNamespace();
if (targetNamespace == null || targetNamespace.length() == 0) {
String packageName = d.getPackage().getQualifiedName();
if (packageName == null || packageName.length() == 0) {
builder.onError(d.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_NO_PACKAGE_CLASS_MUST_HAVE_TARGETNAMESPACE(d.getQualifiedName()));
}
targetNamespace = getNamespace(d.getPackage());
}
seiContext.setNamespaceURI(targetNamespace);
if (serviceImplName == null)
serviceImplName = seiContext.getSEIImplName();
if (serviceImplName != null) {
seiContext.setSEIImplName(serviceImplName);
context.addSEIContext(serviceImplName, seiContext);
}
portName = ClassNameInfo.getName(
d.getSimpleName().replace(
SIGC_INNERCLASS,
SIGC_UNDERSCORE));;
packageName = d.getPackage().getQualifiedName();
portName = webService != null && webService.name() != null && webService.name().length() >0 ?
webService.name() : portName;
serviceName = ClassNameInfo.getName(d.getQualifiedName())+SERVICE;
serviceName = webService != null && webService.serviceName() != null &&
webService.serviceName().length() > 0 ?
webService.serviceName() : serviceName;
wsdlNamespace = seiContext.getNamespaceURI();
typeNamespace = wsdlNamespace;
SOAPBinding soapBinding = d.getAnnotation(SOAPBinding.class);
if (soapBinding != null) {
pushedSOAPBinding = pushSOAPBinding(soapBinding, d, d);
} else if (d.equals(typeDecl)) {
pushedSOAPBinding = pushSOAPBinding(new MySOAPBinding(), d, d);
}
}
public static boolean sameStyle(SOAPBinding.Style style, SOAPStyle soapStyle) {
if (style.equals(SOAPBinding.Style.DOCUMENT) &&
soapStyle.equals(SOAPStyle.DOCUMENT))
return true;
if (style.equals(SOAPBinding.Style.RPC) &&
soapStyle.equals(SOAPStyle.RPC))
return true;
return false;
}
protected boolean pushSOAPBinding(SOAPBinding soapBinding, Declaration bindingDecl,
TypeDeclaration classDecl) {
boolean changed = false;
if (!sameStyle(soapBinding.style(), soapStyle)) {
changed = true;
if (pushedSOAPBinding)
builder.onError(bindingDecl.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_MIXED_BINDING_STYLE(classDecl.getQualifiedName()));
}
if (soapBinding.style().equals(SOAPBinding.Style.RPC)) {
soapStyle = SOAPStyle.RPC;
wrapped = true;
if (soapBinding.parameterStyle().equals(ParameterStyle.BARE)) {
builder.onError(bindingDecl.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_RPC_LITERAL_MUST_NOT_BE_BARE(classDecl.getQualifiedName()));
}
} else {
soapStyle = SOAPStyle.DOCUMENT;
if (wrapped != soapBinding.parameterStyle().equals(ParameterStyle.WRAPPED)) {
wrapped = soapBinding.parameterStyle().equals(ParameterStyle.WRAPPED);
changed = true;
}
}
if (soapBinding.use().equals(SOAPBinding.Use.ENCODED)) {
String style = "rpc";
if(soapBinding.style().equals(SOAPBinding.Style.DOCUMENT))
style = "document";
builder.onError(bindingDecl.getPosition(), WebserviceapMessages.localizableWEBSERVICE_ENCODED_NOT_SUPPORTED(classDecl.getQualifiedName(), style));
}
if (changed || soapBindingStack.empty()) {
soapBindingStack.push(soapBinding);
pushedSOAPBinding = true;
}
return changed;
}
protected SOAPBinding popSOAPBinding() {
if (pushedSOAPBinding)
soapBindingStack.pop();
SOAPBinding soapBinding = null;
if (!soapBindingStack.empty()) {
soapBinding = soapBindingStack.peek();
if (soapBinding.style().equals(SOAPBinding.Style.RPC)) {
soapStyle = SOAPStyle.RPC;
wrapped = true;
} else {
soapStyle = SOAPStyle.DOCUMENT;
wrapped = soapBinding.parameterStyle().equals(ParameterStyle.WRAPPED);
}
}
return soapBinding;
}
protected String getNamespace(PackageDeclaration packageDecl) {
return RuntimeModeler.getNamespace(packageDecl.getQualifiedName());
}
// abstract protected boolean shouldProcessWebService(WebService webService, InterfaceDeclaration intf);
// abstract protected boolean shouldProcessWebService(WebService webService, ClassDeclaration decl);
protected boolean shouldProcessWebService(WebService webService, InterfaceDeclaration intf) {
hasWebMethods = false;
if (webService == null)
builder.onError(intf.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_ENDPOINTINTERFACE_HAS_NO_WEBSERVICE_ANNOTATION(intf.getQualifiedName()));
if (isLegalSEI(intf))
return true;
return false;
}
protected boolean shouldProcessWebService(WebService webService, ClassDeclaration classDecl) {
if (webService == null)
return false;
hasWebMethods = hasWebMethods(classDecl);
return isLegalImplementation(webService, classDecl);
}
abstract protected void processWebService(WebService webService, TypeDeclaration d);
protected void postProcessWebService(WebService webService, InterfaceDeclaration d) {
processMethods(d);
popSOAPBinding();
}
protected void postProcessWebService(WebService webService, ClassDeclaration d) {
processMethods(d);
popSOAPBinding();
}
protected boolean hasWebMethods(ClassDeclaration d) {
if (d.getQualifiedName().equals(JAVA_LANG_OBJECT))
return false;
WebMethod webMethod;
for (MethodDeclaration method : d.getMethods()) {
webMethod = method.getAnnotation(WebMethod.class);
if (webMethod != null) {
if (webMethod.exclude()) {
if (webMethod.operationName().length() > 0)
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_INVALID_WEBMETHOD_ELEMENT_WITH_EXCLUDE("operationName", d.getQualifiedName(), method.toString()));
if (webMethod.action().length() > 0)
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_INVALID_WEBMETHOD_ELEMENT_WITH_EXCLUDE("action", d.getQualifiedName(), method.toString()));
} else {
return true;
}
}
}
return false;//hasWebMethods(d.getSuperclass().getDeclaration());
}
protected void processMethods(InterfaceDeclaration d) {
builder.log("ProcessedMethods Interface: "+d);
hasWebMethods = false;
for (MethodDeclaration methodDecl : d.getMethods()) {
methodDecl.accept(this);
}
for (InterfaceType superType : d.getSuperinterfaces())
processMethods(superType.getDeclaration());
}
protected void processMethods(ClassDeclaration d) {
builder.log("ProcessedMethods Class: "+d);
hasWebMethods = hasWebMethods(d);
if (d.getQualifiedName().equals(JAVA_LANG_OBJECT))
return;
if (d.getAnnotation(WebService.class) != null) {
// Super classes must have @WebService annotations to pick up their methods
for (MethodDeclaration methodDecl : d.getMethods()) {
methodDecl.accept(this);
}
}
if (d.getSuperclass() != null) {
processMethods(d.getSuperclass().getDeclaration());
}
}
private InterfaceDeclaration getEndpointInterfaceDecl(String endpointInterfaceName,
ClassDeclaration d) {
InterfaceDeclaration intTypeDecl = null;
for (InterfaceType interfaceType : d.getSuperinterfaces()) {
if (endpointInterfaceName.equals(interfaceType.toString())) {
intTypeDecl = interfaceType.getDeclaration();
seiContext = context.getSEIContext(intTypeDecl.getQualifiedName());
assert(seiContext != null);
seiContext.setImplementsSEI(true);
break;
}
}
if (intTypeDecl == null) {
intTypeDecl = (InterfaceDeclaration)builder.getTypeDeclaration(endpointInterfaceName);
}
if (intTypeDecl == null)
builder.onError(WebserviceapMessages.WEBSERVICEAP_ENDPOINTINTERFACE_CLASS_NOT_FOUND(endpointInterfaceName));
return intTypeDecl;
}
private void inspectEndpointInterface(String endpointInterfaceName, ClassDeclaration d) {
TypeDeclaration intTypeDecl = getEndpointInterfaceDecl(endpointInterfaceName, d);
if (intTypeDecl != null)
intTypeDecl.accept(this);
}
public void visitMethodDeclaration(MethodDeclaration method) {
// Methods must be public
if (!method.getModifiers().contains(Modifier.PUBLIC))
return;
if (processedMethod(method))
return;
WebMethod webMethod = method.getAnnotation(WebMethod.class);
if (webMethod != null && webMethod.exclude())
return;
SOAPBinding soapBinding = method.getAnnotation(SOAPBinding.class);
if (soapBinding == null && !method.getDeclaringType().equals(typeDecl)) {
if (method.getDeclaringType() instanceof ClassDeclaration) {
soapBinding = method.getDeclaringType().getAnnotation(SOAPBinding.class);
if (soapBinding != null)
builder.log("using "+method.getDeclaringType()+"'s SOAPBinding.");
else {
soapBinding = new MySOAPBinding();
}
}
}
boolean newBinding = false;
if (soapBinding != null) {
newBinding = pushSOAPBinding(soapBinding, method, typeDecl);
}
try {
if (shouldProcessMethod(method, webMethod)) {
processMethod(method, webMethod);
}
} finally {
if (newBinding) {
popSOAPBinding();
}
}
}
protected boolean processedMethod(MethodDeclaration method) {
String id = method.toString();
if (processedMethods.contains(id))
return true;
processedMethods.add(id);
return false;
}
protected boolean shouldProcessMethod(MethodDeclaration method, WebMethod webMethod) {
builder.log("should process method: "+method.getSimpleName()+" hasWebMethods: "+ hasWebMethods+" ");
if (hasWebMethods && webMethod == null) {
builder.log("webMethod == null");
return false;
}
boolean retval = (endpointReferencesInterface ||
method.getDeclaringType().equals(typeDecl) ||
(method.getDeclaringType().getAnnotation(WebService.class) != null));
builder.log("endpointReferencesInterface: "+endpointReferencesInterface);
builder.log("declaring class has WebSevice: "+(method.getDeclaringType().getAnnotation(WebService.class) != null));
builder.log("returning: "+retval);
return retval;
}
abstract protected void processMethod(MethodDeclaration method, WebMethod webMethod);
protected boolean isLegalImplementation(WebService webService, ClassDeclaration classDecl) {
boolean isStateful = isStateful(classDecl);
Collection<Modifier> modifiers = classDecl.getModifiers();
if (!modifiers.contains(Modifier.PUBLIC)){
builder.onError(classDecl.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_WEBSERVICE_CLASS_NOT_PUBLIC(classDecl.getQualifiedName()));
return false;
}
if (modifiers.contains(Modifier.FINAL) && !isStateful) {
builder.onError(classDecl.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_WEBSERVICE_CLASS_IS_FINAL(classDecl.getQualifiedName()));
return false;
}
if (modifiers.contains(Modifier.ABSTRACT) && !isStateful) {
builder.onError(classDecl.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_WEBSERVICE_CLASS_IS_ABSTRACT(classDecl.getQualifiedName()));
return false;
}
boolean hasDefaultConstructor = false;
for (ConstructorDeclaration constructor : classDecl.getConstructors()) {
if (constructor.getModifiers().contains(Modifier.PUBLIC) &&
constructor.getParameters().size() == 0) {
hasDefaultConstructor = true;
break;
}
}
if (!hasDefaultConstructor && !isStateful) {
if (classDecl.getDeclaringType() != null && !modifiers.contains(Modifier.STATIC)) {
builder.onError(classDecl.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_WEBSERVICE_CLASS_IS_INNERCLASS_NOT_STATIC(classDecl.getQualifiedName()));
return false;
}
builder.onError(classDecl.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_WEBSERVICE_NO_DEFAULT_CONSTRUCTOR(classDecl.getQualifiedName()));
return false;
}
if (webService.endpointInterface().length() == 0) {
if (!methodsAreLegal(classDecl))
return false;
} else {
InterfaceDeclaration intfDecl = getEndpointInterfaceDecl(webService.endpointInterface(), classDecl);
if (!classImplementsSEI(classDecl, intfDecl))
return false;
}
return true;
}
private boolean isStateful(ClassDeclaration classDecl) {
return classDecl.getAnnotation(Stateful.class)!=null;
}
protected boolean classImplementsSEI(ClassDeclaration classDecl,
InterfaceDeclaration intfDecl) {
for (InterfaceType interfaceType : classDecl.getSuperinterfaces()) {
if (interfaceType.getDeclaration().equals(intfDecl))
return true;
}
boolean implementsMethod;
for (MethodDeclaration method : intfDecl.getMethods()) {
implementsMethod = false;
for (MethodDeclaration classMethod : classDecl.getMethods()) {
if (sameMethod(method, classMethod)) {
implementsMethod = true;
break;
}
}
if (!implementsMethod) {
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_METHOD_NOT_IMPLEMENTED(intfDecl.getSimpleName(), classDecl.getSimpleName(), method));
return false;
}
}
return true;
}
protected boolean sameMethod(MethodDeclaration method1, MethodDeclaration method2) {
if (!method1.getSimpleName().equals(method2.getSimpleName()))
return false;
if (!method1.getReturnType().equals(method2.getReturnType()))
return false;
ParameterDeclaration[] params1 = method1.getParameters().toArray(new ParameterDeclaration[0]);
ParameterDeclaration[] params2 = method2.getParameters().toArray(new ParameterDeclaration[0]);
if (params1.length != params2.length)
return false;
int pos = 0;
for (ParameterDeclaration param1 : method1.getParameters()) {
if (!param1.getType().equals(params2[pos++].getType()))
return false;
}
return true;
}
protected boolean isLegalSEI(InterfaceDeclaration intf) {
for (FieldDeclaration field : intf.getFields())
if (field.getConstantValue() != null) {
builder.onError(WebserviceapMessages.WEBSERVICEAP_SEI_CANNOT_CONTAIN_CONSTANT_VALUES(intf.getQualifiedName(), field.getSimpleName()));
return false;
}
if (!methodsAreLegal(intf))
return false;
return true;
}
protected boolean methodsAreLegal(InterfaceDeclaration intfDecl) {
hasWebMethods = false;
for (MethodDeclaration method : intfDecl.getMethods()) {
if (!isLegalMethod(method, intfDecl))
return false;
}
for (InterfaceType superIntf : intfDecl.getSuperinterfaces()) {
if (!methodsAreLegal(superIntf.getDeclaration()))
return false;
}
return true;
}
protected boolean methodsAreLegal(ClassDeclaration classDecl) {
hasWebMethods = hasWebMethods(classDecl);
for (MethodDeclaration method : classDecl.getMethods()) {
if (!isLegalMethod(method, classDecl))
return false;
}
ClassType superClass = classDecl.getSuperclass();
if (!superClass.getDeclaration().getQualifiedName().equals(JAVA_LANG_OBJECT) && !methodsAreLegal(superClass.getDeclaration())) {
return false;
}
return true;
}
protected boolean isLegalMethod(MethodDeclaration method, TypeDeclaration typeDecl) {
WebMethod webMethod = method.getAnnotation(WebMethod.class);
//SEI cannot have methods with @WebMethod(exclude=true)
if (typeDecl instanceof InterfaceDeclaration && webMethod != null && webMethod.exclude())
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_INVALID_SEI_ANNOTATION_ELEMENT_EXCLUDE("exclude=true", typeDecl.getQualifiedName(), method.toString()));
if (hasWebMethods && (webMethod == null))
return true;
if (!hasWebMethods && (webMethod !=null) && webMethod.exclude()) {
return true;
}
/*
This check is not needed as Impl class is already checked that it is not abstract.
if (typeDecl instanceof ClassDeclaration && method.getModifiers().contains(Modifier.ABSTRACT)) {
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_WEBSERVICE_METHOD_IS_ABSTRACT(typeDecl.getQualifiedName(), method.getSimpleName()));
return false;
}
*/
if (!isLegalType(method.getReturnType())) {
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_METHOD_RETURN_TYPE_CANNOT_IMPLEMENT_REMOTE(typeDecl.getQualifiedName(),
method.getSimpleName(),
method.getReturnType()));
}
boolean isOneway = method.getAnnotation(Oneway.class) != null;
if (isOneway && !isValidOnewayMethod(method, typeDecl))
return false;
SOAPBinding soapBinding = method.getAnnotation(SOAPBinding.class);
if (soapBinding != null) {
if (soapBinding.style().equals(SOAPBinding.Style.RPC)) {
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_RPC_SOAPBINDING_NOT_ALLOWED_ON_METHOD(typeDecl.getQualifiedName(), method.toString()));
}
}
int paramIndex = 0;
for (ParameterDeclaration parameter : method.getParameters()) {
if (!isLegalParameter(parameter, method, typeDecl, paramIndex++))
return false;
}
if (!isDocLitWrapped() &&
soapStyle.equals(SOAPStyle.DOCUMENT)) {
ParameterDeclaration outParam = getOutParameter(method);
int inParams = getModeParameterCount(method, WebParam.Mode.IN);
int outParams = getModeParameterCount(method, WebParam.Mode.OUT);
if (inParams != 1) {
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_DOC_BARE_AND_NO_ONE_IN(typeDecl.getQualifiedName(), method.toString()));
}
if (method.getReturnType() instanceof VoidType) {
if (outParam == null && !isOneway) {
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_DOC_BARE_NO_OUT(typeDecl.getQualifiedName(), method.toString()));
}
if (outParams != 1) {
if (!isOneway && outParams != 0)
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_DOC_BARE_NO_RETURN_AND_NO_OUT(typeDecl.getQualifiedName(), method.toString()));
}
} else {
if (outParams > 0) {
builder.onError(outParam.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_DOC_BARE_RETURN_AND_OUT(typeDecl.getQualifiedName(), method.toString()));
}
}
}
return true;
}
protected boolean isLegalParameter(ParameterDeclaration param,
MethodDeclaration method,
TypeDeclaration typeDecl,
int paramIndex) {
if (!isLegalType(param.getType())) {
builder.onError(param.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_METHOD_PARAMETER_TYPES_CANNOT_IMPLEMENT_REMOTE(typeDecl.getQualifiedName(),
method.getSimpleName(),
param.getSimpleName(),
param.getType().toString()));
return false;
}
TypeMirror holderType;
holderType = builder.getHolderValueType(param.getType());
WebParam webParam = param.getAnnotation(WebParam.class);
WebParam.Mode mode = null;
if (webParam != null)
mode = webParam.mode();
if (holderType != null) {
if (mode != null && mode==WebParam.Mode.IN)
builder.onError(param.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_HOLDER_PARAMETERS_MUST_NOT_BE_IN_ONLY(typeDecl.getQualifiedName(), method.toString(), paramIndex));
} else if (mode != null && mode!=WebParam.Mode.IN) {
builder.onError(param.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_NON_IN_PARAMETERS_MUST_BE_HOLDER(typeDecl.getQualifiedName(), method.toString(), paramIndex));
}
return true;
}
protected boolean isDocLitWrapped() {
return soapStyle.equals(SOAPStyle.DOCUMENT) && wrapped;
}
protected boolean isValidOnewayMethod(MethodDeclaration method, TypeDeclaration typeDecl) {
boolean valid = true;
if (!(method.getReturnType() instanceof VoidType)) {
// this is an error, cannot be Oneway and have a return type
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_ONEWAY_OPERATION_CANNOT_HAVE_RETURN_TYPE(typeDecl.getQualifiedName(), method.toString()));
valid = false;
}
ParameterDeclaration outParam = getOutParameter(method);
if (outParam != null) {
builder.onError(outParam.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_ONEWAY_AND_OUT(typeDecl.getQualifiedName(), method.toString()));
valid = false;
}
if (!isDocLitWrapped() && soapStyle.equals(SOAPStyle.DOCUMENT)) {
int inCnt = getModeParameterCount(method, WebParam.Mode.IN);
if (inCnt != 1) {
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_ONEWAY_AND_NOT_ONE_IN(typeDecl.getQualifiedName(), method.toString()));
valid = false;
}
}
ClassDeclaration exDecl;
for (ReferenceType thrownType : method.getThrownTypes()) {
exDecl = ((ClassType)thrownType).getDeclaration();
if (!builder.isRemoteException(exDecl)) {
builder.onError(method.getPosition(), WebserviceapMessages.localizableWEBSERVICEAP_ONEWAY_OPERATION_CANNOT_DECLARE_EXCEPTIONS(typeDecl.getQualifiedName(), method.toString(), exDecl.getQualifiedName()));
valid = false;
}
}
return valid;
}
protected int getModeParameterCount(MethodDeclaration method, WebParam.Mode mode) {
WebParam webParam;
int cnt = 0;
for (ParameterDeclaration param : method.getParameters()) {
webParam = param.getAnnotation(WebParam.class);
if (webParam != null) {
if (webParam.header())
continue;
if (isEquivalentModes(mode, webParam.mode()))
cnt++;
} else {
if (isEquivalentModes(mode, WebParam.Mode.IN)) {
cnt++;
}
}
}
return cnt;
}
protected boolean isEquivalentModes(WebParam.Mode mode1, WebParam.Mode mode2) {
if (mode1.equals(mode2))
return true;
assert mode1==WebParam.Mode.IN || mode1==WebParam.Mode.OUT;
if (mode1==WebParam.Mode.IN && mode2!=WebParam.Mode.OUT)
return true;
if (mode1==WebParam.Mode.OUT && mode2!=WebParam.Mode.IN)
return true;
return false;
}
protected boolean isHolder(ParameterDeclaration param) {
return builder.getHolderValueType(param.getType()) != null;
}
protected boolean isLegalType(TypeMirror type) {
if (!(type instanceof DeclaredType))
return true;
TypeDeclaration typeDecl = ((DeclaredType)type).getDeclaration();
if(typeDecl == null) {
// can be null, if this type's declaration is unknown. This may be the result of a processing error, such as a missing class file.
builder.onError(WebserviceapMessages.WEBSERVICEAP_COULD_NOT_FIND_TYPEDECL(typeDecl.toString(), context.getRound()));
}
return !builder.isRemote(typeDecl);
}
protected ParameterDeclaration getOutParameter(MethodDeclaration method) {
WebParam webParam;
for (ParameterDeclaration param : method.getParameters()) {
webParam = param.getAnnotation(WebParam.class);
if (webParam != null && webParam.mode()!=WebParam.Mode.IN) {
return param;
}
}
return null;
}
protected static class MySOAPBinding implements SOAPBinding {
public Style style() {return SOAPBinding.Style.DOCUMENT;}
public Use use() {return SOAPBinding.Use.LITERAL; }
public ParameterStyle parameterStyle() { return SOAPBinding.ParameterStyle.WRAPPED;}
public Class<? extends java.lang.annotation.Annotation> annotationType() {
return SOAPBinding.class;
}
}
}