jdk8-mips64-public/jaxws: src/share/jaxws_classes/com/sun/xml/internal/ws/model/AbstractWrapperBeanGenerator.java@f50545b5e2f1 (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/model/AbstractWrapperBeanGenerator.java@f50545b5e2f1 (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/model/AbstractWrapperBeanGenerator.java

Tue, 06 Mar 2012 16:09:35 -0800

author: ohair
date: Tue, 06 Mar 2012 16:09:35 -0800
changeset 286: f50545b5e2f1
child 368: 0989ad8c0860
permissions: -rw-r--r--

7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom

 /*
  * Copyright (c) 1997, 2011, 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.xml.internal.ws.model;
 import com.sun.istack.internal.NotNull;
 import com.sun.xml.internal.bind.v2.model.annotation.AnnotationReader;
 import com.sun.xml.internal.bind.v2.model.nav.Navigator;
 import com.sun.xml.internal.ws.spi.db.BindingHelper;
 import com.sun.xml.internal.ws.util.StringUtils;
 import javax.jws.WebParam;
 import javax.jws.WebResult;
 import javax.xml.bind.annotation.*;
 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 import javax.xml.ws.WebServiceException;
 import java.lang.annotation.Annotation;
 import java.lang.reflect.InvocationHandler;
 import java.lang.reflect.Method;
 import java.lang.reflect.Proxy;
 import java.util.*;
 import java.util.logging.Logger;
 /**
  * Finds request/response wrapper and exception bean memebers.
  *
  * <p>
  * It uses JAXB's {@link AnnotationReader}, {@link Navigator} so that
  * tools can use this with annotation processing, and the runtime can use this with
  * reflection.
  *
  * @author Jitendra Kotamraju
  */
 public abstract class AbstractWrapperBeanGenerator<T,C,M,A extends Comparable> {
     private static final Logger LOGGER = Logger.getLogger(AbstractWrapperBeanGenerator.class.getName());
     private static final String RETURN = "return";
     private static final String EMTPY_NAMESPACE_ID = "";
     private static final Class[] jaxbAnns = new Class[] {
         XmlAttachmentRef.class, XmlMimeType.class, XmlJavaTypeAdapter.class,
         XmlList.class, XmlElement.class
     };
     private static final Set<String> skipProperties = new HashSet<String>();
     static{
         skipProperties.add("getCause");
         skipProperties.add("getLocalizedMessage");
         skipProperties.add("getClass");
         skipProperties.add("getStackTrace");
         skipProperties.add("getSuppressed");  // JDK 7 adds this
     }
     private final AnnotationReader<T,C,?,M> annReader;
     private final Navigator<T,C,?,M> nav;
     private final BeanMemberFactory<T,A> factory;
     protected AbstractWrapperBeanGenerator(AnnotationReader<T,C,?,M> annReader,
             Navigator<T,C,?,M> nav, BeanMemberFactory<T,A> factory) {
         this.annReader = annReader;
         this.nav = nav;
         this.factory = factory;
     }
     public static interface BeanMemberFactory<T,A> {
         A createWrapperBeanMember(T paramType, String paramName, List<Annotation> jaxbAnnotations);
     }
     // Collects the JAXB annotations on a method
     private List<Annotation> collectJAXBAnnotations(M method) {
         List<Annotation> jaxbAnnotation = new ArrayList<Annotation>();
         for(Class jaxbClass : jaxbAnns) {
             Annotation ann = annReader.getMethodAnnotation(jaxbClass, method, null);
             if (ann != null) {
                 jaxbAnnotation.add(ann);
             }
         }
         return jaxbAnnotation;
     }
     // Collects the JAXB annotations on a parameter
     private List<Annotation> collectJAXBAnnotations(M method, int paramIndex) {
         List<Annotation> jaxbAnnotation = new ArrayList<Annotation>();
         for(Class jaxbClass : jaxbAnns) {
             Annotation ann = annReader.getMethodParameterAnnotation(jaxbClass, method, paramIndex, null);
             if (ann != null) {
                 jaxbAnnotation.add(ann);
             }
         }
         return jaxbAnnotation;
     }
     protected abstract T getSafeType(T type);
     /**
      * Returns Holder's value type.
      *
      * @return null if it not a Holder, otherwise return Holder's value type
      */
     protected abstract T getHolderValueType(T type);
     protected abstract boolean isVoidType(T type);
     /**
      * Computes request bean members for a method. Collects all IN and INOUT
      * parameters as request bean fields. In this process, if a parameter
      * has any known JAXB annotations they are collected as well.
      * Special processing for @XmlElement annotation is done.
      *
      * @param method SEI method for which request bean members are computed
      * @return List of request bean members
      */
     public List<A> collectRequestBeanMembers(M method) {
         List<A> requestMembers = new ArrayList<A>();
         int paramIndex = -1;
         for (T param : nav.getMethodParameters(method)) {
             paramIndex++;
             WebParam webParam = annReader.getMethodParameterAnnotation(WebParam.class, method, paramIndex, null);
             if (webParam != null && (webParam.header() || webParam.mode().equals(WebParam.Mode.OUT))) {
                 continue;
             }
             T holderType = getHolderValueType(param);
 //            if (holderType != null && webParam != null && webParam.mode().equals(WebParam.Mode.IN)) {
 //                // Should we flag an error - holder cannot be IN part ??
 //                continue;
 //            }
             T paramType = (holderType != null) ? holderType : getSafeType(param);
             String paramName = (webParam != null && webParam.name().length() > 0)
                     ? webParam.name() : "arg"+paramIndex;
             String paramNamespace = (webParam != null && webParam.targetNamespace().length() > 0)
                     ? webParam.targetNamespace() : EMTPY_NAMESPACE_ID;
             // Collect JAXB annotations on a parameter
             List<Annotation> jaxbAnnotation = collectJAXBAnnotations(method, paramIndex);
             // If a parameter contains @XmlElement, process it.
             processXmlElement(jaxbAnnotation, paramName, paramNamespace, paramType);
             A member = factory.createWrapperBeanMember(paramType,
                     getPropertyName(paramName), jaxbAnnotation);
             requestMembers.add(member);
         }
         return requestMembers;
     }
     /**
      * Computes response bean members for a method. Collects all OUT and INOUT
      * parameters as response bean fields. In this process, if a parameter
      * has any known JAXB annotations they are collected as well.
      * Special processing for @XmlElement annotation is done.
      *
      * @param method SEI method for which response bean members are computed
      * @return List of response bean members
      */
     public List<A> collectResponseBeanMembers(M method) {
         List<A> responseMembers = new ArrayList<A>();
         // return that need to be part response wrapper bean
         String responseElementName = RETURN;
         String responseNamespace = EMTPY_NAMESPACE_ID;
         boolean isResultHeader = false;
         WebResult webResult = annReader.getMethodAnnotation(WebResult.class, method ,null);
         if (webResult != null) {
             if (webResult.name().length() > 0) {
                 responseElementName = webResult.name();
             }
             if (webResult.targetNamespace().length() > 0) {
                 responseNamespace = webResult.targetNamespace();
             }
             isResultHeader = webResult.header();
         }
         T returnType = getSafeType(nav.getReturnType(method));
         if (!isVoidType(returnType) && !isResultHeader) {
             List<Annotation> jaxbRespAnnotations = collectJAXBAnnotations(method);
             processXmlElement(jaxbRespAnnotations, responseElementName, responseNamespace, returnType);
             responseMembers.add(factory.createWrapperBeanMember(returnType, getPropertyName(responseElementName), jaxbRespAnnotations));
         }
         // Now parameters that need to be part response wrapper bean
         int paramIndex = -1;
         for (T param : nav.getMethodParameters(method)) {
             paramIndex++;
             T paramType = getHolderValueType(param);
             WebParam webParam = annReader.getMethodParameterAnnotation(WebParam.class, method, paramIndex, null);
             if (paramType == null || (webParam != null && webParam.header())) {
                 continue;       // not a holder or a header - so don't add it
             }
             String paramName = (webParam != null && webParam.name().length() > 0)
                     ? webParam.name() : "arg"+paramIndex;
             String paramNamespace = (webParam != null && webParam.targetNamespace().length() > 0)
                     ? webParam.targetNamespace() : EMTPY_NAMESPACE_ID;
             List<Annotation> jaxbAnnotation = collectJAXBAnnotations(method, paramIndex);
             processXmlElement(jaxbAnnotation, paramName, paramNamespace, paramType);
             A member = factory.createWrapperBeanMember(paramType,
                     getPropertyName(paramName), jaxbAnnotation);
             responseMembers.add(member);
         }
         return responseMembers;
     }
     private void processXmlElement(List<Annotation> jaxb, String elemName, String elemNS, T type) {
         XmlElement elemAnn = null;
         for (Annotation a : jaxb) {
             if (a.annotationType() == XmlElement.class) {
                 elemAnn = (XmlElement) a;
                 jaxb.remove(a);
                 break;
             }
         }
         String name = (elemAnn != null && !elemAnn.name().equals("##default"))
                 ? elemAnn.name() : elemName;
         String ns = (elemAnn != null && !elemAnn.namespace().equals("##default"))
                 ? elemAnn.namespace() : elemNS;
         boolean nillable = nav.isArray(type)
                 || (elemAnn != null && elemAnn.nillable());
         boolean required = elemAnn != null && elemAnn.required();
         XmlElementHandler handler = new XmlElementHandler(name, ns, nillable, required);
         XmlElement elem = (XmlElement) Proxy.newProxyInstance(this.getClass().getClassLoader(), new Class<?>[]{XmlElement.class}, handler);
         jaxb.add(elem);
     }
     private static class XmlElementHandler implements InvocationHandler {
         private String name;
         private String namespace;
         private boolean nillable;
         private boolean required;
         XmlElementHandler(String name, String namespace, boolean nillable,
                           boolean required) {
             this.name = name;
             this.namespace = namespace;
             this.nillable = nillable;
             this.required = required;
         }
         public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
             String methodName = method.getName();
             if (methodName.equals("name")) {
                 return name;
             } else if (methodName.equals("namespace")) {
                 return namespace;
             } else if (methodName.equals("nillable")) {
                 return nillable;
             } else if (methodName.equals("required")) {
                 return required;
             } else {
                 throw new WebServiceException("Not handling "+methodName);
             }
         }
     }
     /**
      * Computes and sorts exception bean members for a given exception as per
      * the 3.7 section of the spec. It takes all getter properties in the
      * exception and its superclasses(except getCause, getLocalizedMessage,
      * getStackTrace, getClass). The returned collection is sorted based
      * on the property names.
      *
      * <p>
      * But if the exception has @XmlType its values are honored. Only the
      * propOrder properties are considered. The returned collection is sorted
      * as per the given propOrder.
      *
      * @param exception
      * @return list of properties in the correct order for an exception bean
      */
     public Collection<A> collectExceptionBeanMembers(C exception) {
         TreeMap<String, A> fields = new TreeMap<String, A>();
         getExceptionProperties(exception, fields);
         // Consider only the @XmlType(propOrder) properties
         XmlType xmlType = annReader.getClassAnnotation(XmlType.class, exception, null);
         if (xmlType != null) {
             String[] propOrder = xmlType.propOrder();
             // If not the default order of properties, use that propOrder
             if (propOrder.length > 0 && propOrder[0].length() != 0) {
                 List<A> list = new ArrayList<A>();
                 for(String prop : propOrder) {
                     A a = fields.get(prop);
                     if (a != null) {
                         list.add(a);
                     } else {
                         throw new WebServiceException("Exception "+exception+
                                 " has @XmlType and its propOrder contains unknown property "+prop);
                     }
                 }
                 return list;
             }
         }
         return fields.values();
     }
     private void getExceptionProperties(C exception, TreeMap<String, A> fields) {
         C sc = nav.getSuperClass(exception);
         if (sc != null) {
             getExceptionProperties(sc, fields);
         }
         Collection<? extends M> methods = nav.getDeclaredMethods(exception);
         for (M method : methods) {
             // 2.1.x is doing the following: no final static, transient, non-public
             // transient cannot used as modifier for method, so not doing it now
             if (!nav.isPublicMethod(method)
                 || (nav.isStaticMethod(method) && nav.isFinalMethod(method))) {
                  continue;
             }
             if (!nav.isPublicMethod(method)) {
                 continue;
             }
             String name = nav.getMethodName(method);
             if (!(name.startsWith("get") || name.startsWith("is")) || skipProperties.contains(name) ||
                     name.equals("get") || name.equals("is")) {
                 // Don't bother with invalid propertyNames.
                 continue;
             }
             T returnType = getSafeType(nav.getReturnType(method));
             if (nav.getMethodParameters(method).length == 0) {
                 String fieldName = name.startsWith("get")
                         ? StringUtils.decapitalize(name.substring(3))
                         : StringUtils.decapitalize(name.substring(2));
                 fields.put(fieldName, factory.createWrapperBeanMember(returnType, fieldName, Collections.<Annotation>emptyList()));
             }
         }
     }
     /**
      * Gets the property name by mangling using JAX-WS rules
      * @param name to be mangled
      * @return property name
      */
     private static String getPropertyName(String name) {
         String propertyName = BindingHelper.mangleNameToVariableName(name);
         //We wont have to do this if JAXBRIContext.mangleNameToVariableName() takes
         //care of mangling java identifiers
         return getJavaReservedVarialbeName(propertyName);
     }
     //TODO MOVE Names.java to runtime (instead of doing the following)
     /*
      * See if its a java keyword name, if so then mangle the name
      */
     private static @NotNull String getJavaReservedVarialbeName(@NotNull String name) {
         String reservedName = reservedWords.get(name);
         return reservedName == null ? name : reservedName;
     }
     private static final Map<String, String> reservedWords;
     static {
         reservedWords = new HashMap<String, String>();
         reservedWords.put("abstract", "_abstract");
         reservedWords.put("assert", "_assert");
         reservedWords.put("boolean", "_boolean");
         reservedWords.put("break", "_break");
         reservedWords.put("byte", "_byte");
         reservedWords.put("case", "_case");
         reservedWords.put("catch", "_catch");
         reservedWords.put("char", "_char");
         reservedWords.put("class", "_class");
         reservedWords.put("const", "_const");
         reservedWords.put("continue", "_continue");
         reservedWords.put("default", "_default");
         reservedWords.put("do", "_do");
         reservedWords.put("double", "_double");
         reservedWords.put("else", "_else");
         reservedWords.put("extends", "_extends");
         reservedWords.put("false", "_false");
         reservedWords.put("final", "_final");
         reservedWords.put("finally", "_finally");
         reservedWords.put("float", "_float");
         reservedWords.put("for", "_for");
         reservedWords.put("goto", "_goto");
         reservedWords.put("if", "_if");
         reservedWords.put("implements", "_implements");
         reservedWords.put("import", "_import");
         reservedWords.put("instanceof", "_instanceof");
         reservedWords.put("int", "_int");
         reservedWords.put("interface", "_interface");
         reservedWords.put("long", "_long");
         reservedWords.put("native", "_native");
         reservedWords.put("new", "_new");
         reservedWords.put("null", "_null");
         reservedWords.put("package", "_package");
         reservedWords.put("private", "_private");
         reservedWords.put("protected", "_protected");
         reservedWords.put("public", "_public");
         reservedWords.put("return", "_return");
         reservedWords.put("short", "_short");
         reservedWords.put("static", "_static");
         reservedWords.put("strictfp", "_strictfp");
         reservedWords.put("super", "_super");
         reservedWords.put("switch", "_switch");
         reservedWords.put("synchronized", "_synchronized");
         reservedWords.put("this", "_this");
         reservedWords.put("throw", "_throw");
         reservedWords.put("throws", "_throws");
         reservedWords.put("transient", "_transient");
         reservedWords.put("true", "_true");
         reservedWords.put("try", "_try");
         reservedWords.put("void", "_void");
         reservedWords.put("volatile", "_volatile");
         reservedWords.put("while", "_while");
         reservedWords.put("enum", "_enum");
     }
 }

Mercurial > jdk8-mips64-public > jaxws / annotate

src/share/jaxws_classes/com/sun/xml/internal/ws/model/AbstractWrapperBeanGenerator.java@f50545b5e2f1 (annotated)

src/share/jaxws_classes/com/sun/xml/internal/ws/model/AbstractWrapperBeanGenerator.java