de.enflexit.common.bundleEvaluation

Class BundleEvaluator

java.lang.Object

de.enflexit.common.bundleEvaluation.BundleEvaluator

public class BundleEvaluator
extends java.lang.Object

The singleton class BundleEvaluator provides help methods to check bundle contents.

Method Summary

Modifier and Type	Method and Description
boolean	addBundleClassFilter(AbstractBundleClassFilter bundleClassFilter) Adds the specified bundle class filter and executes the needed, filter-specific search.
boolean	addBundleClassFilter(AbstractBundleClassFilter bundleClassFilter, boolean doBundleEvaluation) Adds the specified bundle class filter and executes the needed, filter-specific search.
void	addBusyMarkerToAllFilter(java.rmi.server.UID busyMarker) Adds the specified busy marker to all filter.
void	evaluateAllBundles() Searches in all current bundles with all class filters defined in evaluationFilterResults.
void	evaluateAllBundles(AbstractBundleClassFilter bundleClassFilterToUse) Searches all current bundles for specific classes.
void	evaluateBundle(org.osgi.framework.Bundle bundle, AbstractBundleClassFilter bundleClassFilterToUse) Searches / filters in the specified bundle for specific classes.
void	evaluateBundleInThread(org.osgi.framework.Bundle bundle, AbstractBundleClassFilter bundleClassFilterToUse) Searches / filters in the specified bundle for the classes that are specified by the bundle class filter.
java.lang.Class<?>	findClass(org.osgi.framework.Bundle bundle, java.lang.String className) Tries to find the specified class in the bundle.
AbstractBundleClassFilter	getBundleClassFilterByClass(java.lang.Class<?> classOfBundleFilter) Returns the bundle class filter by the class to search for.
org.osgi.framework.BundleContext	getBundleContext() Returns the current bundle context.
java.lang.String	getBundleDirectory(org.osgi.framework.Bundle bundle) Return the bundle directory.
org.osgi.framework.Bundle[]	getBundles() Returns all bundles that are currently loaded.
java.net.URL	getBundleURL(org.osgi.framework.Bundle bundle) Returns the bundle URL resolved by the FileLocator.
java.util.List<java.lang.Class<?>>	getClasses(org.osgi.framework.Bundle bundle) Returns the class references of the specified bundle (maybe quite time consuming).
java.util.List<java.lang.Class<?>>	getClasses(org.osgi.framework.Bundle bundle, java.lang.String packageFilter) Returns the class references of the specified bundle (may be quite time consuming, especially without package filter).
java.util.List<java.lang.Class<?>>	getClasses(org.osgi.framework.Bundle bundle, java.lang.String packageFilter, int options) Returns the class references of the specified bundle (may be quite time consuming, especially without package filter).
ClassLocaton	getClassLocation(java.lang.String className) Returns the ClassLocaton for the specified class name.
java.util.List<java.lang.String>	getClassReferences(org.osgi.framework.Bundle bundle) Returns the class references of the specified bundle (maybe quite time consuming).
java.util.List<java.lang.String>	getClassReferences(org.osgi.framework.Bundle bundle, java.lang.String packageFilter) Returns the class references of the specified bundle (maybe quite time consuming, especially without package filter).
java.lang.String	getFilePathFromURL(java.net.URL url) Returns the file path from the URL.
static BundleEvaluator	getInstance() Gets the single instance of BundleEvaluator.
java.util.List<java.lang.Class<?>>	getJarClasses(org.osgi.framework.Bundle bundle, java.io.File file) Loads and returns the classes from a jar file into the specified bundle.
java.util.List<java.lang.Class<?>>	getJarClasses(org.osgi.framework.Bundle bundle, java.net.URL jarFileURL) Loads and returns the classes from a jar file into the specified bundle.
java.util.List<java.lang.Class<?>>	getJarClassesByClassInstance(org.osgi.framework.Bundle bundle, java.lang.Class<?> classInstance) Loads and return the classes of a jar file that contains the specified class.
java.util.List<java.lang.String>	getJarClassReferences(org.osgi.framework.Bundle bundle, java.io.File file) Loads and returns the class references from a jar file into the specified bundle.
java.util.List<java.lang.String>	getJarClassReferences(org.osgi.framework.Bundle bundle, java.net.URL jarFileURL) Loads and returns the class references from a jar file into the specified bundle.
java.util.List<java.lang.String>	getPackages(org.osgi.framework.Bundle bundle) Returns the package names of the specified bundle.
java.util.List<java.lang.String>	getPackages(java.util.List<java.lang.Class<?>> classesList) Return the packages from the specified class list.
java.util.List<java.lang.String>	getPackagesOfClassNames(java.util.List<java.lang.String> classNameList) Return the packages from the specified class name list.
org.osgi.framework.Bundle	getSourceBundleOfClass(java.lang.Class<?> clazz) Returns the source bundle that loaded the specified class by using FrameworkUtil.getBundle(clazz);.
boolean	isJarBundle(org.osgi.framework.Bundle bundle) Checks if the specified Bundle is packed in a jar.
boolean	registerSearchThread(BundleEvaluatorThread bundleEvaluatorThread) Registers the specified BundleEvaluatorThread.
boolean	removeBundleClassFilter(AbstractBundleClassFilter bundleClassFilter) Removes the specified bundle class filter.
void	removeBusyMarkerFromAllFilter(java.rmi.server.UID busyMarker) Removes the specified busy marker from all filter.
void	removeEvaluationFilterResults(org.osgi.framework.Bundle bundle) Removes the evaluation filter results of the specified bundle.
void	setBundleAdded(org.osgi.framework.Bundle bundle) Sets that the specified bundle was added.
void	setBundleRemoved(org.osgi.framework.Bundle bundle) Sets that the specified bundle was removed.
void	unregisterSearchThread(BundleEvaluatorThread bundleEvaluatorThread) Unregister the specified BundleEvaluatorThread.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static BundleEvaluator getInstance()

Gets the single instance of BundleEvaluator.

Returns:

single instance of BundleEvaluator

setBundleAdded

public void setBundleAdded(org.osgi.framework.Bundle bundle)

Sets that the specified bundle was added.

Parameters:

bundle - the new bundle added

setBundleRemoved

public void setBundleRemoved(org.osgi.framework.Bundle bundle)

Sets that the specified bundle was removed.

Parameters:

bundle - the new bundle removed

addBundleClassFilter

public boolean addBundleClassFilter(AbstractBundleClassFilter bundleClassFilter)

Adds the specified bundle class filter and executes the needed, filter-specific search.

Parameters:

bundleClassFilter - the bundle class filter

Returns:

true, if the filter was added
false, if a filter with the same filter scope was already available.

addBundleClassFilter

public boolean addBundleClassFilter(AbstractBundleClassFilter bundleClassFilter,
                                    boolean doBundleEvaluation)

Adds the specified bundle class filter and executes the needed, filter-specific search.

Parameters:

bundleClassFilter - the bundle class filter

doBundleEvaluation - set true, if you want to directly evaluate all bundles with the current filter

Returns:

true, if the filter was added
false, if a filter with the same filter scope was already available.

removeBundleClassFilter

public boolean removeBundleClassFilter(AbstractBundleClassFilter bundleClassFilter)

Removes the specified bundle class filter.

Parameters:

bundleClassFilter - the bundle class filter

Returns:

true, if successful

getBundleClassFilterByClass

public AbstractBundleClassFilter getBundleClassFilterByClass(java.lang.Class<?> classOfBundleFilter)

Returns the bundle class filter by the class to search for.

Parameters:

classOfBundleFilter - the class of bundle filter

Returns:

the bundle class filter by class

removeEvaluationFilterResults

public void removeEvaluationFilterResults(org.osgi.framework.Bundle bundle)

Removes the evaluation filter results of the specified bundle.

Parameters:

bundle - the bundle from which the results have to be removed

getClassLocation

public ClassLocaton getClassLocation(java.lang.String className)

Returns the ClassLocaton for the specified class name.

Parameters:

className - the class name

Returns:

the class location

addBusyMarkerToAllFilter

public void addBusyMarkerToAllFilter(java.rmi.server.UID busyMarker)

Adds the specified busy marker to all filter.

Parameters:

busyMarker - the busy marker

removeBusyMarkerFromAllFilter

public void removeBusyMarkerFromAllFilter(java.rmi.server.UID busyMarker)

Removes the specified busy marker from all filter.

Parameters:

busyMarker - the busy marker

getBundleContext

public org.osgi.framework.BundleContext getBundleContext()

Returns the current bundle context.

Returns:

the bundle context

getBundles

public org.osgi.framework.Bundle[] getBundles()

Returns all bundles that are currently loaded.

Returns:

the bundle array

evaluateAllBundles

public void evaluateAllBundles()

Searches in all current bundles with all class filters defined in evaluationFilterResults.

evaluateAllBundles

public void evaluateAllBundles(AbstractBundleClassFilter bundleClassFilterToUse)

Searches all current bundles for specific classes. If the the parameter bundleClassFilterToUse is specified, only this filter will be used. If this parameter is null, all class filters defined in evaluationFilterResults will be applied.

Parameters:

bundleClassFilterToUse - the bundle class filter to exclusively search with (null IS permitted).

evaluateBundleInThread

public void evaluateBundleInThread(org.osgi.framework.Bundle bundle,
                                   AbstractBundleClassFilter bundleClassFilterToUse)

Searches / filters in the specified bundle for the classes that are specified by the bundle class filter.

Parameters:

bundle - the bundle to search in (null is NOT permitted)

bundleClassFilterToUse - the bundle class filter to exclusively search with (null IS permitted).

See Also:

getEvaluationFilterResults()

registerSearchThread

public boolean registerSearchThread(BundleEvaluatorThread bundleEvaluatorThread)

Registers the specified BundleEvaluatorThread.

Parameters:

bundleEvaluatorThread - the bundle evaluator thread

Returns:

true, if successful

unregisterSearchThread

public void unregisterSearchThread(BundleEvaluatorThread bundleEvaluatorThread)

Unregister the specified BundleEvaluatorThread.

Parameters:

bundleEvaluatorThread - the bundle evaluator thread

evaluateBundle

public void evaluateBundle(org.osgi.framework.Bundle bundle,
                           AbstractBundleClassFilter bundleClassFilterToUse)

Searches / filters in the specified bundle for specific classes.
If the the parameter bundleClassFilterToUse is specified, only this filter will be used. If this parameter is null, all class filters defined in evaluationFilterResults will be applied.

Parameters:

bundle - the bundle to search in (null is NOT permitted)

bundleClassFilterToUse - the bundle class filter to exclusively search with (null IS permitted).

See Also:

getEvaluationFilterResults()

getClasses

public java.util.List<java.lang.Class<?>> getClasses(org.osgi.framework.Bundle bundle)

Returns the class references of the specified bundle (maybe quite time consuming).

Parameters:

bundle - the bundle to evaluate

Returns:

the list of classes

getClasses

public java.util.List<java.lang.Class<?>> getClasses(org.osgi.framework.Bundle bundle,
                                                     java.lang.String packageFilter)

Returns the class references of the specified bundle (may be quite time consuming, especially without package filter).

Parameters:

bundle - the bundle to evaluate

packageFilter - the package filter; maybe null, which will return all classes from the bundle

options - the options according to the BundleWiring that are BundleWiring.LISTRESOURCES_RECURSE, BundleWiring.LISTRESOURCES_LOCAL or BundleWiring.FINDENTRIES_RECURSE

Returns:

the list of classes

getClasses

public java.util.List<java.lang.Class<?>> getClasses(org.osgi.framework.Bundle bundle,
                                                     java.lang.String packageFilter,
                                                     int options)

Returns the class references of the specified bundle (may be quite time consuming, especially without package filter).

Parameters:

bundle - the bundle to evaluate

packageFilter - the package filter; maybe null, which will return all classes from the bundle

options - the options according to the BundleWiring that are BundleWiring.LISTRESOURCES_RECURSE, BundleWiring.LISTRESOURCES_LOCAL or BundleWiring.FINDENTRIES_RECURSE

Returns:

the list of classes

getClassReferences

public java.util.List<java.lang.String> getClassReferences(org.osgi.framework.Bundle bundle)

Returns the class references of the specified bundle (maybe quite time consuming).

Parameters:

bundle - the bundle

Returns:

the list of class references

getClassReferences

public java.util.List<java.lang.String> getClassReferences(org.osgi.framework.Bundle bundle,
                                                           java.lang.String packageFilter)

Returns the class references of the specified bundle (maybe quite time consuming, especially without package filter).

Parameters:

bundle - the bundle

packageFilter - the package filter; maybe null, which will return all classes from the bundle

Returns:

the list of class references

getPackages

public java.util.List<java.lang.String> getPackages(org.osgi.framework.Bundle bundle)

Returns the package names of the specified bundle.

Parameters:

bundle - the bundle

Returns:

the packages

getPackages

public java.util.List<java.lang.String> getPackages(java.util.List<java.lang.Class<?>> classesList)

Return the packages from the specified class list.

Parameters:

classList - the class list

Returns:

the packages

getPackagesOfClassNames

public java.util.List<java.lang.String> getPackagesOfClassNames(java.util.List<java.lang.String> classNameList)

Return the packages from the specified class name list.

Parameters:

classList - the class list

Returns:

the packages

getJarClassesByClassInstance

public java.util.List<java.lang.Class<?>> getJarClassesByClassInstance(org.osgi.framework.Bundle bundle,
                                                                       java.lang.Class<?> classInstance)

Loads and return the classes of a jar file that contains the specified class.

Parameters:

bundle - the bundle

classInstance - the instance

Returns:

the jar classes by object instance

getJarClasses

public java.util.List<java.lang.Class<?>> getJarClasses(org.osgi.framework.Bundle bundle,
                                                        java.io.File file)

Loads and returns the classes from a jar file into the specified bundle.

Parameters:

bundle - the bundle

file - the file

Returns:

the jar classes

getJarClasses

public java.util.List<java.lang.Class<?>> getJarClasses(org.osgi.framework.Bundle bundle,
                                                        java.net.URL jarFileURL)

Loads and returns the classes from a jar file into the specified bundle.

Parameters:

bundle - the bundle

file - the file

Returns:

the jar classes

getJarClassReferences

public java.util.List<java.lang.String> getJarClassReferences(org.osgi.framework.Bundle bundle,
                                                              java.io.File file)

Loads and returns the class references from a jar file into the specified bundle.

Parameters:

bundle - the bundle

file - the file

Returns:

the jar classes

getJarClassReferences

public java.util.List<java.lang.String> getJarClassReferences(org.osgi.framework.Bundle bundle,
                                                              java.net.URL jarFileURL)

Loads and returns the class references from a jar file into the specified bundle.

Parameters:

bundle - the bundle

file - the file

Returns:

the jar classes

getFilePathFromURL

public java.lang.String getFilePathFromURL(java.net.URL url)

Returns the file path from the URL.

Parameters:

url - the URL

Returns:

the file path from URL

getBundleURL

public java.net.URL getBundleURL(org.osgi.framework.Bundle bundle)

Returns the bundle URL resolved by the FileLocator.

Parameters:

bundle - the bundle

Returns:

the bundle URL

isJarBundle

public boolean isJarBundle(org.osgi.framework.Bundle bundle)

Checks if the specified Bundle is packed in a jar.

Parameters:

bundle - the bundle

Returns:

true, if is jar bundle

getBundleDirectory

public java.lang.String getBundleDirectory(org.osgi.framework.Bundle bundle)

Return the bundle directory.

Parameters:

bundle - the bundle

Returns:

the bundle directory

getSourceBundleOfClass

public org.osgi.framework.Bundle getSourceBundleOfClass(java.lang.Class<?> clazz)

Returns the source bundle that loaded the specified class by using FrameworkUtil.getBundle(clazz);.

Parameters:

clazz - the class instance

Returns:

the bundle from class

findClass

public java.lang.Class<?> findClass(org.osgi.framework.Bundle bundle,
                                    java.lang.String className)

Tries to find the specified class in the bundle. If the class could not be found, the method returns null.

Parameters:

bundle - the bundle in which the class should be located

className - the class name

Returns:

the class or null