org.apache.archiva.metadata.repository

Interface MetadataRepository

All Known Implementing Classes:

AbstractMetadataRepository, CassandraMetadataRepository, FileMetadataRepository, JcrMetadataRepository

@ParametersAreNonnullByDefault
public interface MetadataRepository

A Metadata repository provides information about artifact metadata. It does not provide the artifact data itself. It may be possible to use the same backend for metadata and storage, but this depends on the backends and they are provided by different APIs.

The motivation for this API is to provide fast access to the repository metadata and fulltext search. Also dependencies are stored in this repository.

The methods here do not update the artifacts itself. They are only updating the data in the metadata repository. That means, if you want to update some artifact, you should make sure to update the artifact itself and the metadata repository (either directly or by repository scanning).

Currently we are providing JCR, File based and Cassandra as backend for the metadata.

The metadata repository uses sessions for accessing the data. Please make sure to always close the sessions after using it. Best idiom for using the sessions: try(RepositorySession session = sessionFactory.createSession() { // do your stuff }

It is implementation dependent, if the sessions are really used by the backend. E.g. the file based implementation ignores the sessions completely.

Sessions should be closed immediately after usage. If it is expensive to open a session for a given backend. The backend should provide a session pool if possible. There are methods for refreshing a session if needed.

You should avoid stacking sessions, which means, you should not create a new session in the same thread, when a session is opened already.

Some backend implementations (JCR) update the metadata in the background, that means update of the metadata is not reflected immediately.

The base metadata coordinates are:

• Repository ID: The identifier of the repository, where the artifact resides
• Namespace: This is a hierarchical coordinate for locating the projects. E.g. this corresponds to the groupId in maven.
• Project ID: The project itself
• Version: Each project may have different versions.
• Artifact: Artifacts correspond to files / blob data. Each artifact has additional metadata, like name, version, modification time, ...

As the repository connects to some backend either locally or remote, the access to the repository may fail. The methods capsule the backend errors into MetadataRepositoryException.

Facets are the way to provide additional metadata that is not part of the base API. It depends on the repository type (e.g. Maven, NPM, not the metadata backend) what facets are stored in addition to the standard metadata. Facets have a specific facet ID that represents the schema for the data stored. For creating specific objects for a given facet id the MetadataFacetFactory is used. For each facet id there may exist multiple facet instances on each level. Facet instances are identified by their name, which may be a hierarchical path. The data in each facet instance is stored in properties (key-value pairs). The properties are converted into / from the specific facet object.

Facets can be stored on repository, project, version and artifact level.

For retrieving artifacts there are methods that return lists and streaming based methods. Some implementations (e.g. JCR) use lazy loading for the retrieved objects. So the streaming methods may be faster and use less memory than the list based methods. But for some backends there is no difference.

Method Summary

Modifier and Type	Method and Description
void	addMetadataFacet(RepositorySession session, String repositoryId, MetadataFacet metadataFacet) Adds a facet to the repository level.
void	close() Closes the repository.
Stream<ArtifactMetadata>	getArtifactByDateRangeStream(RepositorySession session, String repositoryId, ZonedDateTime startTime, ZonedDateTime endTime) Returns all the artifacts who's 'whenGathered' attribute value is inside the given time range (inclusive) as stream of objects.
Stream<ArtifactMetadata>	getArtifactByDateRangeStream(RepositorySession session, String repositoryId, ZonedDateTime startTime, ZonedDateTime endTime, QueryParameter queryParameter) Returns all the artifacts who's 'whenGathered' attribute value is inside the given time range (inclusive) as stream of objects.
List<ArtifactMetadata>	getArtifacts(RepositorySession session, String repositoryId) Returns the metadata for all artifacts of the given repository.
List<ArtifactMetadata>	getArtifacts(RepositorySession session, String repoId, String namespace, String projectId, String projectVersion) Returns the metadata of all artifacts stored for the given project version.
List<ArtifactMetadata>	getArtifactsByAttribute(RepositorySession session, String key, String value, String repositoryId) Get artifacts with an artifact metadata key that matches the passed value.
List<ArtifactMetadata>	getArtifactsByChecksum(RepositorySession session, String repositoryId, String checksum) Returns the artifacts that match the given checksum.
List<ArtifactMetadata>	getArtifactsByDateRange(RepositorySession session, String repositoryId, ZonedDateTime startTime, ZonedDateTime endTime) Is the same as getArtifactsByDateRange(RepositorySession, String, ZonedDateTime, ZonedDateTime, QueryParameter), but uses default query parameters.
List<ArtifactMetadata>	getArtifactsByDateRange(RepositorySession session, String repositoryId, ZonedDateTime startTime, ZonedDateTime endTime, QueryParameter queryParameter) Searches for artifacts where the 'whenGathered' attribute value is between the given start and end time.
List<ArtifactMetadata>	getArtifactsByProjectVersionAttribute(RepositorySession session, String key, String value, String repositoryId) Get artifacts with a attribute on project version level that matches the passed value.
List<ArtifactMetadata>	getArtifactsByProjectVersionFacet(RepositorySession session, String key, String value, String repositoryId) Get artifacts with a project version metadata key that matches the passed value.
Stream<ArtifactMetadata>	getArtifactStream(RepositorySession session, String repositoryId) Returns a stream of all the artifacts in the given repository using default query parameter.
Stream<ArtifactMetadata>	getArtifactStream(RepositorySession session, String repositoryId, QueryParameter queryParameter) Returns a stream of artifacts that are stored in the given repository.
Stream<ArtifactMetadata>	getArtifactStream(RepositorySession session, String repoId, String namespace, String projectId, String projectVersion) Returns a stream of artifacts found for the given artifact coordinates.
Stream<ArtifactMetadata>	getArtifactStream(RepositorySession session, String repoId, String namespace, String projectId, String projectVersion, QueryParameter queryParameter) Returns a stream of artifacts found for the given artifact coordinates and using the queryParameter
List<String>	getArtifactVersions(RepositorySession session, String repoId, String namespace, String projectId, String projectVersion) Returns all artifact version strings for a given project version.
List<String>	getChildNamespaces(RepositorySession session, String repoId, String namespace) Returns the list of namespace names that are children of the given namespace.
<T extends MetadataFacet> T	getMetadataFacet(RepositorySession session, String repositoryId, Class<T> clazz, String name) Returns the facet instance for the given class, which is stored on repository level for the given name.
MetadataFacet	getMetadataFacet(RepositorySession session, String repositoryId, String facetId, String name) Returns the facet data stored on the repository level.
List<String>	getMetadataFacets(RepositorySession session, String repositoryId, String facetId) Return the facet names stored for the given facet id on the repository level.
<T extends MetadataFacet> Stream<T>	getMetadataFacetStream(RepositorySession session, String repositoryId, Class<T> facetClazz) The same as getMetadataFacetStream(RepositorySession, String, Class, QueryParameter) but uses default query parameters.
<T extends MetadataFacet> Stream<T>	getMetadataFacetStream(RepositorySession session, String repositoryId, Class<T> facetClazz, QueryParameter queryParameter) Returns a stream of MetadataFacet elements that match the given facet class.
ProjectMetadata	getProject(RepositorySession session, String repoId, String namespace, String projectId) Returns the metadata for the given project.
List<ProjectVersionReference>	getProjectReferences(RepositorySession session, String repoId, String namespace, String projectId, String projectVersion) Retrieve project references from the metadata repository.
List<String>	getProjects(RepositorySession session, String repoId, String namespace) Return the project names that of all projects stored under the given namespace.
ProjectVersionMetadata	getProjectVersion(RepositorySession session, String repoId, String namespace, String projectId, String projectVersion) Returns the metadata for the project version.
List<String>	getProjectVersions(RepositorySession session, String repoId, String namespace, String projectId) Returns the names of all versions stored under the given project.
List<String>	getRootNamespaces(RepositorySession session, String repoId) Returns the names of the root namespaces stored for this repository.
boolean	hasMetadataFacet(RepositorySession session, String repositoryId, String facetId) Returns true, if there is facet data stored for the given facet id on the repository on repository level.
void	removeArtifact(RepositorySession session, String repositoryId, String namespace, String project, String version, String id) Removes the data for the artifact with the given coordinates from the metadata repository.
void	removeFacetFromArtifact(RepositorySession session, String repositoryId, String namespace, String project, String version, MetadataFacet metadataFacet) FIXME need a unit test!!!
void	removeMetadataFacet(RepositorySession session, String repositoryId, String facetId, String name) Removes the given facet from the repository level, if it exists.
void	removeMetadataFacets(RepositorySession session, String repositoryId, String facetId) Removes all facets with the given facetId from the repository level.
void	removeNamespace(RepositorySession session, String repositoryId, String namespace) Removes the given namespace and its contents from the metadata repository.
void	removeProject(RepositorySession session, String repositoryId, String namespace, String projectId) Removes the project metadata and metadata for all stored versions, artifacts and facets of this project.
void	removeProjectVersion(RepositorySession session, String repoId, String namespace, String projectId, String projectVersion) Removes a project version and all its artifact and facet metadata under it.
void	removeRepository(RepositorySession session, String repositoryId) Deletes all metadata of the given repository.
void	removeTimestampedArtifact(RepositorySession session, ArtifactMetadata artifactMetadata, String baseVersion) Remove timestamped version of artifact.
List<ArtifactMetadata>	searchArtifacts(RepositorySession session, String repositoryId, String text, boolean exact) Full text artifacts search.
List<ArtifactMetadata>	searchArtifacts(RepositorySession session, String repositoryId, String key, String text, boolean exact) Full text artifacts search inside the specified key.
void	updateArtifact(RepositorySession session, String repositoryId, String namespace, String projectId, String projectVersion, ArtifactMetadata artifactMeta) Update the metadata of a given artifact.
void	updateNamespace(RepositorySession session, String repositoryId, String namespace) Create the namespace in the repository, if it does not exist.
void	updateProject(RepositorySession session, String repositoryId, ProjectMetadata project) Update metadata for a particular project in the metadata repository, or create it, if it does not already exist.
void	updateProjectVersion(RepositorySession session, String repositoryId, String namespace, String projectId, ProjectVersionMetadata versionMetadata) Updates the metadata for a specific version of a given project.

Method Detail

updateProject

void updateProject(RepositorySession session,
                   String repositoryId,
                   ProjectMetadata project)
            throws MetadataRepositoryException

Update metadata for a particular project in the metadata repository, or create it, if it does not already exist.

Parameters:

session - The session used for updating.

repositoryId - the repository the project is in

project - the project metadata to create or update

Throws:

MetadataRepositoryException - if the update fails

updateArtifact

void updateArtifact(RepositorySession session,
                    String repositoryId,
                    String namespace,
                    String projectId,
                    String projectVersion,
                    ArtifactMetadata artifactMeta)
             throws MetadataRepositoryException

Update the metadata of a given artifact. If the artifact, namespace, version, project does not exist in the repository it will be created.

Parameters:

session - The repository session

repositoryId - The repository id

namespace - The namespace ('.' separated)

projectId - The project id

projectVersion - The project version

artifactMeta - Information about the artifact itself.

Throws:

MetadataRepositoryException - if something goes wrong during update.

updateProjectVersion

void updateProjectVersion(RepositorySession session,
                          String repositoryId,
                          String namespace,
                          String projectId,
                          ProjectVersionMetadata versionMetadata)
                   throws MetadataRepositoryException

Updates the metadata for a specific version of a given project. If the namespace, project, version does not exist, it will be created.

Parameters:

session - The repository session

repositoryId - The repository id

namespace - The namespace ('.' separated)

projectId - The project id

versionMetadata - The metadata for the version

Throws:

MetadataRepositoryException - if something goes wrong during update

updateNamespace

void updateNamespace(RepositorySession session,
                     String repositoryId,
                     String namespace)
              throws MetadataRepositoryException

Create the namespace in the repository, if it does not exist. Namespaces do not have specific metadata attached.

Parameters:

session - The repository session

repositoryId - The repository id

namespace - The namespace ('.' separated)

Throws:

MetadataRepositoryException - if something goes wrong during update

getMetadataFacets

List<String> getMetadataFacets(RepositorySession session,
                               String repositoryId,
                               String facetId)
                        throws MetadataRepositoryException

Return the facet names stored for the given facet id on the repository level.

Parameters:

session - The repository session

repositoryId - The repository id

facetId - The facet id

Returns:

The list of facet names, or an empty list, if there are no facets stored on this repository for the given facet id.

Throws:

MetadataRepositoryException - if something goes wrong

getMetadataFacetStream

<T extends MetadataFacet> Stream<T> getMetadataFacetStream(RepositorySession session,
                                                           String repositoryId,
                                                           Class<T> facetClazz)
                                                    throws MetadataRepositoryException

The same as getMetadataFacetStream(RepositorySession, String, Class, QueryParameter) but uses default query parameters.

There is no limitation of the number of result objects returned, but implementations may have a hard upper bound for the number of results.

Type Parameters:

T - The facet type

Parameters:

session - The repository session.

repositoryId - The repository id.

facetClazz - The facet class

Returns:

A stream of facet objects, or a empty stream if no facet was found.

Throws:

MetadataRepositoryException - if the facet retrieval fails.

Since:

3.0

getMetadataFacetStream

<T extends MetadataFacet> Stream<T> getMetadataFacetStream(RepositorySession session,
                                                           String repositoryId,
                                                           Class<T> facetClazz,
                                                           QueryParameter queryParameter)
                                                    throws MetadataRepositoryException

Returns a stream of MetadataFacet elements that match the given facet class. Implementations should order the resulting stream by facet name.

Type Parameters:

T - The facet type

Parameters:

session - The repository session

repositoryId - The repository id

facetClazz - The class of the facet

Returns:

A stream of facet objects, or a empty stream if no facet was found.

Throws:

MetadataRepositoryException - if the facet retrieval fails

Since:

3.0

hasMetadataFacet

boolean hasMetadataFacet(RepositorySession session,
                         String repositoryId,
                         String facetId)
                  throws MetadataRepositoryException

Returns true, if there is facet data stored for the given facet id on the repository on repository level. The facet data itself may be empty. It's just checking if there is an object stored for the given facet id.

Parameters:

session - The repository session

repositoryId - The repository id

facetId - The facet id

Returns:

true if there is data stored this facetId on repository level.

Throws:

MetadataRepositoryException - if something goes wrong

Since:

1.4-M4

getMetadataFacet

MetadataFacet getMetadataFacet(RepositorySession session,
                               String repositoryId,
                               String facetId,
                               String name)
                        throws MetadataRepositoryException

Returns the facet data stored on the repository level. The facet instance is identified by the facet id and the facet name. The returned object is a instance created by using MetadataFacetFactory.

Parameters:

session - The repository session

repositoryId - The repository id

facetId - The facet id

name - The attribute name

Returns:

The facet values

Throws:

MetadataRepositoryException - if something goes wrong.

getMetadataFacet

<T extends MetadataFacet> T getMetadataFacet(RepositorySession session,
                                             String repositoryId,
                                             Class<T> clazz,
                                             String name)
                                      throws MetadataRepositoryException

Returns the facet instance for the given class, which is stored on repository level for the given name. If the given name does not point to a instance that can be represented by this class, null will be returned. If the facet is not found the method returns null.

Type Parameters:

T - The type of the facet object

Parameters:

session - The repository session

repositoryId - The id of the repository

clazz - The facet object class

name - The name of the facet (name or path)

Returns:

The facet instance, if it exists.

Throws:

MetadataRepositoryException - if the data cannot be retrieved from the backend

Since:

3.0

addMetadataFacet

void addMetadataFacet(RepositorySession session,
                      String repositoryId,
                      MetadataFacet metadataFacet)
               throws MetadataRepositoryException

Adds a facet to the repository level.

Parameters:

session - The repository session

repositoryId - The id of the repository

metadataFacet - The facet to add

Throws:

MetadataRepositoryException - if the facet cannot be stored.

removeMetadataFacets

void removeMetadataFacets(RepositorySession session,
                          String repositoryId,
                          String facetId)
                   throws MetadataRepositoryException

Removes all facets with the given facetId from the repository level.

Parameters:

session - The repository session

repositoryId - The id of the repository

facetId - The facet id

Throws:

MetadataRepositoryException - if the removal fails

removeMetadataFacet

void removeMetadataFacet(RepositorySession session,
                         String repositoryId,
                         String facetId,
                         String name)
                  throws MetadataRepositoryException

Removes the given facet from the repository level, if it exists.

Parameters:

session - The repository session

repositoryId - The id of the repository

facetId - The facet id

name - The facet name or path

Throws:

MetadataRepositoryException

getArtifactsByDateRange

List<ArtifactMetadata> getArtifactsByDateRange(RepositorySession session,
                                               String repositoryId,
                                               @Nullable
                                               ZonedDateTime startTime,
                                               @Nullable
                                               ZonedDateTime endTime)
                                        throws MetadataRepositoryException

Is the same as getArtifactsByDateRange(RepositorySession, String, ZonedDateTime, ZonedDateTime, QueryParameter), but uses default query parameters.

Throws:

MetadataRepositoryException

getArtifactsByDateRange

List<ArtifactMetadata> getArtifactsByDateRange(RepositorySession session,
                                               String repositoryId,
                                               @Nullable
                                               ZonedDateTime startTime,
                                               @Nullable
                                               ZonedDateTime endTime,
                                               QueryParameter queryParameter)
                                        throws MetadataRepositoryException

Searches for artifacts where the 'whenGathered' attribute value is between the given start and end time. If start or end time or both are null, the time range for the search is unbounded for this parameter.

Parameters:

session - The repository session

repositoryId - The repository id

startTime - The start time/date as zoned date, can be null

endTime - The end time/date as zoned date, can be null

queryParameter - Additional parameters for the query that affect ordering and returned results

Returns:

The list of metadata objects for the found instances.

Throws:

MetadataRepositoryException - if the query fails.

Since:

3.0

getArtifactByDateRangeStream

Stream<ArtifactMetadata> getArtifactByDateRangeStream(RepositorySession session,
                                                      String repositoryId,
                                                      @Nullable
                                                      ZonedDateTime startTime,
                                                      @Nullable
                                                      ZonedDateTime endTime)
                                               throws MetadataRepositoryException

Returns all the artifacts who's 'whenGathered' attribute value is inside the given time range (inclusive) as stream of objects.

Implementations should return a stream of sorted objects. The objects should be sorted by the 'whenGathered' date in ascending order.

Parameters:

session - The repository session

repositoryId - The repository id

startTime - The start time, can be null

endTime - The end time, can be null

Returns:

A stream of artifact metadata objects, or a empty stream if no artifact was found.

Throws:

MetadataRepositoryException - if the artifact retrieval fails.

Since:

3.0

getArtifactByDateRangeStream

Stream<ArtifactMetadata> getArtifactByDateRangeStream(RepositorySession session,
                                                      String repositoryId,
                                                      @Nullable
                                                      ZonedDateTime startTime,
                                                      @Nullable
                                                      ZonedDateTime endTime,
                                                      QueryParameter queryParameter)
                                               throws MetadataRepositoryException

Returns all the artifacts who's 'whenGathered' attribute value is inside the given time range (inclusive) as stream of objects.

If no sort attributes are given by the queryParameter, the result is sorted by the 'whenGathered' date.

Parameters:

session - The repository session

repositoryId - The repository id

startTime - The start time, can be null

endTime - The end time, can be null

queryParameter - Additional parameters for the query that affect ordering and number of returned results.

Returns:

A stream of artifact metadata objects.

Throws:

MetadataRepositoryException - if the artifact retrieval fails.

Since:

3.0

getArtifactsByChecksum

List<ArtifactMetadata> getArtifactsByChecksum(RepositorySession session,
                                              String repositoryId,
                                              String checksum)
                                       throws MetadataRepositoryException

Returns the artifacts that match the given checksum. All checksum types are searched.

Parameters:

session - The repository session

repositoryId - The repository id

checksum - The checksum as string of numbers

Returns:

The list of artifacts that match the given checksum.

Throws:

MetadataRepositoryException - if the artifact retrieval fails

getArtifactsByProjectVersionFacet

List<ArtifactMetadata> getArtifactsByProjectVersionFacet(RepositorySession session,
                                                         String key,
                                                         String value,
                                                         @Nullable
                                                         String repositoryId)
                                                  throws MetadataRepositoryException

Get artifacts with a project version metadata key that matches the passed value.

Parameters:

session - The repository session

key - The attribute key to search

value - The attribute value used for search

repositoryId - can be null, meaning search in all repositories

Returns:

a list of artifacts. A empty list, if no artifact was found.

Throws:

MetadataRepositoryException - if the artifact retrieval fails.

getArtifactsByAttribute

List<ArtifactMetadata> getArtifactsByAttribute(RepositorySession session,
                                               String key,
                                               String value,
                                               @Nullable
                                               String repositoryId)
                                        throws MetadataRepositoryException

Get artifacts with an artifact metadata key that matches the passed value. key ist the string representation of one of the metadata attributes. Only artifacts are returned where the attribute value matches exactly the given search value.

Parameters:

session - The repository session.

key - The string representation of the artifact metadata attribute.

value - The search value.

repositoryId - can be null, meaning search in all repositories

Returns:

a list of artifact objects for each artifact that matches the search string

Throws:

MetadataRepositoryException - if the artifact retrieval fails.

getArtifactsByProjectVersionAttribute

List<ArtifactMetadata> getArtifactsByProjectVersionAttribute(RepositorySession session,
                                                             String key,
                                                             String value,
                                                             @Nullable
                                                             String repositoryId)
                                                      throws MetadataRepositoryException

Get artifacts with a attribute on project version level that matches the passed value. Possible keys are 'scm.url', 'org.name', 'url', 'mailingList.0.name', 'license.0.name',...

Parameters:

session - the repository session.

key - The name of the attribute (may be nested like scm.url, mailinglist.0.name)

value - The value to search for

repositoryId - can be null, which means to search in all repositories

Returns:

a list of artifacts or a empty list, if no artifact was found

Throws:

MetadataRepositoryException - if the artifact retrieval fails

removeArtifact

void removeArtifact(RepositorySession session,
                    String repositoryId,
                    String namespace,
                    String project,
                    String version,
                    String id)
             throws MetadataRepositoryException

Removes the data for the artifact with the given coordinates from the metadata repository. This will not remove the artifact itself from the storage. It will only remove the metadata.

Parameters:

session - The repository session

repositoryId - The repository id

namespace - The namespace of the project

project - The project name

version - The project version

id - The artifact id

Throws:

MetadataRepositoryException - if the artifact retrieval fails, or if the artifact cannot be found.

removeTimestampedArtifact

void removeTimestampedArtifact(RepositorySession session,
                               ArtifactMetadata artifactMetadata,
                               String baseVersion)
                        throws MetadataRepositoryException

Remove timestamped version of artifact. This removes a snapshot artifact by giving the artifact metadata and the base version of the project.

Parameters:

session - The repository session

artifactMetadata - the artifactMetadata with the timestamped version (2.0-20120618.214135-2)

baseVersion - the base version of the snapshot (2.0-SNAPSHOT)

Throws:

MetadataRepositoryException - if the removal fails.

Since:

1.4-M3

removeFacetFromArtifact

void removeFacetFromArtifact(RepositorySession session,
                             String repositoryId,
                             String namespace,
                             String project,
                             String version,
                             MetadataFacet metadataFacet)
                      throws MetadataRepositoryException

FIXME need a unit test!!! Removes the MetadataFacet of the given artifact.

Parameters:

session - The repository session

repositoryId - The repository id.

namespace - The namespace

project - The project name

version - The project version

metadataFacet - The facet data

Throws:

MetadataRepositoryException - if the removal failed

Since:

1.4-M3

removeRepository

void removeRepository(RepositorySession session,
                      String repositoryId)
               throws MetadataRepositoryException

Deletes all metadata of the given repository. This includes artifact metadata and all associated metadata facets.

Parameters:

session - The repository session

repositoryId - the repository to delete

Throws:

MetadataRepositoryException - if the removal failed

removeNamespace

void removeNamespace(RepositorySession session,
                     String repositoryId,
                     String namespace)
              throws MetadataRepositoryException

Removes the given namespace and its contents from the metadata repository.

Parameters:

session - The repository session

repositoryId - The repository id

namespace - The namespace '.' separated ( it's the groupId for maven )

Throws:

MetadataRepositoryException - if the removal failed

Since:

1.4-M3

getArtifacts

List<ArtifactMetadata> getArtifacts(RepositorySession session,
                                    String repositoryId)
                             throws MetadataRepositoryException

Returns the metadata for all artifacts of the given repository.

Parameters:

session - The repository session

repositoryId - The repository id

Returns:

a list of artifact metadata objects. A empty list if no artifacts where found.

Throws:

MetadataRepositoryException - if the retrieval failed.

getArtifactStream

Stream<ArtifactMetadata> getArtifactStream(RepositorySession session,
                                           String repositoryId,
                                           QueryParameter queryParameter)
                                    throws MetadataResolutionException

Returns a stream of artifacts that are stored in the given repository. The number and order of elements in the stream is defined by the queryParameter. The efficiency of ordering of elements is dependent on the implementation. There may be some implementations that have to put a hard limit on the elements returned. If there are no sortFields defined in the query parameter, the order of elements in the stream is undefined and depends on the implementation.

Parameters:

session - The repository session.

repositoryId - The repository id.

Returns:

A stream of artifact metadata objects for each artifact found in the repository.

Throws:

MetadataResolutionException

Since:

3.0

getArtifactStream

Stream<ArtifactMetadata> getArtifactStream(RepositorySession session,
                                           String repositoryId)
                                    throws MetadataResolutionException

Returns a stream of all the artifacts in the given repository using default query parameter. The order of the artifacts returned in the stream depends on the implementation. The number of elements in the stream is unlimited, but there may be some implementations that have to put a hard limit on the elements returned. For further information see getArtifactStream(RepositorySession, String, QueryParameter)

Parameters:

session - The repository session

repositoryId - The repository id

Returns:

A (unlimited) stream of artifact metadata elements that are found in this repository

Throws:

MetadataResolutionException

Since:

3.0

See Also:

getArtifactStream(RepositorySession, String, QueryParameter)

getArtifactStream

Stream<ArtifactMetadata> getArtifactStream(RepositorySession session,
                                           String repoId,
                                           String namespace,
                                           String projectId,
                                           String projectVersion,
                                           QueryParameter queryParameter)
                                    throws MetadataResolutionException

Returns a stream of artifacts found for the given artifact coordinates and using the queryParameter

Parameters:

session - The repository session. May not be null.

repoId - The repository id. May not be null.

namespace - The namespace. May not be null.

projectId - The project id. May not be null.

projectVersion - The project version. May not be null.

Returns:

A stream of artifact metadata object. Order and number of elements returned, depends on the queryParameter.

Throws:

MetadataResolutionException - if there are no elements for the given artifact coordinates.

Since:

3.0

getArtifactStream

Stream<ArtifactMetadata> getArtifactStream(RepositorySession session,
                                           String repoId,
                                           String namespace,
                                           String projectId,
                                           String projectVersion)
                                    throws MetadataResolutionException

Returns a stream of artifacts found for the given artifact coordinates. The order of elements returned, depends on the implementation.

Parameters:

session - The repository session. May not be null.

repoId - The repository id. May not be null.

namespace - The namespace. May not be null.

projectId - The project id. May not be null.

projectVersion - The project version. May not be null.

Returns:

A stream of artifact metadata object. Order and number of elements returned, depends on the queryParameter.

Throws:

MetadataResolutionException - if there are no elements for the given artifact coordinates.

Since:

3.0

getProject

ProjectMetadata getProject(RepositorySession session,
                           String repoId,
                           String namespace,
                           String projectId)
                    throws MetadataResolutionException

Returns the metadata for the given project. If there are no custom properties stored on the project, it will just return a ProjectMetadata object with the data provided by parameters.

Parameters:

session - The session id

repoId - The repository id

namespace - The namespace '.'-separated.

projectId - The project name

Returns:

The project metadata or null if not found.

Throws:

MetadataResolutionException - if the metadata retrieval failed

getProjectVersion

ProjectVersionMetadata getProjectVersion(RepositorySession session,
                                         String repoId,
                                         String namespace,
                                         String projectId,
                                         String projectVersion)
                                  throws MetadataResolutionException

Returns the metadata for the project version.

Parameters:

session - The repository session.

repoId - The repository id.

namespace - The namespace '.'-separated

projectId - The project name

projectVersion - The project version

Returns:

The version metadata object, or null, if not found.

Throws:

MetadataResolutionException - if the retrieval of the metadata failed.

getArtifactVersions

List<String> getArtifactVersions(RepositorySession session,
                                 String repoId,
                                 String namespace,
                                 String projectId,
                                 String projectVersion)
                          throws MetadataResolutionException

Returns all artifact version strings for a given project version. This is for snapshot versions and returns the timestamped versions, if available.

Parameters:

session - The repository session.

repoId - The repository id.

namespace - The namespace '.'-separated

projectId - The project name.

projectVersion - The project version.

Returns:

A list of version strings, or a empty list if no versions are found, or this is not a snapshot version.

Throws:

MetadataResolutionException - if the retrieval of the metadata failed.

getProjectReferences

List<ProjectVersionReference> getProjectReferences(RepositorySession session,
                                                   String repoId,
                                                   String namespace,
                                                   String projectId,
                                                   String projectVersion)
                                            throws MetadataResolutionException

Retrieve project references from the metadata repository. Note that this is not built into the content model for a project version as a reference may be present (due to reverse-lookup of dependencies) before the actual project is, and we want to avoid adding a stub model to the content repository.

Parameters:

session - The repository session.

repoId - The repository ID to look within

namespace - The namespace of the project to get references to

projectId - The identifier of the project to get references to

projectVersion - The version of the project to get references to

Returns:

a list of project references

Throws:

MetadataResolutionException - if the version could not be found.

getRootNamespaces

List<String> getRootNamespaces(RepositorySession session,
                               String repoId)
                        throws MetadataResolutionException

Returns the names of the root namespaces stored for this repository.

Parameters:

session - The repository session.

repoId - The repository id.

Returns:

A list of namespace names, or empty list, if no namespace is stored for this repository.

Throws:

MetadataResolutionException - If the retrieval failed.

getChildNamespaces

List<String> getChildNamespaces(RepositorySession session,
                                String repoId,
                                String namespace)
                         throws MetadataResolutionException

Returns the list of namespace names that are children of the given namespace. It does not descend recursively.

Parameters:

session - The repository session.

repoId - The repository id.

namespace - The parent namespace '.'-separated.

Returns:

List of child namespace names, or a empty list, if there are no children for the given parent namespace.

Throws:

MetadataResolutionException - if the retrieval failed.

getProjects

List<String> getProjects(RepositorySession session,
                         String repoId,
                         String namespace)
                  throws MetadataResolutionException

Return the project names that of all projects stored under the given namespace.

Parameters:

session - The repository session.

repoId - The repository id.

namespace - The namespace '.'-separated.

Returns:

The list of project names or empty list if no project exists at the given namespace.

Throws:

MetadataResolutionException - if the retrieval failed.

getProjectVersions

List<String> getProjectVersions(RepositorySession session,
                                String repoId,
                                String namespace,
                                String projectId)
                         throws MetadataResolutionException

Returns the names of all versions stored under the given project.

Parameters:

session - The repository session.

repoId - The repository id.

namespace - The namespace '.'-separated.

projectId - The project name.

Returns:

The list of versions or a empty list, if not version was found.

Throws:

MetadataResolutionException - if the retrieval failed.

removeProjectVersion

void removeProjectVersion(RepositorySession session,
                          String repoId,
                          String namespace,
                          String projectId,
                          String projectVersion)
                   throws MetadataRepositoryException

Removes a project version and all its artifact and facet metadata under it.

Parameters:

session - The repository session.

repoId - The repository id.

namespace - The namespace '.'-separated.

projectId - The project name

projectVersion - The project version.

Throws:

MetadataRepositoryException - if the removal failed.

Since:

1.4-M4

getArtifacts

List<ArtifactMetadata> getArtifacts(RepositorySession session,
                                    String repoId,
                                    String namespace,
                                    String projectId,
                                    String projectVersion)
                             throws MetadataResolutionException

Returns the metadata of all artifacts stored for the given project version.

Parameters:

session - The repository session.

repoId - The repository id.

namespace - The namespace '.'-separated.

projectId - The project name.

projectVersion - The project version.

Returns:

The list of artifact metadata objects, or a empty list, if no artifact exists for this version.

Throws:

MetadataResolutionException - if the retrieval failed.

removeProject

void removeProject(RepositorySession session,
                   String repositoryId,
                   String namespace,
                   String projectId)
            throws MetadataRepositoryException

Removes the project metadata and metadata for all stored versions, artifacts and facets of this project.

Parameters:

session - The repository session.

repositoryId - The repository id.

namespace - The namespace '.'-separated.

projectId - The project name.

Throws:

MetadataRepositoryException - if the removal failed.

Since:

1.4-M4

close

void close()
    throws MetadataRepositoryException

Closes the repository. Repositories are normally opened during startup and closed on shutdown. The closing of a repository stops all invalidates all connections to it. Sessions that are open are invalidated too. The repository will throw exceptions if it is used after closing.

Throws:

MetadataRepositoryException - if the something went wrong or if the repository was closed already.

searchArtifacts

List<ArtifactMetadata> searchArtifacts(RepositorySession session,
                                       String repositoryId,
                                       String text,
                                       boolean exact)
                                throws MetadataRepositoryException

Full text artifacts search. Searches for the given string in all metadata and returns artifacts where the text was found.

Parameters:

session - The repository session.

repositoryId - can be null to search in all repositories

text - The search text

exact - if true, the value must exactly match the text.

Returns:

a list of artifacts or empty list if no results where found.

Throws:

MetadataRepositoryException - if the retrieval failed.

searchArtifacts

List<ArtifactMetadata> searchArtifacts(RepositorySession session,
                                       String repositoryId,
                                       String key,
                                       String text,
                                       boolean exact)
                                throws MetadataRepositoryException

Full text artifacts search inside the specified key. Searches for the given text in all attributes with the given name.

Parameters:

session - The repository session.

repositoryId - can be null to search in all repositories

key - search only inside this attribute.

text - The search string.

exact - if true, the value must exactly match the text.

Returns:

a list of artifacts or empty list if no results were found.

Throws:

MetadataRepositoryException - if the retrieval failed.