org.eclipse.gemini.blueprint.io

Class OsgiBundleResourcePatternResolver

java.lang.Object

org.springframework.core.io.support.PathMatchingResourcePatternResolver

org.eclipse.gemini.blueprint.io.OsgiBundleResourcePatternResolver

All Implemented Interfaces:

org.springframework.core.io.ResourceLoader, org.springframework.core.io.support.ResourcePatternResolver

public class OsgiBundleResourcePatternResolver
extends org.springframework.core.io.support.PathMatchingResourcePatternResolver

OSGi-aware ResourcePatternResolver. Can find resources in the bundle jar and bundle space. See OsgiBundleResource for more information.

ClassPath support

As mentioned by PathMatchingResourcePatternResolver, class-path pattern matching needs to resolve the class-path structure to a file-system location (be it an actual folder or a jar). Inside the OSGi environment this is problematic as the bundles can be loaded in memory directly from input streams. To avoid relying on each platform bundle storage structure, this implementation tries to determine the bundles that assemble the given bundle class-path and analyze each of them individually. This involves the bundle archive (including special handling of the Bundle-Classpath as it is computed at runtime), the bundle required packages and its attached fragments. Depending on the configuration of running environment, this might cause significant IO activity which can affect performance.

Note: Currently, static imports as well as Bundle-Classpath and Required-Bundle entries are supported. Support for DynamicPackage-Import depends on how/when the underlying platform does the wiring between the dynamically imported bundle and the given bundle.

Portability Note: Since it relies only on the OSGi API, this implementation depends heavily on how closely the platform implements the OSGi spec. While significant tests have been made to ensure compatibility, one might experience different behaviour especially when dealing with jars with missing folder entries or boot-path delegation. It is strongly recommended that wildcard resolution be thoroughly tested before switching to a different platform before you rely on it.

See Also:

Bundle, OsgiBundleResource, PathMatchingResourcePatternResolver

Field Summary

Fields

Modifier and Type	Field and Description
private org.osgi.framework.Bundle	bundle The bundle on which this resolver works on.
private static java.lang.String	BUNDLE_DEFAULT_CP
private org.osgi.framework.BundleContext	bundleContext The bundle context associated with this bundle.
private static char	DOT
private static java.lang.String	FOLDER_SEPARATOR
private static java.lang.String	FOLDER_WILDCARD
private static java.lang.String	JAR_EXTENSION
private static org.apache.commons.logging.Log	logger Our own logger to protect against incompatible class changes.
private DependencyResolver	resolver
private static char	SLASH

Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver

CLASSPATH_ALL_URL_PREFIX

Fields inherited from interface org.springframework.core.io.ResourceLoader

CLASSPATH_URL_PREFIX

Constructor Summary

Constructors

Constructor and Description
OsgiBundleResourcePatternResolver(org.osgi.framework.Bundle bundle)
OsgiBundleResourcePatternResolver(org.springframework.core.io.ResourceLoader resourceLoader)

Method Summary

Modifier and Type	Method and Description
private org.springframework.core.io.ContextResource[]	convertURLEnumerationToResourceArray(java.util.Enumeration<java.net.URL> enm, java.lang.String path)
private java.lang.String	determineFolderPattern(java.lang.String path)
private java.util.Set<org.springframework.core.io.Resource>	doFindPathMatchingFileResources(org.springframework.core.io.Resource rootDirResource, java.lang.String subPattern, int searchType) Based on the search type, uses the appropriate searching method.
private void	doRetrieveMatchingBundleEntries(org.osgi.framework.Bundle bundle, java.lang.String fullPattern, java.lang.String dir, java.util.Set<org.springframework.core.io.Resource> result, int searchType) Searches each level inside the bundle for entries based on the search strategy chosen.
private void	findBundleClassPathMatchingFolders(java.util.List<java.lang.String> list, org.osgi.framework.Bundle bundle, java.lang.String cpEntryPath, java.lang.String pattern) Checks the folder entries from the Bundle-Classpath for the given pattern.
private void	findBundleClassPathMatchingJarEntries(java.util.List<java.lang.String> list, java.net.URL url, java.lang.String pattern) Checks the jar entries from the Bundle-Classpath for the given pattern.
private java.util.Collection<java.lang.String>	findBundleClassPathMatchingPaths(org.osgi.framework.Bundle bundle, java.lang.String pattern) Searches the bundle classpath (Bundle-Classpath) entries for the given pattern.
private org.springframework.core.io.Resource[]	findClassPathMatchingResources(java.lang.String locationPattern, int type) Special classpath method.
private void	findImportedBundleMatchingResource(ImportedBundle importedBundle, java.lang.String rootPath, java.lang.String path, java.util.Collection<java.lang.String> foundPaths) Searches for the given pattern inside the imported bundle.
private org.springframework.core.io.Resource[]	findPathMatchingResources(java.lang.String locationPattern, int searchType) Replace the super class implementation to pass in the searchType parameter.
protected org.springframework.core.io.Resource[]	findResources(java.lang.String locationPattern) Finds existing resources.
private void	findSyntheticClassPathMatchingResource(org.osgi.framework.Bundle bundle, java.lang.String path, java.util.Collection<java.lang.String> foundPaths) Applies synthetic class-path analysis.
org.springframework.core.io.Resource[]	getResources(java.lang.String locationPattern)
private java.lang.String	handleString(java.lang.String path) Handles candidates returned as Strings.
private java.lang.String	handleURL(java.net.URL path) Handles candidates returned as URLs.
protected boolean	isJarResource(org.springframework.core.io.Resource resource) Overrides the default check up since computing the URL can be fairly expensive operation as there is no caching (due to the framework dynamic nature).

Methods inherited from class org.springframework.core.io.support.PathMatchingResourcePatternResolver

convertClassLoaderURL, determineRootDir, doFindMatchingFileSystemResources, doFindPathMatchingFileResources, doFindPathMatchingJarResources, doRetrieveMatchingFiles, findAllClassPathResources, findPathMatchingResources, getClassLoader, getJarFile, getPathMatcher, getResource, getResourceLoader, resolveRootDirResource, retrieveMatchingFiles, setPathMatcher

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.apache.commons.logging.Log logger

Our own logger to protect against incompatible class changes.

bundle

private final org.osgi.framework.Bundle bundle

The bundle on which this resolver works on.

bundleContext

private final org.osgi.framework.BundleContext bundleContext

The bundle context associated with this bundle.

FOLDER_SEPARATOR

private static final java.lang.String FOLDER_SEPARATOR

See Also:

Constant Field Values

FOLDER_WILDCARD

private static final java.lang.String FOLDER_WILDCARD

See Also:

Constant Field Values

JAR_EXTENSION

private static final java.lang.String JAR_EXTENSION

See Also:

Constant Field Values

BUNDLE_DEFAULT_CP

private static final java.lang.String BUNDLE_DEFAULT_CP

See Also:

Constant Field Values

SLASH

private static final char SLASH

See Also:

Constant Field Values

DOT

private static final char DOT

See Also:

Constant Field Values

resolver

private final DependencyResolver resolver

Constructor Detail

OsgiBundleResourcePatternResolver

public OsgiBundleResourcePatternResolver(org.osgi.framework.Bundle bundle)

OsgiBundleResourcePatternResolver

public OsgiBundleResourcePatternResolver(org.springframework.core.io.ResourceLoader resourceLoader)

Method Detail

findResources

protected org.springframework.core.io.Resource[] findResources(java.lang.String locationPattern)
                                                        throws java.io.IOException

Finds existing resources. This method returns the actual resources found w/o adding any extra decoration (such as non-existing resources).

Parameters:

locationPattern - location pattern

Returns:

found resources (w/o any decoration)

Throws:

java.io.IOException - in case of I/O errors

getResources

public org.springframework.core.io.Resource[] getResources(java.lang.String locationPattern)
                                                    throws java.io.IOException

Specified by:

getResources in interface org.springframework.core.io.support.ResourcePatternResolver

Overrides:

getResources in class org.springframework.core.io.support.PathMatchingResourcePatternResolver

Throws:

java.io.IOException

findClassPathMatchingResources

private org.springframework.core.io.Resource[] findClassPathMatchingResources(java.lang.String locationPattern,
                                                                              int type)
                                                                       throws java.io.IOException

Special classpath method. Will try to detect the imported bundles (which are part of the classpath) and look for resources in all of them. This implementation will try to determine the bundles that compose the current bundle classpath and then it will inspect the bundle space of each of them individually.

Since the bundle space is considered, runtime classpath entries such as dynamic imports are not supported (yet).

Parameters:

locationPattern -

type -

Returns:

classpath resources

Throws:

java.io.IOException

determineFolderPattern

private java.lang.String determineFolderPattern(java.lang.String path)

convertURLEnumerationToResourceArray

private org.springframework.core.io.ContextResource[] convertURLEnumerationToResourceArray(java.util.Enumeration<java.net.URL> enm,
                                                                                           java.lang.String path)

findImportedBundleMatchingResource

private void findImportedBundleMatchingResource(ImportedBundle importedBundle,
                                                java.lang.String rootPath,
                                                java.lang.String path,
                                                java.util.Collection<java.lang.String> foundPaths)
                                         throws java.io.IOException

Searches for the given pattern inside the imported bundle. This translates to pattern matching on the imported packages.

Parameters:

importedBundle - imported bundle

path - path used for pattern matching

foundPaths - collection of found results

Throws:

java.io.IOException

findSyntheticClassPathMatchingResource

private void findSyntheticClassPathMatchingResource(org.osgi.framework.Bundle bundle,
                                                    java.lang.String path,
                                                    java.util.Collection<java.lang.String> foundPaths)
                                             throws java.io.IOException

Applies synthetic class-path analysis. That is, search the bundle space and the bundle class-path for entries matching the given path.

Parameters:

bundle -

path -

foundPaths -

Throws:

java.io.IOException

findBundleClassPathMatchingPaths

private java.util.Collection<java.lang.String> findBundleClassPathMatchingPaths(org.osgi.framework.Bundle bundle,
                                                                                java.lang.String pattern)
                                                                         throws java.io.IOException

Searches the bundle classpath (Bundle-Classpath) entries for the given pattern.

Parameters:

bundle -

pattern -

Returns:

Throws:

java.io.IOException

findBundleClassPathMatchingJarEntries

private void findBundleClassPathMatchingJarEntries(java.util.List<java.lang.String> list,
                                                   java.net.URL url,
                                                   java.lang.String pattern)
                                            throws java.io.IOException

Checks the jar entries from the Bundle-Classpath for the given pattern.

Parameters:

list -

ur -

Throws:

java.io.IOException

findBundleClassPathMatchingFolders

private void findBundleClassPathMatchingFolders(java.util.List<java.lang.String> list,
                                                org.osgi.framework.Bundle bundle,
                                                java.lang.String cpEntryPath,
                                                java.lang.String pattern)
                                         throws java.io.IOException

Checks the folder entries from the Bundle-Classpath for the given pattern.

Parameters:

list -

bundle -

cpEntryPath -

pattern -

Throws:

java.io.IOException

findPathMatchingResources

private org.springframework.core.io.Resource[] findPathMatchingResources(java.lang.String locationPattern,
                                                                         int searchType)
                                                                  throws java.io.IOException

Replace the super class implementation to pass in the searchType parameter.

Throws:

java.io.IOException

See Also:

PathMatchingResourcePatternResolver.findPathMatchingResources(String)

isJarResource

protected boolean isJarResource(org.springframework.core.io.Resource resource)
                         throws java.io.IOException

Overrides the default check up since computing the URL can be fairly expensive operation as there is no caching (due to the framework dynamic nature).

Overrides:

isJarResource in class org.springframework.core.io.support.PathMatchingResourcePatternResolver

Throws:

java.io.IOException

doFindPathMatchingFileResources

private java.util.Set<org.springframework.core.io.Resource> doFindPathMatchingFileResources(org.springframework.core.io.Resource rootDirResource,
                                                                                            java.lang.String subPattern,
                                                                                            int searchType)
                                                                                     throws java.io.IOException

Based on the search type, uses the appropriate searching method.

Throws:

java.io.IOException

See Also:

OsgiBundleResource.BUNDLE_URL_PREFIX, PathMatchingResourcePatternResolver.getResources(java.lang.String)

doRetrieveMatchingBundleEntries

private void doRetrieveMatchingBundleEntries(org.osgi.framework.Bundle bundle,
                                             java.lang.String fullPattern,
                                             java.lang.String dir,
                                             java.util.Set<org.springframework.core.io.Resource> result,
                                             int searchType)
                                      throws java.io.IOException

Searches each level inside the bundle for entries based on the search strategy chosen.

Parameters:

bundle - the bundle to do the lookup

fullPattern - matching pattern

dir - directory inside the bundle

result - set of results (used to concatenate matching sub dirs)

searchType - the search strategy to use

Throws:

java.io.IOException

handleURL

private java.lang.String handleURL(java.net.URL path)

Handles candidates returned as URLs.

Parameters:

path -

Returns:

handleString

private java.lang.String handleString(java.lang.String path)

Handles candidates returned as Strings.

Parameters:

path -

Returns: