Package org.apache.karaf.features.internal.region

Class SubsystemResolver

java.lang.Object

org.apache.karaf.features.internal.region.SubsystemResolver

All Implemented Interfaces:

SubsystemResolverResolution, SubsystemResolverResult

public class SubsystemResolver
extends Object
implements SubsystemResolverResolution, SubsystemResolverResult

Constructor Summary

Constructors

Constructor	Description
SubsystemResolver(org.osgi.service.resolver.Resolver resolver, DownloadManager manager)

Method Summary

Modifier and Type	Method	Description
Set<String>	collectPrerequisites()	Before attempting resolution, we can collect features' prerequisites.
Map<String,Map<String,BundleInfo>>	getBundleInfos()	Get a map between regions, bundle locations and actual BundleInfo
Map<org.osgi.resource.Resource,String>	getBundles()
Map<String,Set<org.osgi.resource.Resource>>	getBundlesPerRegions()	Returns a mapping between regions and a set of bundle resources
Map<org.osgi.resource.Resource,String>	getFeatures()
Map<String,Set<org.osgi.resource.Resource>>	getFeaturesPerRegions()	Returns a mapping between regions and a set of feature resources
org.eclipse.equinox.region.RegionDigraph	getFlatDigraph()	Return directed graph of regions after resolution.
Map<String,String>	getFlatSubsystemsMap()	A mapping from subsystem, to parent subsystem representing a region or scoped feature.
Map<String,StreamProvider>	getProviders()	Get map of all downloaded resources (location -> provider)
Map<org.osgi.resource.Resource,List<org.osgi.resource.Wire>>	getWiring()	Returns a result of Resolver.resolve(ResolveContext)
void	prepare(Map<String,List<Feature>> allFeatures, Map<String,Set<String>> requirements, Map<String,Set<org.osgi.framework.wiring.BundleRevision>> system)	Prepares the resolver by configuring Subsystem hierarchy.
Map<org.osgi.resource.Resource,List<org.osgi.resource.Wire>>	resolve(String featureResolutionRange, FeaturesService.ServiceRequirementsBehavior serviceRequirements, org.osgi.service.repository.Repository globalRepository, String outputFile)
void	setDeployCallback(SubsystemResolverCallback callback)

Methods inherited from class java.lang.Object

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

Constructor Detail

SubsystemResolver

public SubsystemResolver(org.osgi.service.resolver.Resolver resolver,
                         DownloadManager manager)

Method Detail

setDeployCallback

public void setDeployCallback(SubsystemResolverCallback callback)

prepare

public void prepare(Map<String,List<Feature>> allFeatures,
                    Map<String,Set<String>> requirements,
                    Map<String,Set<org.osgi.framework.wiring.BundleRevision>> system)
             throws Exception

Description copied from interface: SubsystemResolverResolution

Prepares the resolver by configuring Subsystem hierarchy. The input is a mapping from region names to a set of logical requirements. The effect is:

• A tree of subsystems where the root subsystem represents FeaturesService.ROOT_REGION with regions like root/app1 represented as child subsystems.
• A subsystem is created for each feature requirement and added as child and requirement for given region's subsystem
• Each subsystem for a feature has optional requirements for conditional features

Specified by:

prepare in interface SubsystemResolverResolution

Parameters:

allFeatures - all currently available features partitioned by name.

requirements - desired mapping from regions to logical requirements.

system - mapping from regions to unmanaged BundleRevisions.

Throws:

Exception

collectPrerequisites

public Set<String> collectPrerequisites()

Description copied from interface: SubsystemResolverResolution

Before attempting resolution, we can collect features' prerequisites. If there are any, caller may decide to deploy another set of requirements before the initial ones. Prerequisites allow to install for example wrap feature before installing a feature with bundle using wrap: protocol.

Specified by:

collectPrerequisites in interface SubsystemResolverResolution

Returns:

The collected prerequisites.

resolve

public Map<org.osgi.resource.Resource,List<org.osgi.resource.Wire>> resolve(String featureResolutionRange,
                                                                                  FeaturesService.ServiceRequirementsBehavior serviceRequirements,
                                                                                  org.osgi.service.repository.Repository globalRepository,
                                                                                  String outputFile)
                                                                           throws Exception

Specified by:

resolve in interface SubsystemResolverResolution

Throws:

Exception

getBundleInfos

public Map<String,Map<String,BundleInfo>> getBundleInfos()

Description copied from interface: SubsystemResolverResult

Get a map between regions, bundle locations and actual BundleInfo

Specified by:

getBundleInfos in interface SubsystemResolverResult

Returns:

getProviders

public Map<String,StreamProvider> getProviders()

Description copied from interface: SubsystemResolverResult

Get map of all downloaded resources (location -> provider)

Specified by:

getProviders in interface SubsystemResolverResult

Returns:

getWiring

public Map<org.osgi.resource.Resource,List<org.osgi.resource.Wire>> getWiring()

Description copied from interface: SubsystemResolverResult

Returns a result of Resolver.resolve(ResolveContext)

Specified by:

getWiring in interface SubsystemResolverResult

Returns:

getFlatDigraph

public org.eclipse.equinox.region.RegionDigraph getFlatDigraph()
                                                        throws org.osgi.framework.BundleException,
                                                               org.osgi.framework.InvalidSyntaxException

Description copied from interface: SubsystemResolverResult

Return directed graph of regions after resolution.

Specified by:

getFlatDigraph in interface SubsystemResolverResult

Returns:

Throws:

org.osgi.framework.BundleException

org.osgi.framework.InvalidSyntaxException

getFlatSubsystemsMap

public Map<String,String> getFlatSubsystemsMap()

A mapping from subsystem, to parent subsystem representing a region or scoped feature.

Returns:

The map of subsystems.

getBundlesPerRegions

public Map<String,Set<org.osgi.resource.Resource>> getBundlesPerRegions()

Description copied from interface: SubsystemResolverResult

Returns a mapping between regions and a set of bundle resources

Specified by:

getBundlesPerRegions in interface SubsystemResolverResult

Returns:

getBundles

public Map<org.osgi.resource.Resource,String> getBundles()

Returns:

map of bundles and the region they are deployed in

getFeaturesPerRegions

public Map<String,Set<org.osgi.resource.Resource>> getFeaturesPerRegions()

Description copied from interface: SubsystemResolverResult

Returns a mapping between regions and a set of feature resources

Specified by:

getFeaturesPerRegions in interface SubsystemResolverResult

Returns:

getFeatures

public Map<org.osgi.resource.Resource,String> getFeatures()

Returns:

map of features and the region they are deployed in