165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn/* 265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Copyright (C) 2011 The Android Open Source Project 365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * 465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Licensed under the Apache License, Version 2.0 (the "License"); 565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * you may not use this file except in compliance with the License. 665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * You may obtain a copy of the License at 765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * 865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * http://www.apache.org/licenses/LICENSE-2.0 965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * 1065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Unless required by applicable law or agreed to in writing, software 1165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * distributed under the License is distributed on an "AS IS" BASIS, 1265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 1365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * See the License for the specific language governing permissions and 1465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * limitations under the License. 1565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 1665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 1765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 1865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennpackage android.filterfw.core; 1965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 2065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport android.filterfw.core.Filter; 2165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport android.util.Log; 2265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 2365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport dalvik.system.PathClassLoader; 2465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 2565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport java.lang.reflect.Constructor; 2665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport java.lang.ClassLoader; 2765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport java.lang.Thread; 2865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennimport java.util.HashSet; 2965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 3065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn/** 3165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * @hide 3265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 3365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Rennpublic class FilterFactory { 3465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 3565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn private static FilterFactory mSharedFactory; 3665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn private HashSet<String> mPackages = new HashSet<String>(); 3765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 3865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn private static ClassLoader mCurrentClassLoader; 3965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn private static HashSet<String> mLibraries; 4065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn private static Object mClassLoaderGuard; 4165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 4265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn static { 4365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mCurrentClassLoader = Thread.currentThread().getContextClassLoader(); 4465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mLibraries = new HashSet<String>(); 4565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mClassLoaderGuard = new Object(); 4665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 4765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 4865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn private static final String TAG = "FilterFactory"; 4965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn private static boolean mLogVerbose = Log.isLoggable(TAG, Log.VERBOSE); 5065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 5165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public static FilterFactory sharedFactory() { 5265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (mSharedFactory == null) { 5365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mSharedFactory = new FilterFactory(); 5465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 5565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn return mSharedFactory; 5665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 5765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 5865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /** 5965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * Adds a new Java library to the list to be scanned for filters. 6065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * libraryPath must be an absolute path of the jar file. This needs to be 6165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * static because only one classloader per process can open a shared native 6265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn * library, which a filter may well have. 6365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 6465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public static void addFilterLibrary(String libraryPath) { 6565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (mLogVerbose) Log.v(TAG, "Adding filter library " + libraryPath); 6665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn synchronized(mClassLoaderGuard) { 6765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (mLibraries.contains(libraryPath)) { 6865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (mLogVerbose) Log.v(TAG, "Library already added"); 6965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn return; 7065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 7165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mLibraries.add(libraryPath); 7265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn // Chain another path loader to the current chain 7365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mCurrentClassLoader = new PathClassLoader(libraryPath, mCurrentClassLoader); 7465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 7565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 7665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 7765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public void addPackage(String packageName) { 7865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (mLogVerbose) Log.v(TAG, "Adding package " + packageName); 7965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn /* TODO: This should use a getPackage call in the caller's context, but no such method exists. 8065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn Package pkg = Package.getPackage(packageName); 8165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (pkg == null) { 8265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn throw new IllegalArgumentException("Unknown filter package '" + packageName + "'!"); 8365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 8465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn */ 8565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn mPackages.add(packageName); 8665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 8765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 8865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public Filter createFilterByClassName(String className, String filterName) { 8965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (mLogVerbose) Log.v(TAG, "Looking up class " + className); 9065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn Class filterClass = null; 9165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 9265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn // Look for the class in the imported packages 9365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn for (String packageName : mPackages) { 9465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn try { 9565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (mLogVerbose) Log.v(TAG, "Trying "+packageName + "." + className); 9665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn synchronized(mClassLoaderGuard) { 9765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn filterClass = mCurrentClassLoader.loadClass(packageName + "." + className); 9865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 9965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } catch (ClassNotFoundException e) { 10065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn continue; 10165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 10265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn // Exit loop if class was found. 10365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (filterClass != null) { 10465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn break; 10565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 10665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 10765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (filterClass == null) { 10865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn throw new IllegalArgumentException("Unknown filter class '" + className + "'!"); 10965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 11065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn return createFilterByClass(filterClass, filterName); 11165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 11265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 11365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn public Filter createFilterByClass(Class filterClass, String filterName) { 11465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn // Make sure this is a Filter subclass 11565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn try { 11665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn filterClass.asSubclass(Filter.class); 11765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } catch (ClassCastException e) { 11865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn throw new IllegalArgumentException("Attempting to allocate class '" + filterClass 11965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn + "' which is not a subclass of Filter!"); 12065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 12165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 12265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn // Look for the correct constructor 12365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn Constructor filterConstructor = null; 12465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn try { 12565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn filterConstructor = filterClass.getConstructor(String.class); 12665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } catch (NoSuchMethodException e) { 12765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn throw new IllegalArgumentException("The filter class '" + filterClass 12865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn + "' does not have a constructor of the form <init>(String name)!"); 12965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 13065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 13165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn // Construct the filter 13265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn Filter filter = null; 13365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn try { 13465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn filter = (Filter)filterConstructor.newInstance(filterName); 13565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } catch (Throwable t) { 13665953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn // Condition checked below 13765953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 13865953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn 13965953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn if (filter == null) { 14065953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn throw new IllegalArgumentException("Could not construct the filter '" 14165953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn + filterName + "'!"); 14265953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 14365953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn return filter; 14465953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn } 14565953da4636fbf5f0a24b8f5f2b5fa7d76ff13d9Marius Renn} 146