v1.5beta1/modules/jaxws/src/org/apache/axis2/jaxws/utility/PropertyDescriptorPlus.java - axis-axis2-java-core - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements. See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership. The ASF licenses this file
  * to you 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 org.apache.axis2.jaxws.utility;

 import org.apache.axis2.jaxws.ExceptionFactory;
 import org.apache.axis2.jaxws.i18n.Messages;
 import org.apache.axis2.jaxws.wrapper.impl.JAXBWrapperException;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;

 import javax.xml.namespace.QName;
 import javax.xml.bind.JAXBElement;
 import java.beans.IndexedPropertyDescriptor;
 import java.beans.PropertyDescriptor;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
 import java.util.Collection;

 /**
  * A PropertyDescriptor provides acesss to a bean property.  Values can be queried/changed using the
  * read and writer methods of the PropertyDescriptor.
  * <p/>
  * A PropertyDescriptorPlus object wraps a PropertyDescriptor and supplies enhanced set/get methods
  * that match JAXB semantis.
  * <p/>
  * For example, the set(..) method is smart enough to add lists, arrays and atomic values on JAXB
  * beans.
  * <p/>
  * The PropertyDescriptorPlus object also stores the xmlName of the property.
  *
  * @See XMLRootElementUtil.createPropertyDescriptorMap , which creates the PropertyDescriptorPlus
  * objects
  */
 public class PropertyDescriptorPlus {
     PropertyDescriptor descriptor;
     QName xmlName = null;

     private static Log log = LogFactory.getLog(PropertyDescriptorPlus.class);
     private static final boolean DEBUG_ENABLED = log.isDebugEnabled();

     /**
      * Package protected constructor.  Only created by XMLRootElementUtil.createPropertyDescriptorMap
      *
      * @param propertyName
      * @param descriptor
      * @see XMLRootElementUtil.createPropertyDescriptorMap
      */
     PropertyDescriptorPlus(PropertyDescriptor descriptor, QName xmlName) {
         super();
         this.descriptor = descriptor;
         this.xmlName = xmlName;
     }

     /**
      * Package protected constructor.  Only created by XMLRootElementUtil.createPropertyDescriptorMap
      *
      * @param propertyName
      * @param descriptor
      * @see XMLRootElementUtil.createPropertyDescriptorMap
      */
     PropertyDescriptorPlus(PropertyDescriptor descriptor, String xmlName) {
         super();
         this.descriptor = descriptor;
         this.xmlName = new QName("", xmlName);
     }

     /** @return xmlname */
     public String getXmlName() {
         return xmlName.getLocalPart();
     }

     public QName getXmlQName() {
         return xmlName;
     }

     /** @return property type */
     public Class getPropertyType() {
         return descriptor.getPropertyType();
     }

     /** @return property name */
     public String getPropertyName() {
         return descriptor.getName();
     }

     /**
      * Get the object
      *
      * @param targetBean
      * @return Object for this property or null
      * @throws InvocationTargetException
      * @throws IllegalAccessException
      */
     public Object get(Object targetBean) throws InvocationTargetException, IllegalAccessException {
             if(descriptor == null){
                 throw new RuntimeException(Messages.getMessage("pDescrErr"));
             }
             Method method = descriptor.getReadMethod();
             if(method == null && descriptor.getPropertyType() == Boolean.class){
                 String propertyName = descriptor.getName();
                 if(propertyName != null){
                     String methodName = "is";
                     methodName = methodName + ((propertyName.length()>0)?propertyName.substring(0,1).toUpperCase():"");
                     methodName = methodName + ((propertyName.length() > 1)?propertyName.substring(1):"");
                     if(log.isDebugEnabled()){
                         log.debug("Method Name =" +methodName);
                     }
                    try{
                        method = targetBean.getClass().getMethod(methodName, null);
                    }catch(NoSuchMethodException e){
                        if(log.isDebugEnabled()){
                            log.debug("Method not found" + methodName);
                        }
                    }
                 }
             }
             if(method == null){
                 throw new RuntimeException(Messages.getMessage("pDescrErr2",targetBean.getClass().getName()));
             }
             Object ret = method.invoke(targetBean, null);
             if (ret != null && method.getReturnType() == JAXBElement.class) {
                 ret = ((JAXBElement) ret).getValue();
             }
             return ret;
     }

     /**
      * Set the object
      *
      * @param targetBean
      * @param propValue
      * @throws InvocationTargetException
      * @throws IllegalAccessException
      * @throws JAXBWrapperException
      */
     public void set(Object targetBean, Object propValue, Class dclClass)
             throws InvocationTargetException, IllegalAccessException, JAXBWrapperException {

         Method writeMethod  = null;
         try {
             // No set occurs if the value is null
             if (propValue == null) {
                 return;
             }

             // There are 3 different types of setters that can occur.
             // 1) Normal Attomic Setter : setFoo(type)
             // 2) Indexed Array Setter : setFoo(type[])
             // 3) No Setter case if the property is a List<T>.

             writeMethod = descriptor.getWriteMethod();
             if (descriptor instanceof IndexedPropertyDescriptor) {
                 // Set for indexed  T[]
                 setIndexedArray(targetBean, propValue, writeMethod);
             } else if (writeMethod == null) {
                 // Set for List<T>
                 setList(targetBean, propValue);
             } else if (descriptor.getPropertyType() == JAXBElement.class) {
                 if (propValue != null) {
                     Class clazz = dclClass!=null ? dclClass : propValue.getClass();
                     JAXBElement element = new JAXBElement(xmlName, clazz, propValue);
                     setAtomic(targetBean, element, writeMethod);
                 }
             } else {
                 // Normal case
                 setAtomic(targetBean, propValue, writeMethod);
             }
         } catch (RuntimeException e) {

             if (DEBUG_ENABLED) {
                 String propClass = propValue.getClass().getName();
                 log.debug("An exception occurred while attempting to set a property on " +
                           targetBean.getClass().getName());
                 log.debug("The setter method is " + writeMethod );
                 log.debug("The class of the argument is :" +propClass);
                 log.debug("The PropertyDescriptor is: " + this.toString());
                 log.debug("The exception is: " + e);
             }
             throw e;
         }
     }

     /**
      * Set the property value onto targetBean using the writeMethod
      *
      * @param targetBean
      * @param propValue
      * @param writeMethod (set(T))
      * @throws InvocationTargetException
      * @throws IllegalAccessException
      * @throws JAXBWrapperException
      */
     private void setAtomic(Object targetBean, Object propValue, Method writeMethod)
     throws InvocationTargetException, IllegalAccessException, JAXBWrapperException {
         // JAXB provides setters for atomic value.

         if (propValue != null) {
             // Normal case
         	Object[] SINGLE_PARAM = new Object[1];
             SINGLE_PARAM[0] = propValue;
             writeMethod.invoke(targetBean, SINGLE_PARAM);
         } else {
             Class[] paramTypes = writeMethod.getParameterTypes();

             if(paramTypes !=null && paramTypes.length ==1){
                 Class paramType = paramTypes[0];
                 if(paramType.isPrimitive() && propValue == null){
                     //Ignoring null value for primitive type, this could potentially be the way of a customer indicating to set
                     //default values defined in JAXBObject/xmlSchema.
                     if(DEBUG_ENABLED){
                         log.debug("Ignoring null value for primitive type, this is the way to set default values defined in JAXBObject/xmlSchema. for primitive types");
                     }
                     return;
                 }
             }
         }

     }

     /**
      * Set the property value using the indexed array setter
      *
      * @param targetBean
      * @param propValue
      * @param writeMethod set(T[])
      * @throws InvocationTargetException
      * @throws IllegalAccessException
      * @throws JAXBWrapperException
      */
     private void setIndexedArray(Object targetBean, Object propValue, Method writeMethod)
             throws InvocationTargetException, IllegalAccessException, JAXBWrapperException {

         Class paramType = writeMethod.getParameterTypes()[0];
         Object value = asArray(propValue, paramType);
         // JAXB provides setters for atomic value.
         Object[] SINGLE_PARAM = new Object[1];
         SINGLE_PARAM[0] =value;

         writeMethod.invoke(targetBean, SINGLE_PARAM);
     }

     /**
      * Set the property value for the collection case.
      *
      * @param targetBean
      * @param propValue
      * @throws InvocationTargetException
      * @throws IllegalAccessException
      * @throws JAXBWrapperException
      */
     private void setList(Object targetBean, Object propValue)
             throws InvocationTargetException, IllegalAccessException, JAXBWrapperException {
         // For the List<T> case, there is no setter.
         // You are supposed to use the getter to obtain access to the collection and then add the collection

         Collection value = asCollection(propValue, descriptor.getPropertyType());
         Collection collection = (Collection)get(targetBean);

         // Now add our our object to the collection
         collection.clear();
         if (propValue != null) {
             collection.addAll(value);
         }
     }

     /**
      * @param propValue
      * @param destType
      * @return propValue as a Collection
      */
     private static Collection asCollection(Object propValue, Class destType) {
         // TODO Missing function
         // Convert the object into an equivalent object that is a collection
         if (ConvertUtils.isConvertable(propValue, destType)) {
             return (Collection)ConvertUtils.convert(propValue, destType);
         } else {
             String objectClass = (propValue == null) ? "null" : propValue.getClass().getName();
             throw ExceptionFactory.makeWebServiceException(
                     Messages.getMessage("convertProblem", objectClass, destType.getName()));

         }
     }

     /**
      * @param propValue
      * @param destType  T[]
      * @return array of component type
      */
     private static Object asArray(Object propValue, Class destType) {
         if (ConvertUtils.isConvertable(propValue, destType)) {
             return ConvertUtils.convert(propValue, destType);
         } else {
             String objectClass = (propValue == null) ? "null" : propValue.getClass().getName();
             throw ExceptionFactory.makeWebServiceException(
                     Messages.getMessage("convertProblem", objectClass, destType.getName()));

         }
     }

     public String toString() {
         String value = "PropertyDescriptorPlus[";
         value += " name=" + this.getPropertyName();
         value += " type=" + this.getPropertyType().getName();
         value += " propertyDecriptor=" + this.descriptor;
         return value + "]";
     }
 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you 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 org.apache.axis2.jaxws.utility;

	import org.apache.axis2.jaxws.ExceptionFactory;
	import org.apache.axis2.jaxws.i18n.Messages;
	import org.apache.axis2.jaxws.wrapper.impl.JAXBWrapperException;
	import org.apache.commons.logging.Log;
	import org.apache.commons.logging.LogFactory;

	import javax.xml.namespace.QName;
	import javax.xml.bind.JAXBElement;
	import java.beans.IndexedPropertyDescriptor;
	import java.beans.PropertyDescriptor;
	import java.lang.reflect.InvocationTargetException;
	import java.lang.reflect.Method;
	import java.util.Collection;

	/**
	* A PropertyDescriptor provides acesss to a bean property. Values can be queried/changed using the
	* read and writer methods of the PropertyDescriptor.
	* <p/>
	* A PropertyDescriptorPlus object wraps a PropertyDescriptor and supplies enhanced set/get methods
	* that match JAXB semantis.
	* <p/>
	* For example, the set(..) method is smart enough to add lists, arrays and atomic values on JAXB
	* beans.
	* <p/>
	* The PropertyDescriptorPlus object also stores the xmlName of the property.
	*
	* @See XMLRootElementUtil.createPropertyDescriptorMap , which creates the PropertyDescriptorPlus
	* objects
	*/
	public class PropertyDescriptorPlus {
	PropertyDescriptor descriptor;
	QName xmlName = null;

	private static Log log = LogFactory.getLog(PropertyDescriptorPlus.class);
	private static final boolean DEBUG_ENABLED = log.isDebugEnabled();

	/**
	* Package protected constructor. Only created by XMLRootElementUtil.createPropertyDescriptorMap
	*
	* @param propertyName
	* @param descriptor
	* @see XMLRootElementUtil.createPropertyDescriptorMap
	*/
	PropertyDescriptorPlus(PropertyDescriptor descriptor, QName xmlName) {
	super();
	this.descriptor = descriptor;
	this.xmlName = xmlName;
	}

	/**
	* Package protected constructor. Only created by XMLRootElementUtil.createPropertyDescriptorMap
	*
	* @param propertyName
	* @param descriptor
	* @see XMLRootElementUtil.createPropertyDescriptorMap
	*/
	PropertyDescriptorPlus(PropertyDescriptor descriptor, String xmlName) {
	super();
	this.descriptor = descriptor;
	this.xmlName = new QName("", xmlName);
	}

	/** @return xmlname */
	public String getXmlName() {
	return xmlName.getLocalPart();
	}

	public QName getXmlQName() {
	return xmlName;
	}

	/** @return property type */
	public Class getPropertyType() {
	return descriptor.getPropertyType();
	}

	/** @return property name */
	public String getPropertyName() {
	return descriptor.getName();
	}

	/**
	* Get the object
	*
	* @param targetBean
	* @return Object for this property or null
	* @throws InvocationTargetException
	* @throws IllegalAccessException
	*/
	public Object get(Object targetBean) throws InvocationTargetException, IllegalAccessException {
	if(descriptor == null){
	throw new RuntimeException(Messages.getMessage("pDescrErr"));
	}
	Method method = descriptor.getReadMethod();
	if(method == null && descriptor.getPropertyType() == Boolean.class){
	String propertyName = descriptor.getName();
	if(propertyName != null){
	String methodName = "is";
	methodName = methodName + ((propertyName.length()>0)?propertyName.substring(0,1).toUpperCase():"");
	methodName = methodName + ((propertyName.length() > 1)?propertyName.substring(1):"");
	if(log.isDebugEnabled()){
	log.debug("Method Name =" +methodName);
	}
	try{
	method = targetBean.getClass().getMethod(methodName, null);
	}catch(NoSuchMethodException e){
	if(log.isDebugEnabled()){
	log.debug("Method not found" + methodName);
	}
	}
	}
	}
	if(method == null){
	throw new RuntimeException(Messages.getMessage("pDescrErr2",targetBean.getClass().getName()));
	}
	Object ret = method.invoke(targetBean, null);
	if (ret != null && method.getReturnType() == JAXBElement.class) {
	ret = ((JAXBElement) ret).getValue();
	}
	return ret;
	}

	/**
	* Set the object
	*
	* @param targetBean
	* @param propValue
	* @throws InvocationTargetException
	* @throws IllegalAccessException
	* @throws JAXBWrapperException
	*/
	public void set(Object targetBean, Object propValue, Class dclClass)
	throws InvocationTargetException, IllegalAccessException, JAXBWrapperException {

	Method writeMethod = null;
	try {
	// No set occurs if the value is null
	if (propValue == null) {
	return;
	}

	// There are 3 different types of setters that can occur.
	// 1) Normal Attomic Setter : setFoo(type)
	// 2) Indexed Array Setter : setFoo(type[])
	// 3) No Setter case if the property is a List<T>.

	writeMethod = descriptor.getWriteMethod();
	if (descriptor instanceof IndexedPropertyDescriptor) {
	// Set for indexed T[]
	setIndexedArray(targetBean, propValue, writeMethod);
	} else if (writeMethod == null) {
	// Set for List<T>
	setList(targetBean, propValue);
	} else if (descriptor.getPropertyType() == JAXBElement.class) {
	if (propValue != null) {
	Class clazz = dclClass!=null ? dclClass : propValue.getClass();
	JAXBElement element = new JAXBElement(xmlName, clazz, propValue);
	setAtomic(targetBean, element, writeMethod);
	}
	} else {
	// Normal case
	setAtomic(targetBean, propValue, writeMethod);
	}
	} catch (RuntimeException e) {

	if (DEBUG_ENABLED) {
	String propClass = propValue.getClass().getName();
	log.debug("An exception occurred while attempting to set a property on " +
	targetBean.getClass().getName());
	log.debug("The setter method is " + writeMethod );
	log.debug("The class of the argument is :" +propClass);
	log.debug("The PropertyDescriptor is: " + this.toString());
	log.debug("The exception is: " + e);
	}
	throw e;
	}
	}

	/**
	* Set the property value onto targetBean using the writeMethod
	*
	* @param targetBean
	* @param propValue
	* @param writeMethod (set(T))
	* @throws InvocationTargetException
	* @throws IllegalAccessException
	* @throws JAXBWrapperException
	*/
	private void setAtomic(Object targetBean, Object propValue, Method writeMethod)
	throws InvocationTargetException, IllegalAccessException, JAXBWrapperException {
	// JAXB provides setters for atomic value.

	if (propValue != null) {
	// Normal case
	Object[] SINGLE_PARAM = new Object[1];
	SINGLE_PARAM[0] = propValue;
	writeMethod.invoke(targetBean, SINGLE_PARAM);
	} else {
	Class[] paramTypes = writeMethod.getParameterTypes();

	if(paramTypes !=null && paramTypes.length ==1){
	Class paramType = paramTypes[0];
	if(paramType.isPrimitive() && propValue == null){
	//Ignoring null value for primitive type, this could potentially be the way of a customer indicating to set
	//default values defined in JAXBObject/xmlSchema.
	if(DEBUG_ENABLED){
	log.debug("Ignoring null value for primitive type, this is the way to set default values defined in JAXBObject/xmlSchema. for primitive types");
	}
	return;
	}
	}
	}

	}

	/**
	* Set the property value using the indexed array setter
	*
	* @param targetBean
	* @param propValue
	* @param writeMethod set(T[])
	* @throws InvocationTargetException
	* @throws IllegalAccessException
	* @throws JAXBWrapperException
	*/
	private void setIndexedArray(Object targetBean, Object propValue, Method writeMethod)
	throws InvocationTargetException, IllegalAccessException, JAXBWrapperException {

	Class paramType = writeMethod.getParameterTypes()[0];
	Object value = asArray(propValue, paramType);
	// JAXB provides setters for atomic value.
	Object[] SINGLE_PARAM = new Object[1];
	SINGLE_PARAM[0] =value;

	writeMethod.invoke(targetBean, SINGLE_PARAM);
	}

	/**
	* Set the property value for the collection case.
	*
	* @param targetBean
	* @param propValue
	* @throws InvocationTargetException
	* @throws IllegalAccessException
	* @throws JAXBWrapperException
	*/
	private void setList(Object targetBean, Object propValue)
	throws InvocationTargetException, IllegalAccessException, JAXBWrapperException {
	// For the List<T> case, there is no setter.
	// You are supposed to use the getter to obtain access to the collection and then add the collection

	Collection value = asCollection(propValue, descriptor.getPropertyType());
	Collection collection = (Collection)get(targetBean);

	// Now add our our object to the collection
	collection.clear();
	if (propValue != null) {
	collection.addAll(value);
	}
	}

	/**
	* @param propValue
	* @param destType
	* @return propValue as a Collection
	*/
	private static Collection asCollection(Object propValue, Class destType) {
	// TODO Missing function
	// Convert the object into an equivalent object that is a collection
	if (ConvertUtils.isConvertable(propValue, destType)) {
	return (Collection)ConvertUtils.convert(propValue, destType);
	} else {
	String objectClass = (propValue == null) ? "null" : propValue.getClass().getName();
	throw ExceptionFactory.makeWebServiceException(
	Messages.getMessage("convertProblem", objectClass, destType.getName()));

	}
	}

	/**
	* @param propValue
	* @param destType T[]
	* @return array of component type
	*/
	private static Object asArray(Object propValue, Class destType) {
	if (ConvertUtils.isConvertable(propValue, destType)) {
	return ConvertUtils.convert(propValue, destType);
	} else {
	String objectClass = (propValue == null) ? "null" : propValue.getClass().getName();
	throw ExceptionFactory.makeWebServiceException(
	Messages.getMessage("convertProblem", objectClass, destType.getName()));

	}
	}

	public String toString() {
	String value = "PropertyDescriptorPlus[";
	value += " name=" + this.getPropertyName();
	value += " type=" + this.getPropertyType().getName();
	value += " propertyDecriptor=" + this.descriptor;
	return value + "]";
	}
	}