biz.aQute.resolve

Class AbstractResolveContext

java.lang.Object

ResolveContext

biz.aQute.resolve.AbstractResolveContext

Direct Known Subclasses:

BndrunResolveContext, GenericResolveContext

public abstract class AbstractResolveContext
extends ResolveContext

This is the Resolve Context as outlined in the Resolver specification. It manages the access to the repository and orders the capabilities. It also provides the capabilities of the environment.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CONTRACT_OSGI_FRAMEWORK Deprecated.
protected static java.lang.String	IDENTITY_INITIAL_RESOURCE
protected static java.lang.String	IDENTITY_SYSTEM_RESOURCE
protected LogService	log

Constructor Summary

Constructors

Constructor and Description
AbstractResolveContext(LogService log)

Method Summary

Modifier and Type	Method and Description
void	addCallbacks(java.util.Collection<ResolutionCallback> callbacks)
void	addEffectiveDirective(java.lang.String effectiveDirective)
void	addEffectiveDirective(java.lang.String effectiveDirective, java.util.Set<java.lang.String> excludedNamespaces)
void	addEffectiveSet(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> effectiveSet)
void	addRepository(Repository repo)
void	addResolverHook(ResolverHook resolverHook)
protected void	addSystemResource(ResourceBuilder system, Resource resource)
static Requirement	createBundleRequirement(java.lang.String bsn, java.lang.String versionStr)
static Requirement	createIdentityRequirement(java.lang.String identity, java.lang.String versionRange)
static Capability	createPackageCapability(java.lang.String packageName, java.lang.String versionString)
static Repository	createRepository(java.util.List<Resource> resources)
protected static Capability	findFrameworkContractCapability(Resource resource) Deprecated.
protected java.util.Collection<Capability>	findProviders(Repository repo, Requirement requirement) Return any capabilities from the given repo.
java.util.List<Capability>	findProviders(Requirement requirement)
protected java.util.ArrayList<Capability>	findProvidersFromRepositories(Requirement requirement, java.util.LinkedHashSet<Capability> existingWiredCapabilities)
java.util.Set<Resource>	getBlackList()
java.util.List<ResolutionCallback>	getCallbacks()
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	getEffectiveSet()
java.util.List<Requirement>	getFailed()
Resource	getFramework()
Resource	getHighestResource(java.lang.String bsn, java.lang.String range)
static Capability	getIdentityCapability(Resource resource)
Resource	getInputResource()
int	getLevel()
java.util.Collection<Resource>	getMandatoryResources()
java.util.List<Repository>	getRepositories()
static java.lang.String	getResourceIdentity(Resource resource)
java.util.List<Resource>	getResources(java.util.List<Repository> repos, Requirement req)
java.util.List<Resource>	getResources(java.util.List<Repository> repos, java.lang.String bsn, java.lang.String range) Get the framework repository from the
static Version	getResourceVersion(Resource resource)
Resource	getSystemResource()
java.util.Map<Resource,Wiring>	getWirings()
protected void	init()
int	insertHostedCapability(java.util.List<Capability> caps, HostedCapability hc)
boolean	isEffective(Requirement requirement)
boolean	isInputResource(Resource resource)
boolean	isSystemResource(Resource resource)
void	loadPath(ResourceBuilder system, java.lang.String path, java.lang.String what) Load a bnd path from the OSGi repositories.
protected void	postProcessProviders(Requirement requirement, java.util.Set<Capability> wired, java.util.List<Capability> candidates)
protected void	processMandatoryResource(Requirement requirement, java.util.LinkedHashSet<Capability> firstStageResult, Resource resource)
static boolean	resourceIdentityEquals(Resource r1, Resource r2)
protected void	setBlackList(java.util.Collection<Requirement> reject) If the blacklist is set, we have a list of requirements of resources that should not be included (blacklist).
protected void	setFramework(ResourceBuilder system, Resource framework) Add a framework resource to the system resource builder
void	setInputRequirements(Requirement... reqs)
void	setInputResource(Resource inputResource)
void	setLevel(int n)
void	setOptionalRoots(java.util.Collection<Resource> roots)
void	setSystemResource(Resource system)
protected static Version	toVersion(java.lang.Object object)

Methods inherited from class java.lang.Object

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

Field Detail

CONTRACT_OSGI_FRAMEWORK

@Deprecated
protected static final java.lang.String CONTRACT_OSGI_FRAMEWORK

Deprecated.

The 'OSGiFramework' contract was something invented by the old indexer which is no longer in use.

See Also:

Constant Field Values

IDENTITY_INITIAL_RESOURCE

protected static final java.lang.String IDENTITY_INITIAL_RESOURCE

IDENTITY_SYSTEM_RESOURCE

protected static final java.lang.String IDENTITY_SYSTEM_RESOURCE

log

protected final LogService log

Constructor Detail

AbstractResolveContext

public AbstractResolveContext(LogService log)

Method Detail

init

protected void init()

findProviders

public java.util.List<Capability> findProviders(Requirement requirement)

getMandatoryResources

public java.util.Collection<Resource> getMandatoryResources()

insertHostedCapability

public int insertHostedCapability(java.util.List<Capability> caps,
                                  HostedCapability hc)

isEffective

public boolean isEffective(Requirement requirement)

getWirings

public java.util.Map<Resource,Wiring> getWirings()

processMandatoryResource

protected void processMandatoryResource(Requirement requirement,
                                        java.util.LinkedHashSet<Capability> firstStageResult,
                                        Resource resource)

findProvidersFromRepositories

protected java.util.ArrayList<Capability> findProvidersFromRepositories(Requirement requirement,
                                                                        java.util.LinkedHashSet<Capability> existingWiredCapabilities)

findProviders

protected java.util.Collection<Capability> findProviders(Repository repo,
                                                         Requirement requirement)

Return any capabilities from the given repo. This method will filter the blacklist.

Parameters:

repo - The repo to fetch requirements from

requirement - the requirement

Returns:

a list of caps for the asked requirement minus and capabilities that are skipped.

createBundleRequirement

public static Requirement createBundleRequirement(java.lang.String bsn,
                                                  java.lang.String versionStr)

setOptionalRoots

public void setOptionalRoots(java.util.Collection<Resource> roots)

addRepository

public void addRepository(Repository repo)

getRepositories

public java.util.List<Repository> getRepositories()

getFailed

public java.util.List<Requirement> getFailed()

findFrameworkContractCapability

@Deprecated
protected static Capability findFrameworkContractCapability(Resource resource)

Deprecated.

This method is BROKEN. The 'OSGiFramework' contract was something invented by the old indexer which is no longer in use.

getInputResource

public Resource getInputResource()

setInputResource

public void setInputResource(Resource inputResource)

getSystemResource

public Resource getSystemResource()

setSystemResource

public void setSystemResource(Resource system)

addEffectiveDirective

public void addEffectiveDirective(java.lang.String effectiveDirective)

addEffectiveDirective

public void addEffectiveDirective(java.lang.String effectiveDirective,
                                  java.util.Set<java.lang.String> excludedNamespaces)

addEffectiveSet

public void addEffectiveSet(java.util.Map<java.lang.String,java.util.Set<java.lang.String>> effectiveSet)

postProcessProviders

protected void postProcessProviders(Requirement requirement,
                                    java.util.Set<Capability> wired,
                                    java.util.List<Capability> candidates)

addResolverHook

public void addResolverHook(ResolverHook resolverHook)

addCallbacks

public void addCallbacks(java.util.Collection<ResolutionCallback> callbacks)

createIdentityRequirement

public static Requirement createIdentityRequirement(java.lang.String identity,
                                                    java.lang.String versionRange)

isInputResource

public boolean isInputResource(Resource resource)

isSystemResource

public boolean isSystemResource(Resource resource)

getHighestResource

public Resource getHighestResource(java.lang.String bsn,
                                   java.lang.String range)

getResources

public java.util.List<Resource> getResources(java.util.List<Repository> repos,
                                             java.lang.String bsn,
                                             java.lang.String range)

Get the framework repository from the

Parameters:

repos -

bsn -

getResources

public java.util.List<Resource> getResources(java.util.List<Repository> repos,
                                             Requirement req)

setFramework

protected void setFramework(ResourceBuilder system,
                            Resource framework)
                     throws java.lang.Exception

Add a framework resource to the system resource builder

Parameters:

system - the system resource being build up

framework - the framework resource

Throws:

java.lang.Exception

addSystemResource

protected void addSystemResource(ResourceBuilder system,
                                 Resource resource)
                          throws java.lang.Exception

Throws:

java.lang.Exception

toVersion

protected static Version toVersion(java.lang.Object object)
                            throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

createRepository

public static Repository createRepository(java.util.List<Resource> resources)

createPackageCapability

public static Capability createPackageCapability(java.lang.String packageName,
                                                 java.lang.String versionString)
                                          throws java.lang.Exception

Throws:

java.lang.Exception

resourceIdentityEquals

public static boolean resourceIdentityEquals(Resource r1,
                                             Resource r2)

getIdentityCapability

public static Capability getIdentityCapability(Resource resource)

getResourceIdentity

public static java.lang.String getResourceIdentity(Resource resource)

getResourceVersion

public static Version getResourceVersion(Resource resource)

setBlackList

protected void setBlackList(java.util.Collection<Requirement> reject)

If the blacklist is set, we have a list of requirements of resources that should not be included (blacklist). We try to find those resources and add them to the blacklistedResources

getCallbacks

public java.util.List<ResolutionCallback> getCallbacks()

getBlackList

public java.util.Set<Resource> getBlackList()

setLevel

public void setLevel(int n)

getLevel

public int getLevel()

getFramework

public Resource getFramework()

loadPath

public void loadPath(ResourceBuilder system,
                     java.lang.String path,
                     java.lang.String what)
              throws java.io.IOException,
                     java.lang.Exception

Load a bnd path from the OSGi repositories. We assume the highest version allowed. This mimics Project.getBundles()

Parameters:

system -

path -

what -

Throws:

java.io.IOException

java.lang.Exception

setInputRequirements

public void setInputRequirements(Requirement... reqs)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getEffectiveSet

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> getEffectiveSet()