org.fabric3.spi.contribution

Interface MetaDataStore

public interface MetaDataStore

Implementations store contribution metadata.

Method Summary

Modifier and Type	Method and Description
<S extends Symbol,V> ResourceElement<S,V>	find(java.lang.Class<V> type, S symbol) Finds a resource element by its symbol against the entire domain symbol space.
Contribution	find(java.net.URI uri) Returns the contribution for the given URI.
<S extends Symbol,V> ResourceElement<S,V>	find(java.net.URI uri, java.lang.Class<V> type, S symbol) Finds a resource element by its symbol against the given contribution uri.
java.util.Set<Contribution>	getContributions() Returns the installed contributions in the domain.
void	remove(java.net.URI uri) Removes the contribution metadata.
<V> java.util.List<ResourceElement<?,V>>	resolve(java.net.URI uri, java.lang.Class<V> type) Resolves resource elements for a given type that are visible to the contribution.
<S extends Symbol,V> ResourceElement<S,V>	resolve(java.net.URI uri, java.lang.Class<V> type, S symbol, IntrospectionContext context) Resolves a resource element by its symbol against the given contribution uri.
java.util.List<Contribution>	resolve(java.net.URI uri, Import imprt) Resolves an import or returns an empty list if it cannot be satisfied.
java.util.Set<Contribution>	resolveCapabilities(Contribution contribution) Transitively resolves the extensions that provide capabilities required by the given contribution.
java.util.Set<Contribution>	resolveCapability(java.lang.String capability) Transitively resolves the extensions that provide the given capability.
java.util.List<ContributionWire<?,?>>	resolveContributionWires(java.net.URI uri, Import imprt) Resolves an import to a matching export and returns the associated ContributionWire.
java.util.Set<Contribution>	resolveDependentContributions(java.net.URI uri) Resolves contributions that import the contribution represented by the given URI.
java.util.List<Contribution>	resolveExtensionPoints(java.lang.String name) Resolves a contribution that provides an extension point.
java.util.List<Contribution>	resolveExtensionProviders(java.lang.String name) Resolves the contributions that extend an extension point.
void	store(Contribution contribution) Stores the contribution metadata

Method Detail

getContributions

java.util.Set<Contribution> getContributions()

Returns the installed contributions in the domain.

Returns:

the installed contributions in the domain

store

void store(Contribution contribution)
    throws org.fabric3.api.host.Fabric3Exception

Stores the contribution metadata

Parameters:

contribution - the contribution metadata

Throws:

org.fabric3.api.host.Fabric3Exception - if an error storing the metadata occurs

remove

void remove(java.net.URI uri)

Removes the contribution metadata.

Parameters:

uri - the contribution uri

find

Contribution find(java.net.URI uri)

Returns the contribution for the given URI.

Parameters:

uri - the contribution URI

Returns:

the contribution for the given URI or null if not found

find

<S extends Symbol,V> ResourceElement<S,V> find(java.lang.Class<V> type,
                                               S symbol)

Finds a resource element by its symbol against the entire domain symbol space.

Parameters:

type - the class representing the resource

symbol - the symbol used to represent the resource element.

Returns:

the resource element or null if not found

find

<S extends Symbol,V> ResourceElement<S,V> find(java.net.URI uri,
                                               java.lang.Class<V> type,
                                               S symbol)
                                        throws org.fabric3.api.host.Fabric3Exception

Finds a resource element by its symbol against the given contribution uri.

Parameters:

uri - the contribution URI to resolve against

type - the class representing the resource

symbol - the symbol used to represent the resource element.

Returns:

the resource element or null if not found

Throws:

org.fabric3.api.host.Fabric3Exception - if an error occurs during resolution

resolve

<S extends Symbol,V> ResourceElement<S,V> resolve(java.net.URI uri,
                                                  java.lang.Class<V> type,
                                                  S symbol,
                                                  IntrospectionContext context)
                                           throws org.fabric3.api.host.Fabric3Exception

Resolves a resource element by its symbol against the given contribution uri. Artifacts referenced by this resource will be resolved.

Parameters:

uri - the contribution URI to resolve against

type - the class representing the resource

symbol - the symbol used to represent the resource element.

context - the context to which validation errors and warnings are reported

Returns:

the resource element or null if not found

Throws:

org.fabric3.api.host.Fabric3Exception - if an error occurs during resolution

resolve

<V> java.util.List<ResourceElement<?,V>> resolve(java.net.URI uri,
                                                 java.lang.Class<V> type)
                                          throws org.fabric3.api.host.Fabric3Exception

Resolves resource elements for a given type that are visible to the contribution.

Parameters:

uri - the contribution to search

type - the resource element type

Returns:

the collection of resource elements

Throws:

org.fabric3.api.host.Fabric3Exception - if there is an error resolving the resource elements

resolve

java.util.List<Contribution> resolve(java.net.URI uri,
                                     Import imprt)

Resolves an import or returns an empty list if it cannot be satisfied.

Parameters:

uri - the importing contribution URI

imprt - the import

Returns:

the contributions

resolveContributionWires

java.util.List<ContributionWire<?,?>> resolveContributionWires(java.net.URI uri,
                                                               Import imprt)
                                                        throws org.fabric3.api.host.Fabric3Exception

Resolves an import to a matching export and returns the associated ContributionWire.

Parameters:

uri - the importing contribution URI

imprt - the import to resolve @return a ContributionWire or null

Returns:

a collection of ContributionWires matching the import. For multiplicity imports, the collection may contain 0..N wires. For non-multiplicity imports (e.g. import.java), the collection will contain 0..1 wires.

Throws:

org.fabric3.api.host.Fabric3Exception

resolveDependentContributions

java.util.Set<Contribution> resolveDependentContributions(java.net.URI uri)

Resolves contributions that import the contribution represented by the given URI.

Parameters:

uri - the contribution URI

Returns:

the set of contributions that import the contribution

resolveExtensionProviders

java.util.List<Contribution> resolveExtensionProviders(java.lang.String name)

Resolves the contributions that extend an extension point.

Parameters:

name - the extension point name

Returns:

the contributions that extend and extension point

resolveExtensionPoints

java.util.List<Contribution> resolveExtensionPoints(java.lang.String name)

Resolves a contribution that provides an extension point. Multiple contributions can provide the same extension point, e.g. contributions that represent different versions of a set of services.

Parameters:

name - the extension point name

Returns:

the URIs of the contributions that provide the extension points

resolveCapabilities

java.util.Set<Contribution> resolveCapabilities(Contribution contribution)

Transitively resolves the extensions that provide capabilities required by the given contribution.

Parameters:

contribution - the contribution

Returns:

the extensions

resolveCapability

java.util.Set<Contribution> resolveCapability(java.lang.String capability)

Transitively resolves the extensions that provide the given capability.

Parameters:

capability - the capability

Returns:

the extensions