All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.cxf.common.util.ReflectionUtil Maven / Gradle / Ivy

There is a newer version: 2.7.18
Show newest version
/**
 * 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.cxf.common.util;

import java.beans.BeanInfo;
import java.beans.PropertyDescriptor;
import java.io.File;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.lang.reflect.AccessibleObject;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.security.AccessController;
import java.security.PrivilegedAction;
import java.security.PrivilegedActionException;
import java.security.PrivilegedExceptionAction;
import java.util.ArrayList;
import java.util.List;

import org.apache.cxf.common.classloader.ClassLoaderUtils;

public final class ReflectionUtil {
    
    private static Method springBeanUtilsDescriptorFetcher; 
    private static boolean springChecked;
    
    private ReflectionUtil() {
        // intentionally empty
    }
    
    public static  T accessDeclaredField(final Field f, final Object o, final Class responseClass) {
        return AccessController.doPrivileged(new PrivilegedAction() {
            public T run() {
                try {
                    f.setAccessible(true);
                    return responseClass.cast(f.get(o));
                } catch (SecurityException e) {
                    return null;
                } catch (IllegalAccessException e) {
                    return null;
                } finally {
                    f.setAccessible(false);
                }
            }
        });
    }
    
    public static Field getDeclaredField(final Class cls, final String name) {
        return AccessController.doPrivileged(new PrivilegedAction() {
            public Field run() {
                try {
                    return cls.getDeclaredField(name);
                } catch (SecurityException e) {
                    return null;
                } catch (NoSuchFieldException e) {
                    return null;
                }
            }
        });
    }

    public static  Constructor getDeclaredConstructor(final Class cls, final Class ... args) {
        return AccessController.doPrivileged(new PrivilegedAction>() {
            public Constructor run() {
                try {
                    return cls.getDeclaredConstructor(args);
                } catch (SecurityException e) {
                    return null;
                } catch (NoSuchMethodException e) {
                    return null;
                }
            }
        });
        
    }
    public static  Constructor getConstructor(final Class cls, final Class ... args) {
        return AccessController.doPrivileged(new PrivilegedAction>() {
            public Constructor run() {
                try {
                    return cls.getConstructor(args);
                } catch (SecurityException e) {
                    return null;
                } catch (NoSuchMethodException e) {
                    return null;
                }
            }
        });
        
    }
    
    public static Method[] getDeclaredMethods(final Class cls) {
        return AccessController.doPrivileged(new PrivilegedAction() {
            public Method[] run() {
                return cls.getDeclaredMethods();
            }
        });
    }

    public static Method getDeclaredMethod(final Class clazz, final String name,
                                            final Class... parameterTypes) throws NoSuchMethodException {
        try {
            return AccessController.doPrivileged(new PrivilegedExceptionAction() {
                public Method run() throws Exception {
                    return clazz.getDeclaredMethod(name, parameterTypes);
                }
            });
        } catch (PrivilegedActionException pae) {
            Exception e = pae.getException();
            if (e instanceof NoSuchMethodException) {
                throw (NoSuchMethodException)e;
            } else {
                throw new SecurityException(e);
            }
        }
    }

    public static Field[] getDeclaredFields(final Class cls) {
        return AccessController.doPrivileged(new PrivilegedAction() {
            public Field[] run() {
                return cls.getDeclaredFields();
            }
        });
    }

    public static  T setAccessible(final T o) {
        return AccessController.doPrivileged(new PrivilegedAction() {
            public T run() {
                o.setAccessible(true);
                return o;
            }
        });
    }
    public static  T setAccessible(final T o, final boolean b) {
        return AccessController.doPrivileged(new PrivilegedAction() {
            public T run() {
                o.setAccessible(b);
                return o;
            }
        });
    }
    public static List getPackagesFromJar(File jarFile) throws IOException {
        List packageNames = new ArrayList();
        if (jarFile.isDirectory()) {
            getPackageNamesFromDir(jarFile, jarFile, packageNames);
        } else {
            JarResource resource = new JarResource();
            for (String item : resource.getJarContents(jarFile)) {
                if (!item.endsWith(".class")) {
                    continue;
                }
                String packageName = getPackageName(item);
                if (!StringUtils.isEmpty(packageName)
                    && !packageNames.contains(packageName)) {
                    packageNames.add(packageName);
                }
            }
        }
        return packageNames;
    }
    
    private static void getPackageNamesFromDir(File base, File dir, List pkgs) {
        boolean foundClass = false;
        for (File file : dir.listFiles()) {
            if (file.isDirectory()) {
                getPackageNamesFromDir(base, file, pkgs);
            } else if (!foundClass && file.getName().endsWith(".class")) {
                foundClass = true;
                String pkg = "";
                file = dir;
                while (!file.equals(base)) {
                    if (!"".equals(pkg)) {
                        pkg = "." + pkg;
                    }
                    pkg = file.getName() + pkg;
                    file = file.getParentFile();
                }
                if (!pkgs.contains(pkg)) {
                    pkgs.add(pkg);
                }
            }
        }
    }

    private static String getPackageName(String clzName) {
        if (clzName.indexOf("/") == -1) {
            return null;
        }
        String packageName = clzName.substring(0, clzName.lastIndexOf("/"));
        return packageName.replace("/", ".");
    }
    
    /**
     *  create own array of property descriptors to:
     *  
     *  - prevent memory leaks by Introspector's cache
     *  - get correct type for generic properties from superclass
     *     that are limited to a specific type in beanClass
     *    see http://bugs.sun.com/view_bug.do?bug_id=6528714
     *   we cannot use BeanUtils.getPropertyDescriptors because of issue SPR-6063
     *   
* @param refClass calling class for class loading. * @param beanInfo Bean in question * @param beanClass class for bean in question * @param propertyDescriptors raw descriptors */ public static PropertyDescriptor[] getPropertyDescriptorsAvoidSunBug(Class refClass, BeanInfo beanInfo, Class beanClass, PropertyDescriptor[] propertyDescriptors) { if (!springChecked) { try { springChecked = true; Class cls = ClassLoaderUtils .loadClass("org.springframework.beans.BeanUtils", refClass); springBeanUtilsDescriptorFetcher = cls.getMethod("getPropertyDescriptor", new Class[] {Class.class, String.class}); } catch (Exception e) { //ignore - just assume it's an unsupported/unknown annotation } } if (springBeanUtilsDescriptorFetcher != null) { if (propertyDescriptors != null) { List descriptors = new ArrayList(propertyDescriptors.length); for (int i = 0; i < propertyDescriptors.length; i++) { PropertyDescriptor propertyDescriptor = propertyDescriptors[i]; try { propertyDescriptor = (PropertyDescriptor)springBeanUtilsDescriptorFetcher.invoke(null, beanClass, propertyDescriptor.getName()); if (propertyDescriptor != null) { descriptors.add(propertyDescriptor); } } catch (IllegalArgumentException e) { throw new RuntimeException(e); } catch (IllegalAccessException e) { throw new RuntimeException(e); } catch (InvocationTargetException e) { throw new RuntimeException(e.getCause()); } } return descriptors.toArray(new PropertyDescriptor[descriptors.size()]); } return null; } else { return beanInfo.getPropertyDescriptors(); } } /** * Try to find a method we can use. If the object implements a public * interface that has the public version of that method, we'll use the interface * defined method in case the actual instance class is not public */ public static Method findMethod(Class cls, String name, Class ... params) { if (cls == null) { return null; } for (Class cs : cls.getInterfaces()) { if (Modifier.isPublic(cs.getModifiers())) { Method m = findMethod(cs, name, params); if (m != null && Modifier.isPublic(m.getModifiers())) { return m; } } } try { Method m = cls.getDeclaredMethod(name, params); if (m != null && Modifier.isPublic(m.getModifiers())) { return m; } } catch (Exception e) { //ignore } Method m = findMethod(cls.getSuperclass(), name, params); if (m == null) { try { m = cls.getMethod(name, params); } catch (Exception e) { //ignore } } return m; } /** * Look for a specified annotation on a method. If there, return it. If not, search it's containing class. * Assume that the annotation is marked @Inherited. * * @param m method to examine * @param annotationType the annotation type to look for. */ public static T getAnnotationForMethodOrContainingClass(Method m, Class annotationType) { T annotation = m.getAnnotation(annotationType); if (annotation != null) { return annotation; } return m.getDeclaringClass().getAnnotation(annotationType); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy