org.jahia.osgi

Class BundleUtils

java.lang.Object

org.jahia.osgi.BundleUtils

public final class BundleUtils
extends Object

Convenient utilities for Jahia OSGi bundles.

Author:

Sergiy Shyrkov

Constructor Summary

Constructors

Constructor and Description
BundleUtils()

Method Summary

Modifier and Type	Method and Description
static String	bundleEventToString(int eventType) Returns a String representation for the given bundle event.
static ClassLoader	createBundleClassLoader(org.osgi.framework.Bundle bundle) Creates an instance of the BundleDelegatingClassLoader baked by the provided bundle and having Jahia root Spring context's class loader as a parent.
static org.osgi.framework.Bundle	getBundle(long id) Returns the bundle with the specified identifier.
static org.osgi.framework.Bundle	getBundle(String location) Finds bundle by its location.
static org.osgi.framework.Bundle	getBundle(String moduleId, String version) Find the bundle that is represented by the specified module and version.
static org.osgi.framework.Bundle	getBundleBySymbolicName(String symbolicName, String version) Finds the bundle by its symbolic name.
static Throwable	getContextStartException(String key)
static org.springframework.context.support.AbstractApplicationContext	getContextToStartForModule(org.osgi.framework.Bundle bundle)
static String	getDisplayName(org.osgi.framework.Bundle bundle) Returns the bundle display name containing module name (ID) and the version.
static JahiaTemplatesPackage	getModule(org.osgi.framework.Bundle bundle) Returns the module instance that corresponds to the provided OSGi bundle.
static String	getModuleGroupId(org.osgi.framework.Bundle bundle) Returns the groupId of the module read from the provided bundle.
static String	getModuleId(org.osgi.framework.Bundle bundle) Returns the module name read from the provided bundle.
static String	getModuleVersion(org.osgi.framework.Bundle bundle) Returns a version of the module read from the provided bundle.
static <S> S	getOsgiService(Class<S> serviceClass, String filter) Looks up an OSGi service for the specified class and filter.
static <S> S	getOsgiService(String serviceClass) Looks up an OSGi service for the specified class and filter.
static Object	getOsgiService(String serviceClassName, String filter) Looks up an OSGi service for the specified class name and filter.
static int	getPersistentState(org.osgi.framework.Bundle bundle) This method deduce and return the persistent state value of a bundle
static boolean	isFragment(org.osgi.framework.Bundle bundle) Checks if the provided bundle is a fragment bundle.
static boolean	isJahiaBundle(org.osgi.framework.Bundle bundle) Returns true if the provided bundle represents Jahia-related bundle (either a module or a service).
static boolean	isJahiaModuleBundle(org.osgi.framework.Bundle bundle) Returns true if the provided bundle represents Jahia module.
static Class<?>	loadModuleClass(String className) Performs lookup of the specified class in classloaders of all modules, which are in state Resolved or Active.
static Class<?>	loadModuleClass(String className, int requiredModuleStatus) Performs lookup of the specified class in classloaders of all modules, which are at least in the requested state.
static void	setContextStartException(String key, Throwable exception)
static void	setContextToStartForModule(org.osgi.framework.Bundle bundle, org.springframework.context.support.AbstractApplicationContext context)
static void	unregisterModule(org.osgi.framework.Bundle bundle) Removes the module instance that corresponds to the provided OSGi bundle from internal registry.

Methods inherited from class java.lang.Object

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

Constructor Detail

BundleUtils

public BundleUtils()

Method Detail

bundleEventToString

public static String bundleEventToString(int eventType)

Returns a String representation for the given bundle event.

Parameters:

eventType - OSGi BundleEvent given as an int

Returns:

String representation for the bundle event

See Also:

org.eclipse.gemini.blueprint.util.OsgiStringUtils

createBundleClassLoader

public static ClassLoader createBundleClassLoader(org.osgi.framework.Bundle bundle)

Creates an instance of the BundleDelegatingClassLoader baked by the provided bundle and having Jahia root Spring context's class loader as a parent.

Parameters:

bundle - the bundle to create class loader for

Returns:

an instance of the BundleDelegatingClassLoader baked by the provided bundle and having Jahia root Spring context's class loader as a parent

getBundleBySymbolicName

public static org.osgi.framework.Bundle getBundleBySymbolicName(String symbolicName,
                                                                String version)

Finds the bundle by its symbolic name.

Parameters:

symbolicName - the bundle symbolic name

version - the bundle version; or null to get the first matching bundle, found

Returns:

the bundle for the specified symbolic name and version or null if the corresponding bundle is not present

getBundle

public static org.osgi.framework.Bundle getBundle(long id)

Returns the bundle with the specified identifier.

Parameters:

id - The identifier of the bundle to retrieve.

Returns:

A Bundle object or null if the identifier does not match any installed bundle.

getBundle

public static org.osgi.framework.Bundle getBundle(String location)

Finds bundle by its location.

Parameters:

location - the location of the bundle to be found

Returns:

bundle for the specified location or null if there is no matching bundle installed

getBundle

public static org.osgi.framework.Bundle getBundle(String moduleId,
                                                  String version)

Find the bundle that is represented by the specified module and version.

Parameters:

moduleId - the module Id

version - the module version

Returns:

the bundle for the specified module and version or null if the corresponding bundle is not present

getDisplayName

public static String getDisplayName(org.osgi.framework.Bundle bundle)

Returns the bundle display name containing module name (ID) and the version.

Parameters:

bundle - the bundle to get display name for

Returns:

the bundle display name containing module name (ID) and the version

getModule

public static JahiaTemplatesPackage getModule(org.osgi.framework.Bundle bundle)

Returns the module instance that corresponds to the provided OSGi bundle. If the instance is not present yet, creates it and stores internally.

Parameters:

bundle - the corresponding OSGi bundle

Returns:

the module instance that corresponds to the provided OSGi bundle

getModuleId

public static String getModuleId(org.osgi.framework.Bundle bundle)

Returns the module name read from the provided bundle.

Parameters:

bundle - the bundle to read module name from

Returns:

the module name read from the provided bundle

getModuleVersion

public static String getModuleVersion(org.osgi.framework.Bundle bundle)

Returns a version of the module read from the provided bundle.

Parameters:

bundle - the bundle to read the module version from

Returns:

a version of the module read from the provided bundle

getModuleGroupId

public static String getModuleGroupId(org.osgi.framework.Bundle bundle)

Returns the groupId of the module read from the provided bundle.

Parameters:

bundle - the bundle to read the module groupId from

Returns:

groupId of the module read from the provided bundle

isJahiaBundle

public static boolean isJahiaBundle(org.osgi.framework.Bundle bundle)

Returns true if the provided bundle represents Jahia-related bundle (either a module or a service).

Parameters:

bundle - the OSGi bundle to check

Returns:

true if the provided bundle represents Jahia-related bundle (either a module or a service)

isJahiaModuleBundle

public static boolean isJahiaModuleBundle(org.osgi.framework.Bundle bundle)

Returns true if the provided bundle represents Jahia module.

Parameters:

bundle - the OSGi bundle to check

Returns:

true if the provided bundle represents Jahia module

loadModuleClass

public static Class<?> loadModuleClass(String className)
                                throws ClassNotFoundException

Performs lookup of the specified class in classloaders of all modules, which are in state Resolved or Active.

Parameters:

className - the fully qualified class name to look up

Returns:

the requested class

Throws:

ClassNotFoundException - in case the corresponding class cannot be found

loadModuleClass

public static Class<?> loadModuleClass(String className,
                                       int requiredModuleStatus)
                                throws ClassNotFoundException

Performs lookup of the specified class in classloaders of all modules, which are at least in the requested state.

Parameters:

className - the fully qualified class name to look up

requiredModuleStatus - the minimal required state of the bundle to be considered for class lookup

Returns:

the requested class

Throws:

ClassNotFoundException - in case the corresponding class cannot be found

unregisterModule

public static void unregisterModule(org.osgi.framework.Bundle bundle)

Removes the module instance that corresponds to the provided OSGi bundle from internal registry.

Parameters:

bundle - the corresponding OSGi bundle

getContextToStartForModule

public static org.springframework.context.support.AbstractApplicationContext getContextToStartForModule(org.osgi.framework.Bundle bundle)

setContextToStartForModule

public static void setContextToStartForModule(org.osgi.framework.Bundle bundle,
                                              org.springframework.context.support.AbstractApplicationContext context)

getContextStartException

public static Throwable getContextStartException(String key)

setContextStartException

public static void setContextStartException(String key,
                                            Throwable exception)

getOsgiService

public static <S> S getOsgiService(String serviceClass)

Looks up an OSGi service for the specified class and filter. If multiple services are found matching the criteria, returns the best one, based on the service ranking. If no matching service has been found, returns null.

Parameters:

serviceClass - the class of the service to be looked up

Returns:

an OSGi service instance matching the specified criteria or null if no match was found

getOsgiService

public static <S> S getOsgiService(Class<S> serviceClass,
                                   String filter)

Looks up an OSGi service for the specified class and filter. If multiple services are found matching the criteria, returns the best one, based on the service ranking. If no matching service has been found, returns null.

Parameters:

serviceClass - the class of the service to be looked up

filter - the filter expression or null for all services of the specified type

Returns:

an OSGi service instance matching the specified criteria or null if no match was found

Throws:

IllegalArgumentException - in case the filter expression is syntactically invalid

getOsgiService

public static Object getOsgiService(String serviceClassName,
                                    String filter)

Looks up an OSGi service for the specified class name and filter. If multiple services are found matching the criteria, returns the best one, based on the service ranking. If no matching service has been found, returns null.

Parameters:

serviceClassName - the class name of the service to be looked up

filter - the filter expression or null for all services of the specified type

Returns:

an OSGi service instance matching the specified criteria or null if no match was found

Throws:

IllegalArgumentException - in case the filter expression is syntactically invalid

isFragment

public static boolean isFragment(org.osgi.framework.Bundle bundle)

Checks if the provided bundle is a fragment bundle.

Parameters:

bundle - the bundle to be checked

Returns:

true in case the supplied bundle is a fragment bundle; false otherwise

getPersistentState

public static int getPersistentState(org.osgi.framework.Bundle bundle)

This method deduce and return the persistent state value of a bundle

Parameters:

bundle - the bundle to get the persistent state from

Returns:

the integer value of the persistent state