AbstractMetadataRepository (Archiva

java.lang.Object
- org.apache.archiva.metadata.repository.AbstractMetadataRepository

All Implemented Interfaces:: MetadataRepository

public abstract class AbstractMetadataRepository
extends Object
implements MetadataRepository

Constructor Summary

Constructors
Constructor and Description

AbstractMetadataRepository()

Constructors
Constructor and Description
`AbstractMetadataRepository()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addMetadataFacet(String repositoryId, MetadataFacet metadataFacet)`
`boolean`	`canObtainAccess(Class<?> aClass)`
`void`	`close()`
`List<ArtifactMetadata>`	`getArtifacts(String repositoryId)`
`Collection<ArtifactMetadata>`	`getArtifacts(String repoId, String namespace, String projectId, String projectVersion)`
`Collection<ArtifactMetadata>`	`getArtifactsByChecksum(String repositoryId, String checksum)`
`List<ArtifactMetadata>`	`getArtifactsByDateRange(String repositoryId, Date startTime, Date endTime)` if startTime or endTime are `null` they are not used for search
`List<ArtifactMetadata>`	`getArtifactsByMetadata(String key, String value, String repositoryId)` Get artifacts with an artifact metadata key that matches the passed value.
`List<ArtifactMetadata>`	`getArtifactsByProjectVersionMetadata(String key, String value, String repositoryId)` Get artifacts with a project version metadata key that matches the passed value.
`List<ArtifactMetadata>`	`getArtifactsByProperty(String key, String value, String repositoryId)` Get artifacts with a property key that matches the passed value.
`Collection<String>`	`getArtifactVersions(String repoId, String namespace, String projectId, String projectVersion)`
`MetadataFacet`	`getMetadataFacet(String repositoryId, String facetId, String name)`
`List<String>`	`getMetadataFacets(String repositoryId, String facetId)`
`Collection<String>`	`getNamespaces(String repoId, String namespace)`
`ProjectMetadata`	`getProject(String repoId, String namespace, String projectId)` basically just checking it exists not complete data returned
`Collection<ProjectVersionReference>`	`getProjectReferences(String repoId, String namespace, String projectId, String projectVersion)` Retrieve project references from the metadata repository.
`Collection<String>`	`getProjects(String repoId, String namespace)`
`ProjectVersionMetadata`	`getProjectVersion(String repoId, String namespace, String projectId, String projectVersion)`
`Collection<String>`	`getProjectVersions(String repoId, String namespace, String projectId)`
`Collection<String>`	`getRepositories()`
`Collection<String>`	`getRootNamespaces(String repoId)`
`boolean`	`hasMetadataFacet(String repositoryId, String facetId)`
`<T> T`	`obtainAccess(Class<T> aClass)`
`void`	`removeArtifact(ArtifactMetadata artifactMetadata, String baseVersion)` used for deleting timestamped version of SNAPSHOT artifacts
`void`	`removeArtifact(String repositoryId, String namespace, String project, String version, MetadataFacet metadataFacet)` FIXME need a unit test!!! Only remove `MetadataFacet` for the artifact
`void`	`removeArtifact(String repositoryId, String namespace, String project, String version, String id)`
`void`	`removeMetadataFacet(String repositoryId, String facetId, String name)`
`void`	`removeMetadataFacets(String repositoryId, String facetId)`
`void`	`removeNamespace(String repositoryId, String namespace)`
`void`	`removeProject(String repositoryId, String namespace, String projectId)` remove a project
`void`	`removeProjectVersion(String repoId, String namespace, String projectId, String projectVersion)`
`void`	`removeRepository(String repositoryId)` Delete a repository's metadata.
`void`	`revert()` implementations can throw RuntimeException
`void`	`save()` implementations can throw RuntimeException
`List<ArtifactMetadata>`	`searchArtifacts(String text, String repositoryId, boolean exact)` Full text artifacts search.
`List<ArtifactMetadata>`	`searchArtifacts(String key, String text, String repositoryId, boolean exact)` Full text artifacts search inside the specified key.
`void`	`updateArtifact(String repositoryId, String namespace, String projectId, String projectVersion, ArtifactMetadata artifactMeta)`
`void`	`updateNamespace(String repositoryId, String namespace)` create the namespace in the repository.
`void`	`updateProject(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(String repositoryId, String namespace, String projectId, ProjectVersionMetadata versionMetadata)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- AbstractMetadataRepository
```
public AbstractMetadataRepository()
```

Method Detail

updateProject
```
public void updateProject(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:
repositoryId - the repository the project is in
project - the project metadata to create or update

Throws:

MetadataRepositoryException

updateArtifact

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

Specified by:: updateArtifact in interface MetadataRepository
Throws:: MetadataRepositoryException

updateProjectVersion

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

Specified by:: updateProjectVersion in interface MetadataRepository
Throws:: MetadataRepositoryException

updateNamespace
```
public void updateNamespace(String repositoryId,
                   String namespace)
                     throws MetadataRepositoryException
```
Description copied from interface: MetadataRepository

create the namespace in the repository. (if not exist)

Specified by:

updateNamespace in interface MetadataRepository

Throws:

MetadataRepositoryException

getMetadataFacets

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

Specified by:: getMetadataFacets in interface MetadataRepository
Throws:: MetadataRepositoryException

hasMetadataFacet

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

Specified by:: hasMetadataFacet in interface MetadataRepository
Returns:: true if the repository datas for this facetId
Throws:: MetadataRepositoryException

getMetadataFacet

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

Specified by:: getMetadataFacet in interface MetadataRepository
Throws:: MetadataRepositoryException

addMetadataFacet

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

Specified by:: addMetadataFacet in interface MetadataRepository
Throws:: MetadataRepositoryException

removeMetadataFacets

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

Specified by:: removeMetadataFacets in interface MetadataRepository
Throws:: MetadataRepositoryException

removeMetadataFacet

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

Specified by:: removeMetadataFacet in interface MetadataRepository
Throws:: MetadataRepositoryException

getArtifactsByDateRange

public List<ArtifactMetadata> getArtifactsByDateRange(String repositoryId,
                                             Date startTime,
                                             Date endTime)
                                               throws MetadataRepositoryException

Description copied from interface: MetadataRepository

if startTime or endTime are null they are not used for search

Specified by:: getArtifactsByDateRange in interface MetadataRepository; startTime - can be null; endTime - can be null
Returns:
Throws:: MetadataRepositoryException

getRepositories

public Collection<String> getRepositories()
                                   throws MetadataRepositoryException

Specified by:: getRepositories in interface MetadataRepository
Throws:: MetadataRepositoryException

getArtifactsByChecksum

public Collection<ArtifactMetadata> getArtifactsByChecksum(String repositoryId,
                                                  String checksum)
                                                    throws MetadataRepositoryException

Specified by:: getArtifactsByChecksum in interface MetadataRepository
Throws:: MetadataRepositoryException

getArtifactsByProjectVersionMetadata

public List<ArtifactMetadata> getArtifactsByProjectVersionMetadata(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:: getArtifactsByProjectVersionMetadata in interface MetadataRepository; repositoryId - can be null, meaning search in all repositories
Returns:: a list of artifacts
Throws:: MetadataRepositoryException

getArtifactsByMetadata

public List<ArtifactMetadata> getArtifactsByMetadata(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.

Specified by:: getArtifactsByMetadata in interface MetadataRepository; repositoryId - can be null, meaning search in all repositories
Returns:: a list of artifacts
Throws:: MetadataRepositoryException

getArtifactsByProperty
```
public List<ArtifactMetadata> getArtifactsByProperty(String key,
                                            String value,
                                            String repositoryId)
                                              throws MetadataRepositoryException
```
Description copied from interface: MetadataRepository

Get artifacts with a property key that matches the passed value. Possible keys are 'scm.url', 'org.name', 'url', 'mailingList.0.name', 'license.0.name',...

Specified by:

getArtifactsByProperty in interface MetadataRepository

repositoryId - can be null, meaning search in all repositories

Returns:
a list of artifacts

Throws:

MetadataRepositoryException

removeArtifact

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

Specified by:: removeArtifact in interface MetadataRepository
Throws:: MetadataRepositoryException

removeArtifact
```
public void removeArtifact(ArtifactMetadata artifactMetadata,
                  String baseVersion)
                    throws MetadataRepositoryException
```
Description copied from interface: MetadataRepository

used for deleting timestamped version of SNAPSHOT artifacts

Specified by:

removeArtifact in interface MetadataRepository

Parameters:
artifactMetadata - the artifactMetadata with the timestamped version (2.0-20120618.214135-2)
baseVersion - the base version of the snapshot (2.0-SNAPSHOT)

Throws:

MetadataRepositoryException

removeArtifact

public void removeArtifact(String repositoryId,
                  String namespace,
                  String project,
                  String version,
                  MetadataFacet metadataFacet)
                    throws MetadataRepositoryException

Description copied from interface: MetadataRepository

FIXME need a unit test!!! Only remove MetadataFacet for the artifact

Specified by:: removeArtifact in interface MetadataRepository
Throws:: MetadataRepositoryException

removeRepository
```
public void removeRepository(String repositoryId)
                      throws MetadataRepositoryException
```
Description copied from interface: MetadataRepository

Delete a repository's metadata. This includes all associated metadata facets.

Specified by:

removeRepository in interface MetadataRepository

Parameters:
repositoryId - the repository to delete

Throws:

MetadataRepositoryException

removeNamespace

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

Specified by:: removeNamespace in interface MetadataRepository; namespace - (groupId for maven )
Throws:: MetadataRepositoryException

getArtifacts

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

Specified by:: getArtifacts in interface MetadataRepository
Throws:: MetadataRepositoryException

getProject

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

Description copied from interface: MetadataRepository

basically just checking it exists not complete data returned

Specified by:: getProject in interface MetadataRepository
Returns:
Throws:: MetadataResolutionException

getProjectVersion

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

Specified by:: getProjectVersion in interface MetadataRepository
Throws:: MetadataResolutionException

getArtifactVersions

public Collection<String> getArtifactVersions(String repoId,
                                     String namespace,
                                     String projectId,
                                     String projectVersion)
                                       throws MetadataResolutionException

Specified by:: getArtifactVersions in interface MetadataRepository
Throws:: MetadataResolutionException

getProjectReferences
```
public Collection<ProjectVersionReference> getProjectReferences(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:
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

getRootNamespaces

public Collection<String> getRootNamespaces(String repoId)
                                     throws MetadataResolutionException

Specified by:: getRootNamespaces in interface MetadataRepository
Throws:: MetadataResolutionException

getNamespaces

public Collection<String> getNamespaces(String repoId,
                               String namespace)
                                 throws MetadataResolutionException

Specified by:: getNamespaces in interface MetadataRepository
Returns:: Collection of child namespaces of the namespace argument
Throws:: MetadataResolutionException

getProjects

public Collection<String> getProjects(String repoId,
                             String namespace)
                               throws MetadataResolutionException

Specified by:: getProjects in interface MetadataRepository
Returns:
Throws:: MetadataResolutionException

getProjectVersions

public Collection<String> getProjectVersions(String repoId,
                                    String namespace,
                                    String projectId)
                                      throws MetadataResolutionException

Specified by:: getProjectVersions in interface MetadataRepository
Returns:
Throws:: MetadataResolutionException

removeProjectVersion

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

Specified by:: removeProjectVersion in interface MetadataRepository
Throws:: MetadataRepositoryException

getArtifacts

public Collection<ArtifactMetadata> getArtifacts(String repoId,
                                        String namespace,
                                        String projectId,
                                        String projectVersion)
                                          throws MetadataResolutionException

Specified by:: getArtifacts in interface MetadataRepository
Returns:
Throws:: MetadataResolutionException

removeProject

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

Description copied from interface: MetadataRepository

remove a project

Specified by:: removeProject in interface MetadataRepository
Throws:: MetadataRepositoryException

save
```
public void save()
```
Description copied from interface: MetadataRepository

implementations can throw RuntimeException

Specified by:

save in interface MetadataRepository

close
```
public void close()
           throws MetadataRepositoryException
```
Specified by:

close in interface MetadataRepository

Throws:

MetadataRepositoryException

revert
```
public void revert()
```
Description copied from interface: MetadataRepository

implementations can throw RuntimeException

Specified by:

revert in interface MetadataRepository

canObtainAccess
```
public boolean canObtainAccess(Class<?> aClass)
```
Specified by:

canObtainAccess in interface MetadataRepository

obtainAccess
```
public <T> T obtainAccess(Class<T> aClass)
               throws MetadataRepositoryException
```
Specified by:

obtainAccess in interface MetadataRepository

Throws:

MetadataRepositoryException

searchArtifacts
```
public List<ArtifactMetadata> searchArtifacts(String text,
                                     String repositoryId,
                                     boolean exact)
                                       throws MetadataRepositoryException
```
Description copied from interface: MetadataRepository

Full text artifacts search.

Specified by:

searchArtifacts in interface MetadataRepository

repositoryId - can be null to search in all repositories
exact - running an exact search, the value must exactly match the text.

Returns:
a list of artifacts

Throws:

MetadataRepositoryException

searchArtifacts
```
public List<ArtifactMetadata> searchArtifacts(String key,
                                     String text,
                                     String repositoryId,
                                     boolean exact)
                                       throws MetadataRepositoryException
```
Description copied from interface: MetadataRepository

Full text artifacts search inside the specified key.

Specified by:

searchArtifacts in interface MetadataRepository

Parameters:
key - search only inside this key
repositoryId - can be null to search in all repositories
exact - running an exact search, the value must exactly match the text.

Returns:
a list of artifacts

Throws:

MetadataRepositoryException

Class AbstractMetadataRepository

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractMetadataRepository

Method Detail

updateProject

updateArtifact

updateProjectVersion

updateNamespace

getMetadataFacets

hasMetadataFacet

getMetadataFacet

addMetadataFacet

removeMetadataFacets

removeMetadataFacet

getArtifactsByDateRange

getRepositories

getArtifactsByChecksum

getArtifactsByProjectVersionMetadata

getArtifactsByMetadata

getArtifactsByProperty

removeArtifact

removeArtifact

removeArtifact

removeRepository

removeNamespace

getArtifacts

getProject

getProjectVersion

getArtifactVersions

getProjectReferences

getRootNamespaces

getNamespaces

getProjects

getProjectVersions

removeProjectVersion

getArtifacts

removeProject

save

close

revert

canObtainAccess

obtainAccess

searchArtifacts

searchArtifacts