org.virtualrepository.impl

Class Repository

java.lang.Object

org.virtualrepository.impl.Repository

All Implemented Interfaces:

Iterable<Asset>, VirtualRepository

public class Repository
extends Object
implements VirtualRepository

Default VirtualRepository implementation.

Author:

Fabio Simeoni

Constructor Summary

Constructors

Constructor and Description
Repository() Creates an instance over all the RepositoryServices available on the classpath.
Repository(RepositoryService... services) Creates an instance over given RepositoryServices.
Repository(Services services) Creates an instance over a collection of RepositoryServices

Method Summary

Modifier and Type	Method and Description
boolean	canRetrieve(Asset asset, Class<?> api)
int	discover(AssetType... types) Discovers all the assets of given AssetTypes which are available through all the underlying RepositoryServices, using a default timeout.
int	discover(Iterable<RepositoryService> services, AssetType... types) Discovers all the assets of given AssetTypes which are available through one or more RepositoryServices, using a default timeout.
int	discover(long timeout, AssetType... types) Discovers all the assets of given AssetTypes which are available through the underlying RepositoryServices, using a given timeout.
int	discover(long timeout, Iterable<RepositoryService> services, AssetType... types) Discovers all the assets of given AssetTypes which are available through one or more RepositoryServices, using a default timeout.
Iterator<Asset>	iterator()
Map<AssetType,List<Asset>>	lookup(AssetType... types) Returns all the Asset of given AssetTypes which have been previously discovered.
List<Asset>	lookup(AssetType type) Returns all the Asset of which AssetType that have been previously discovered.
Asset	lookup(String id) Returns an Asset previously discovered.
void	publish(Asset asset, Object content) Publishes a given Asset with the RepositoryService bound to the asset.
<A> A	retrieve(Asset asset, Class<A> api) Retrieves the content of a given Asset from the RepositoryService bound to the asset, under a given API.
Services	services() Returns the RepositoryServices underlying this repository.
void	setExecutor(ExecutorService service) Replaces the default ExecutorService used to parallelise and/or time-control discovery, retrieval, and publication tasks.
void	shutdown() Closes this repository and releases its resources.
Collection<RepositoryService>	sinks(AssetType... types) Returns the RepositoryServices underlying this repository which can publish `Asset`s of at least one of given AssetTypes.
Collection<RepositoryService>	sources(AssetType... types) Returns the RepositoryServices underlying this repository which can retrieve `Asset`s of at least one of given AssetTypes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Repository

public Repository()

Creates an instance over all the RepositoryServices available on the classpath.

See Also:

Services.load()

Repository

public Repository(RepositoryService... services)

Creates an instance over given RepositoryServices.

Parameters:

services - the services

Repository

public Repository(Services services)

Creates an instance over a collection of RepositoryServices

Parameters:

services - the collection

Method Detail

setExecutor

public void setExecutor(ExecutorService service)

Replaces the default ExecutorService used to parallelise and/or time-control discovery, retrieval, and publication tasks.

Parameters:

service - the service

services

public Services services()

Description copied from interface: VirtualRepository

Returns the RepositoryServices underlying this repository.

Specified by:

services in interface VirtualRepository

Returns:

sinks

public Collection<RepositoryService> sinks(AssetType... types)

Description copied from interface: VirtualRepository

Returns the RepositoryServices underlying this repository which can publish `Asset`s of at least one of given AssetTypes.

Specified by:

sinks in interface VirtualRepository

Returns:

the services which can publish `Asset`s of at least one of given AssetTypes

sources

public Collection<RepositoryService> sources(AssetType... types)

Description copied from interface: VirtualRepository

Returns the RepositoryServices underlying this repository which can retrieve `Asset`s of at least one of given AssetTypes.

Specified by:

sources in interface VirtualRepository

Returns:

the services which can retrieve `Asset`s of at least one of given AssetTypes

discover

public int discover(AssetType... types)

Description copied from interface: VirtualRepository

Discovers all the assets of given AssetTypes which are available through all the underlying RepositoryServices, using a default timeout.

Specified by:

discover in interface VirtualRepository

Parameters:

types - the asset types

Returns:

the number of (newly) discovered assets

See Also:

VirtualRepository.discover(long, AssetType...)

discover

public int discover(Iterable<RepositoryService> services,
                    AssetType... types)

Description copied from interface: VirtualRepository

Discovers all the assets of given AssetTypes which are available through one or more RepositoryServices, using a default timeout.

Specified by:

discover in interface VirtualRepository

Parameters:

services - the repository services

types - the asset types

Returns:

the number of (newly) discovered assets

See Also:

VirtualRepository.discover(long, AssetType...)

discover

public int discover(long timeout,
                    AssetType... types)

Description copied from interface: VirtualRepository

Discovers all the assets of given AssetTypes which are available through the underlying RepositoryServices, using a given timeout.

Discovery may involve networked interactions with repository services, and typically will. Failures that occur when interacting with given repository services are silently tolerated. The interactions do not imply the transfer of asset content, however, only content descriptions.

This method may be invoked multiple times in the lifetime of this repository, typically to discover new assets that may have become available through the repository services. In this case, discovering an asset overwrites any existing description of an asset with the same identifier.

Specified by:

discover in interface VirtualRepository

types - the asset types

Returns:

the number of (newly) discovered assets

discover

public int discover(long timeout,
                    Iterable<RepositoryService> services,
                    AssetType... types)

Description copied from interface: VirtualRepository

Discovers all the assets of given AssetTypes which are available through one or more RepositoryServices, using a default timeout.

Specified by:

discover in interface VirtualRepository

services - the repository services

types - the asset types

Returns:

the number of (newly) discovered assets

See Also:

VirtualRepository.discover(long, AssetType...)

iterator

public Iterator<Asset> iterator()

Specified by:

iterator in interface Iterable<Asset>

lookup

public Asset lookup(String id)

Description copied from interface: VirtualRepository

Returns an Asset previously discovered.

This is a local operation and does not trigger network interactions.

Specified by:

lookup in interface VirtualRepository

Returns:

the asset

lookup

public List<Asset> lookup(AssetType type)

Description copied from interface: VirtualRepository

Returns all the Asset of which AssetType that have been previously discovered.

This is a local operation and does not trigger network interactions.

Specified by:

lookup in interface VirtualRepository

Returns:

the assets of the given AssetType

lookup

public Map<AssetType,List<Asset>> lookup(AssetType... types)

Description copied from interface: VirtualRepository

Returns all the Asset of given AssetTypes which have been previously discovered.

This is a local operation and does not trigger network interactions.

Specified by:

lookup in interface VirtualRepository

Returns:

the assets of the given AssetTypes

canRetrieve

public boolean canRetrieve(Asset asset,
                           Class<?> api)

retrieve

public <A> A retrieve(Asset asset,
                      Class<A> api)

Description copied from interface: VirtualRepository

Retrieves the content of a given Asset from the RepositoryService bound to the asset, under a given API.

Retrieval may involve networked interactions with the repository service, and typically will. Failures are reported as unchecked exceptions.

Specified by:

retrieve in interface VirtualRepository

Parameters:

asset - the asset

api - the API

Returns:

the content of the asset

publish

public void publish(Asset asset,
                    Object content)

Description copied from interface: VirtualRepository

Publishes a given Asset with the RepositoryService bound to the asset.

Publication may involve networked interactions with the repository service, and typically will. Failures are reported as unchecked exceptions.

Specified by:

publish in interface VirtualRepository

Parameters:

asset - the asset

content - the content of the asset

shutdown

public void shutdown()

Description copied from interface: VirtualRepository

Closes this repository and releases its resources.

Specified by:

shutdown in interface VirtualRepository