/*
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Axis" and "Apache Software Foundation" must
* not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.axis.utils;
import org.apache.axis.InternalException;
import org.apache.axis.Constants;
import org.apache.axis.description.TypeDesc;
import org.apache.axis.description.FieldDesc;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.beans.PropertyDescriptor;
import java.beans.Introspector;
import java.util.Vector;
import java.lang.reflect.Method;
import java.lang.reflect.Field;
import java.lang.reflect.Modifier;
import java.util.ArrayList;
import org.apache.axis.components.logger.LogFactory;
import org.apache.commons.logging.Log;
public class BeanUtils {
public static final Object[] noArgs = new Object[] {};
protected static Log log =
LogFactory.getLog(BeanUtils.class.getName());
/**
* Create a BeanPropertyDescriptor array for the indicated class.
* @param javaType
* @return an ordered array of properties
*/
public static BeanPropertyDescriptor[] getPd(Class javaType) {
return getPd(javaType, null);
}
/**
* Create a BeanPropertyDescriptor array for the indicated class.
* @param javaType
* @param typeDesc
* @return an ordered array of properties
*/
public static BeanPropertyDescriptor[] getPd(Class javaType, TypeDesc typeDesc) {
BeanPropertyDescriptor[] pd;
try {
final Class secJavaType = javaType;
// Need doPrivileged access to do introspection.
PropertyDescriptor[] rawPd = getPropertyDescriptors(secJavaType);
pd = processPropertyDescriptors(rawPd,javaType,typeDesc);
} catch (Exception e) {
// this should never happen
throw new InternalException(e);
}
return pd;
}
private static PropertyDescriptor[] getPropertyDescriptors(final Class secJavaType) {
return (PropertyDescriptor[])AccessController.doPrivileged(
new PrivilegedAction() {
public Object run() {
PropertyDescriptor[] result = null;
try {
// privileged code goes here
Class superClass = secJavaType.getSuperclass();
if(superClass == Exception.class) {
result = Introspector.
getBeanInfo(secJavaType,Exception.class).
getPropertyDescriptors();
} else {
// privileged code goes here
result = Introspector.
getBeanInfo(secJavaType).
getPropertyDescriptors();
}
} catch (java.beans.IntrospectionException Iie) {
}
return result;
}
});
}
/**
* Return a list of properties in the bean which should be attributes
*/
public static Vector getBeanAttributes(Class javaType, TypeDesc typeDesc) {
Vector ret = new Vector();
if (typeDesc == null) {
// !!! Support old-style beanAttributeNames for now
// See if this object defined the 'getAttributeElements' function
// which returns a Vector of property names that are attributes
try {
Method getAttributeElements =
javaType.getMethod("getAttributeElements",
new Class [] {});
// get string array
String[] array = (String[])getAttributeElements.invoke(null, noArgs);
// convert it to a Vector
ret = new Vector(array.length);
for (int i = 0; i < array.length; i++) {
ret.add(array[i]);
}
} catch (Exception e) {
ret.clear();
}
} else {
FieldDesc [] fields = typeDesc.getFields();
if (fields != null) {
for (int i = 0; i < fields.length; i++) {
FieldDesc field = fields[i];
if (!field.isElement()) {
ret.add(field.getFieldName());
}
}
}
}
return ret;
}
/**
* This method attempts to sort the property descriptors using
* the typeDesc and order defined in the class.
*
* This routine also looks for set(i, type) and get(i) methods and adjusts the
* property to use these methods instead. These methods are generated by the
* emitter for "collection" of properties (i.e. maxOccurs="unbounded" on an element).
* JAX-RPC is silent on this issue, but web services depend on this kind of behaviour.
* The method signatures were chosen to match bean indexed properties.
*/
public static BeanPropertyDescriptor[] processPropertyDescriptors(
PropertyDescriptor[] rawPd, Class cls) {
return processPropertyDescriptors(rawPd, cls, null);
}
public static BeanPropertyDescriptor[] processPropertyDescriptors(
PropertyDescriptor[] rawPd, Class cls, TypeDesc typeDesc) {
// Create a copy of the rawPd called myPd
BeanPropertyDescriptor[] myPd = new BeanPropertyDescriptor[rawPd.length];
ArrayList pd = new ArrayList();
try {
for (int i=0; i < rawPd.length; i++) {
// Skip the special "any" field
if (rawPd[i].getName().equals(Constants.ANYCONTENT))
continue;
pd.add(new BeanPropertyDescriptor(rawPd[i]));
}
// Now look for public fields
Field fields[] = cls.getFields();
if (fields != null && fields.length > 0) {
// See if the field is in the list of properties
// add it if not.
for (int i=0; i < fields.length; i++) {
Field f = fields[i];
// skip field if it is final, transient, or static
if (!(Modifier.isStatic(f.getModifiers()) ||
Modifier.isFinal(f.getModifiers()) ||
Modifier.isTransient(f.getModifiers()))) {
String fName = f.getName();
boolean found = false;
for (int j=0; j< rawPd.length && !found; j++) {
String pName =
((BeanPropertyDescriptor)pd.get(j)).getName();
if (pName.length() == fName.length() &&
pName.substring(0,1).equalsIgnoreCase(
fName.substring(0,1))) {
found = pName.length() == 1 ||
pName.substring(1).equals(fName.substring(1));
}
}
if (!found) {
pd.add(new FieldPropertyDescriptor(f.getName(), f));
}
}
}
}
// If typeDesc meta data exists, re-order according to the fields
if (typeDesc != null &&
typeDesc.getFields() != null) {
ArrayList ordered = new ArrayList();
// Add the TypeDesc elements first
FieldDesc[] fds = typeDesc.getFields();
for (int i=0; i<fds.length; i++) {
FieldDesc field = fds[i];
if (field.isElement()) {
boolean found = false;
for (int j=0;
j<pd.size() && !found;
j++) {
if (field.getFieldName().equals(
((BeanPropertyDescriptor)pd.get(j)).getName())) {
ordered.add(pd.remove(j));
found = true;
}
}
}
}
// Add the remaining elements
while (pd.size() > 0) {
ordered.add(pd.remove(0));
}
// Use the ordered list
pd = ordered;
}
myPd = new BeanPropertyDescriptor[pd.size()];
for (int i=0; i <pd.size(); i++) {
myPd[i] = (BeanPropertyDescriptor) pd.get(i);
}
} catch (Exception e) {
log.error(JavaUtils.getMessage("badPropertyDesc00",
cls.getName()), e);
throw new InternalException(e);
}
return myPd;
}
public static BeanPropertyDescriptor getAnyContentPD(Class javaType) {
PropertyDescriptor [] pds = getPropertyDescriptors(javaType);
for (int i = 0; i < pds.length; i++) {
PropertyDescriptor pd = pds[i];
if (pd.getName().equals(Constants.ANYCONTENT))
return new BeanPropertyDescriptor(pd);
}
return null;
}
}