org.jahia.services.modulemanager.util

Class ModuleUtils

java.lang.Object

org.jahia.services.modulemanager.util.ModuleUtils

public class ModuleUtils
extends Object

Utility class that contains common module methods for persisting bundle and transforming Jahia-Depends header values of module bundles into corresponding Require-Capability header and also adding the Provide-Capability for the module itself.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Collection<String>	DEPENDENCIES_TO_REMOVE

Method Summary

Modifier and Type	Method and Description
static InputStream	addModuleDependencies(InputStream sourceStream) Performs the transformation of the capability attributes in the MANIFEST.MF file of the supplied stream.
static ModuleManager	getModuleManager() Retrieves an instance of the module manager.
static org.springframework.core.io.Resource	loadBundleResource(org.osgi.framework.Bundle bundle) Load the bundle .jar resource.
static PersistentBundle	loadPersistentBundle(String bundleKey) Returns the persistent bundle info for the specified key.
static PersistentBundle	persist(org.osgi.framework.Bundle bundle) Performs the persistence of the supplied bundle and returns the information about it.
static PersistentBundle	persist(org.springframework.core.io.Resource bundleResource) Performs the persistence of the supplied bundle resource and returns the information about it.
static String	replaceDependsDelimiter(String dependsValue)
static boolean	requiresTransformation(Attributes atts) Checks if the artifact manifest requires adjustments in the capability headers w.r.t.
static String[]	toDependsArray(String dependsValue)
static void	updateBundleLocation(org.osgi.framework.Bundle bundle, String updatedLocation) Performs the update of the bundle original location.

Methods inherited from class java.lang.Object

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

Field Detail

DEPENDENCIES_TO_REMOVE

protected static final Collection<String> DEPENDENCIES_TO_REMOVE

Method Detail

addModuleDependencies

public static InputStream addModuleDependencies(InputStream sourceStream)
                                         throws IOException

Performs the transformation of the capability attributes in the MANIFEST.MF file of the supplied stream.

Parameters:

sourceStream - the source stream for the bundle, which manifest has to be adjusted w.r.t. module dependencies; the stream is closed after returning from this method

Returns:

the transformed stream for the bundle with adjusted manifest

Throws:

IOException - in case of I/O errors

getModuleManager

public static ModuleManager getModuleManager()

Retrieves an instance of the module manager.

Returns:

an instance of the module manager

replaceDependsDelimiter

public static String replaceDependsDelimiter(String dependsValue)

Returns:

Replace dependency separator with DEPENDENCY_DELIMITER instead of comma so it doesn't conflict with version range separator e.g. 'module1=[1.2,2),module2,module3=4' to 'module1=[1.2,2);module2;module3=4'

toDependsArray

public static String[] toDependsArray(String dependsValue)

loadBundleResource

public static org.springframework.core.io.Resource loadBundleResource(org.osgi.framework.Bundle bundle)
                                                               throws MalformedURLException

Load the bundle .jar resource.

Parameters:

bundle - the bundle to be loaded

Returns:

the bundle resource

Throws:

MalformedURLException

loadPersistentBundle

public static PersistentBundle loadPersistentBundle(String bundleKey)
                                             throws ModuleManagementException

Returns the persistent bundle info for the specified key.

Parameters:

bundleKey - the key of the bundle to look up

Returns:

the persistent bundle info for the specified key

Throws:

ModuleManagementException - in case of a lookup error

persist

public static PersistentBundle persist(org.osgi.framework.Bundle bundle)
                                throws ModuleManagementException

Performs the persistence of the supplied bundle and returns the information about it.

Parameters:

bundle - the source bundle

Returns:

information about persisted bundle

Throws:

ModuleManagementException - in case of an error during persistence of the bundle

persist

public static PersistentBundle persist(org.springframework.core.io.Resource bundleResource)
                                throws ModuleManagementException

Performs the persistence of the supplied bundle resource and returns the information about it.

Parameters:

bundleResource - the source bundle resource

Returns:

information about persisted bundle

Throws:

ModuleManagementException - in case of an error during persistence of the bundle

requiresTransformation

public static boolean requiresTransformation(Attributes atts)

Checks if the artifact manifest requires adjustments in the capability headers w.r.t. module dependencies.

Parameters:

atts - the manifest attributes to be checked

Returns:

true if the artifact manifest requires adjustments in the capability headers w.r.t. module dependencies; false if it already contains that info

updateBundleLocation

public static void updateBundleLocation(org.osgi.framework.Bundle bundle,
                                        String updatedLocation)

Performs the update of the bundle original location.

Parameters:

bundle - the bundle to update location for

updatedLocation - the new value of the location