org.apache.archiva.metadata.repository

Class AbstractMetadataRepository

java.lang.Object

org.apache.archiva.metadata.repository.AbstractMetadataRepository

All Implemented Interfaces:

MetadataRepository

Direct Known Subclasses:

CassandraMetadataRepository, FileMetadataRepository, JcrMetadataRepository

public abstract class AbstractMetadataRepository
extends Object
implements MetadataRepository

Field Summary

Fields

Modifier and Type	Field and Description
protected MetadataService	metadataService

Constructor Summary

Constructors

Constructor and Description
AbstractMetadataRepository()
AbstractMetadataRepository(MetadataService metadataService)

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.
protected static Comparator<ArtifactMetadata>	getArtifactMetadataComparator(QueryParameter queryParameter, String defaultAttr)
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 repoId, ZonedDateTime startTime, ZonedDateTime endTime) Is the same as MetadataRepository.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.
protected <T extends MetadataFacet> MetadataFacetFactory	getFacetFactory(Class<T> facetClazz)
protected MetadataFacetFactory	getFacetFactory(String facetId)
protected Class<? extends MetadataFacet>	getFactoryClassForId(String facetId)
<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 MetadataRepository.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.
protected Set<String>	getSupportedFacets()
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.

Methods inherited from class java.lang.Object

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

Field Detail

metadataService

protected MetadataService metadataService

Constructor Detail

AbstractMetadataRepository

public AbstractMetadataRepository()

AbstractMetadataRepository

public AbstractMetadataRepository(MetadataService metadataService)

Method Detail

updateProject

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

Description copied from interface: MetadataRepository

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

Specified by:

updateProject in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

updateArtifact in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

updateProjectVersion in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

updateNamespace in interface MetadataRepository

Parameters:

session - The repository session

repositoryId - The repository id

namespace - The namespace ('.' separated)

Throws:

MetadataRepositoryException - if something goes wrong during update

getMetadataFacets

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

Description copied from interface: MetadataRepository

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

Specified by:

getMetadataFacets in interface MetadataRepository

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

hasMetadataFacet

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

Description copied from interface: MetadataRepository

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.

Specified by:

hasMetadataFacet in interface MetadataRepository

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

addMetadataFacet

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

Description copied from interface: MetadataRepository

Adds a facet to the repository level.

Specified by:

addMetadataFacet in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

removeMetadataFacets in interface MetadataRepository

Parameters:

session - The repository session

repositoryId - The id of the repository

facetId - The facet id

Throws:

MetadataRepositoryException - if the removal fails

removeMetadataFacet

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

Description copied from interface: MetadataRepository

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

Specified by:

removeMetadataFacet in interface MetadataRepository

Parameters:

session - The repository session

repositoryId - The id of the repository

facetId - The facet id

name - The facet name or path

Throws:

MetadataRepositoryException

getArtifactsByDateRange

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

Description copied from interface: MetadataRepository

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.

Specified by:

getArtifactsByDateRange in interface MetadataRepository

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.

getArtifactsByChecksum

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

Description copied from interface: MetadataRepository

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

Specified by:

getArtifactsByChecksum in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

getArtifactsByProjectVersionFacet in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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.

Specified by:

getArtifactsByAttribute in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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',...

Specified by:

getArtifactsByProjectVersionAttribute in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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.

Specified by:

removeArtifact in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

removeTimestampedArtifact in interface MetadataRepository

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.

removeFacetFromArtifact

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

Description copied from interface: MetadataRepository

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

Specified by:

removeFacetFromArtifact in interface MetadataRepository

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

removeRepository

public void removeRepository(RepositorySession session,
                             String repositoryId)
                      throws MetadataRepositoryException

Description copied from interface: MetadataRepository

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

Specified by:

removeRepository in interface MetadataRepository

Parameters:

session - The repository session

repositoryId - the repository to delete

Throws:

MetadataRepositoryException - if the removal failed

removeNamespace

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

Description copied from interface: MetadataRepository

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

Specified by:

removeNamespace in interface MetadataRepository

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

getArtifacts

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

Description copied from interface: MetadataRepository

Returns the metadata for all artifacts of the given repository.

Specified by:

getArtifacts in interface MetadataRepository

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.

getProject

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

Description copied from interface: MetadataRepository

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.

Specified by:

getProject in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

Returns the metadata for the project version.

Specified by:

getProjectVersion in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

getArtifactVersions in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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.

Specified by:

getProjectReferences in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

getRootNamespaces in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

getChildNamespaces in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

getProjects in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

getProjectVersions in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

removeProjectVersion in interface MetadataRepository

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.

getArtifactMetadataComparator

protected static Comparator<ArtifactMetadata> getArtifactMetadataComparator(QueryParameter queryParameter,
                                                                            String defaultAttr)

getArtifacts

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

Description copied from interface: MetadataRepository

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

Specified by:

getArtifacts in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

removeProject in interface MetadataRepository

Parameters:

session - The repository session.

repositoryId - The repository id.

namespace - The namespace '.'-separated.

projectId - The project name.

Throws:

MetadataRepositoryException - if the removal failed.

close

public void close()
           throws MetadataRepositoryException

Description copied from interface: MetadataRepository

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.

Specified by:

close in interface MetadataRepository

Throws:

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

searchArtifacts

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

Description copied from interface: MetadataRepository

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

Specified by:

searchArtifacts in interface MetadataRepository

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

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

Description copied from interface: MetadataRepository

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

Specified by:

searchArtifacts in interface MetadataRepository

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.

getMetadataFacetStream

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

Description copied from interface: MetadataRepository

The same as MetadataRepository.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.

Specified by:

getMetadataFacetStream in interface MetadataRepository

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.

getArtifactByDateRangeStream

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

Description copied from interface: MetadataRepository

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.

Specified by:

getArtifactByDateRangeStream in interface MetadataRepository

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.

getMetadataFacet

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

Description copied from interface: MetadataRepository

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.

Specified by:

getMetadataFacet in interface MetadataRepository

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.

getMetadataFacetStream

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

Description copied from interface: MetadataRepository

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

Specified by:

getMetadataFacetStream in interface MetadataRepository

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

getMetadataFacet

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

Description copied from interface: MetadataRepository

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.

Specified by:

getMetadataFacet in interface MetadataRepository

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

getArtifactByDateRangeStream

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

Description copied from interface: MetadataRepository

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.

Specified by:

getArtifactByDateRangeStream in interface MetadataRepository

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.

getFacetFactory

protected <T extends MetadataFacet> MetadataFacetFactory getFacetFactory(Class<T> facetClazz)

getFacetFactory

protected MetadataFacetFactory getFacetFactory(String facetId)

getSupportedFacets

protected Set<String> getSupportedFacets()

getFactoryClassForId

protected Class<? extends MetadataFacet> getFactoryClassForId(String facetId)

getArtifactsByDateRange

public List<ArtifactMetadata> getArtifactsByDateRange(RepositorySession session,
                                                      String repoId,
                                                      ZonedDateTime startTime,
                                                      ZonedDateTime endTime)
                                               throws MetadataRepositoryException

Description copied from interface: MetadataRepository

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

Specified by:

getArtifactsByDateRange in interface MetadataRepository

Throws:

MetadataRepositoryException

getArtifactStream

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

Description copied from interface: MetadataRepository

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 MetadataRepository.getArtifactStream(RepositorySession, String, QueryParameter)

Specified by:

getArtifactStream in interface MetadataRepository

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

See Also:

MetadataRepository.getArtifactStream(RepositorySession, String, QueryParameter)

getArtifactStream

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

Description copied from interface: MetadataRepository

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

Specified by:

getArtifactStream in interface MetadataRepository

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.

getArtifactStream

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

Description copied from interface: MetadataRepository

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.

Specified by:

getArtifactStream in interface MetadataRepository

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

getArtifactStream

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

Description copied from interface: MetadataRepository

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

Specified by:

getArtifactStream in interface MetadataRepository

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.