org.jboss.osgi.repository.spi

Class AbstractRepository

java.lang.Object

org.jboss.osgi.repository.spi.AbstractRepository

All Implemented Interfaces:

XRepository, Repository

Direct Known Subclasses:

AbstractPersistentRepository, MavenIdentityRepository, ModuleIdentityRepository

public abstract class AbstractRepository
extends Object
implements XRepository

An abstract XRepository that does nothing.

Since:

11-May-2012

Author:

thomas.diesler@jboss.com, David Bosschaert

Field Summary

Fields inherited from interface org.jboss.osgi.repository.XRepository

PROPERTY_MAVEN_REPOSITORY_BASE_URLS, PROPERTY_REPOSITORY_STORAGE_DIR, PROPERTY_REPOSITORY_STORAGE_FILE

Fields inherited from interface org.osgi.service.repository.Repository

URL

Constructor Summary

Constructors

Constructor and Description
AbstractRepository()

Method Summary

Modifier and Type	Method and Description
<T> T	adapt(Class<T> type) Adapt this repository tor the given type
Map<org.osgi.resource.Requirement,Collection<org.osgi.resource.Capability>>	findProviders(Collection<? extends org.osgi.resource.Requirement> reqs) Find the capabilities that match the specified requirements.
abstract Collection<org.osgi.resource.Capability>	findProviders(org.osgi.resource.Requirement req) Find the capabilities that match the specified requirement.
Promise<Collection<org.osgi.resource.Resource>>	findProviders(RequirementExpression re) Find the resources that match the specified requirement expression.
ExpressionCombiner	getExpressionCombiner() Return an expression combiner.
String	getName() Get the name for this repository
protected OSGiMetaData	getOSGiMetaData(XResource resource)
protected OSGiMetaData	getOSGiMetaDataFromManifest(XResource resource)
protected XResourceBuilder<XResource>	getResourceBuilder(XResource resource)
protected Manifest	getResourceManifest(XResource resource)
protected XResource	getTargetResource(XResource resource) Convert the given resource into the target resource type.
RequirementBuilder	newRequirementBuilder(String namespace) Return a new RequirementBuilder which provides a convenient way to create a requirement.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRepository

public AbstractRepository()

Method Detail

getName

public String getName()

Description copied from interface: XRepository

Get the name for this repository

Specified by:

getName in interface XRepository

adapt

public <T> T adapt(Class<T> type)

Description copied from interface: XRepository

Adapt this repository tor the given type

Specified by:

adapt in interface XRepository

findProviders

public Map<org.osgi.resource.Requirement,Collection<org.osgi.resource.Capability>> findProviders(Collection<? extends org.osgi.resource.Requirement> reqs)

Description copied from interface: Repository

Find the capabilities that match the specified requirements.

Specified by:

findProviders in interface Repository

Parameters:

reqs - The requirements for which matching capabilities should be returned. Must not be null.

Returns:

A map of matching capabilities for the specified requirements. Each specified requirement must appear as a key in the map. If there are no matching capabilities for a specified requirement, then the value in the map for the specified requirement must be an empty collection. The returned map is the property of the caller and can be modified by the caller. The returned map may be lazily populated, so calling size() may result in a long running operation.

findProviders

public abstract Collection<org.osgi.resource.Capability> findProviders(org.osgi.resource.Requirement req)

Description copied from interface: XRepository

Find the capabilities that match the specified requirement.

Specified by:

findProviders in interface XRepository

Parameters:

req - The requirements for which matching capabilities should be returned. Must not be null.

Returns:

A collection of matching capabilities for the specified requirements. If there are no matching capabilities an empty collection is returned. The returned collection is the property of the caller and can be modified by the caller.

findProviders

public Promise<Collection<org.osgi.resource.Resource>> findProviders(RequirementExpression re)

Description copied from interface: Repository

Find the resources that match the specified requirement expression.

Specified by:

findProviders in interface Repository

Parameters:

re - The RequirementExpression for which matching capabilities should be returned. Must not be null.

Returns:

A promise to a collection of matching Resources. If there are no matching resources, an empty collection is returned. The returned collection is the property of the caller and can be modified by the caller. The returned collection may be lazily populated, so calling size() may result in a long running operation.

getExpressionCombiner

public ExpressionCombiner getExpressionCombiner()

Description copied from interface: Repository

Return an expression combiner. An expression combiner can be used to combine multiple requirement expressions into more complex requirement expressions using and, or and not operators.

Specified by:

getExpressionCombiner in interface Repository

Returns:

An ExpressionCombiner.

newRequirementBuilder

public RequirementBuilder newRequirementBuilder(String namespace)

Description copied from interface: Repository

Return a new RequirementBuilder which provides a convenient way to create a requirement.

For example:

 Requirement myReq = repository.newRequirementBuilder("org.foo.ns1").
   addDirective("filter", "(org.foo.ns1=val1)").
   addDirective("cardinality", "multiple").build();
 

Specified by:

newRequirementBuilder in interface Repository

Parameters:

namespace - The namespace for the requirement to be created.

Returns:

A new requirement builder for a requirement in the specified namespace.

getTargetResource

protected XResource getTargetResource(XResource resource)
                               throws Exception

Convert the given resource into the target resource type.

Returns:

The target resource

Throws:

Exception

getResourceBuilder

protected XResourceBuilder<XResource> getResourceBuilder(XResource resource)

getOSGiMetaData

protected OSGiMetaData getOSGiMetaData(XResource resource)
                                throws IOException

Throws:

IOException

getOSGiMetaDataFromManifest

protected OSGiMetaData getOSGiMetaDataFromManifest(XResource resource)
                                            throws IOException

Throws:

IOException

getResourceManifest

protected Manifest getResourceManifest(XResource resource)
                                throws IOException

Throws:

IOException