org.apache.archiva.rest.services

Class DefaultBrowseService

java.lang.Object

org.apache.archiva.rest.services.AbstractRestService

org.apache.archiva.rest.services.DefaultBrowseService

All Implemented Interfaces:

BrowseService

@Service(value="browseService#rest")
public class DefaultBrowseService
extends AbstractRestService
implements BrowseService

Since:

1.4-M3

Author:

Olivier Lamy

Field Summary

Fields inherited from class org.apache.archiva.rest.services.AbstractRestService

archivaAdministration, config, httpServletRequest, httpServletResponse, log, proxyConnectorAdmin, repositoryRegistry, repositorySessionFactory, repositoryTaskScheduler, userRepositories

Constructor Summary

Constructors

Constructor and Description
DefaultBrowseService()

Method Summary

Modifier and Type	Method and Description
Boolean	addMetadata(String groupId, String artifactId, String version, String key, String value, String repositoryId)
Boolean	artifactAvailable(String groupId, String artifactId, String version, String repositoryId) verify if an artifact is available locally if not download from proxies will be try
Boolean	artifactAvailable(String groupId, String artifactId, String version, String classifier, String repositoryId) verify if an artifact is available locally if not download from proxies will be try
BrowseResult	browseGroupId(String groupId, String repositoryId)
Boolean	deleteMetadata(String groupId, String artifactId, String version, String key, String repositoryId)
List<ArtifactContentEntry>	getArtifactContentEntries(String groupId, String artifactId, String version, String classifier, String type, String path, String repositoryId)
ArtifactContent	getArtifactContentText(String groupId, String artifactId, String version, String classifier, String type, String path, String repositoryId) if path is empty content of the file is returned (for pom view)
List<Artifact>	getArtifactDownloadInfos(String groupId, String artifactId, String version, String repositoryId)
List<Artifact>	getArtifacts(String repositoryId) return List of all artifacts from this repository
List<Artifact>	getArtifactsByMetadata(String key, String value, String repositoryId) Return List of artifacts from this repository with artifact metadata key matching value.
List<Artifact>	getArtifactsByProjectVersionMetadata(String key, String value, String repositoryId) Return List of artifacts from this repository with project version level metadata key matching value.
List<Artifact>	getArtifactsByProperty(String key, String value, String repositoryId) Return List of artifacts from this repository with property key matching value.
List<Artifact>	getDependees(String groupId, String artifactId, String version, String repositoryId) List of artifacts using the artifact passed in parameter.
List<Entry>	getMetadatas(String groupId, String artifactId, String version, String repositoryId)
ProjectVersionMetadata	getProjectMetadata(String groupId, String artifactId, String version, String repositoryId)
ProjectVersionMetadata	getProjectVersionMetadata(String groupId, String artifactId, String repositoryId)
BrowseResult	getRootGroups(String repositoryId)
List<TreeEntry>	getTreeEntries(String groupId, String artifactId, String version, String repositoryId) return the dependency Tree for an artifacts the List result has only one entry
List<ManagedRepository>	getUserManagableRepositories()
List<ManagedRepository>	getUserRepositories()
org.apache.archiva.components.cache.Cache<String,ProjectVersionMetadata>	getVersionMetadataCache()
VersionsList	getVersionsList(String groupId, String artifactId, String repositoryId)
Boolean	importMetadata(MetadataAddRequest metadataAddRequest, String repositoryId)
protected List<ArtifactContentEntry>	readFileEntries(StorageAsset file, String filterPath, String repoId)
List<Artifact>	searchArtifacts(String text, String repositoryId, Boolean exact) Search artifacts with any property matching text.
List<Artifact>	searchArtifacts(String key, String text, String repositoryId, Boolean exact) Search artifacts with the property specified by key matching text.
void	setVersionMetadataCache(org.apache.archiva.components.cache.Cache<String,ProjectVersionMetadata> versionMetadataCache)

Methods inherited from class org.apache.archiva.rest.services.AbstractRestService

buildArtifacts, doScanRepository, getArtifactUrl, getArtifactUrl, getAuditInformation, getAuditListeners, getBaseUrl, getBeansOfType, getModelMapper, getObservableRepos, getPrincipal, setAuditListeners, triggerAuditEvent

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBrowseService

public DefaultBrowseService()

Method Detail

getRootGroups

public BrowseResult getRootGroups(String repositoryId)
                           throws ArchivaRestServiceException

Specified by:

getRootGroups in interface BrowseService

Throws:

ArchivaRestServiceException

browseGroupId

public BrowseResult browseGroupId(String groupId,
                                  String repositoryId)
                           throws ArchivaRestServiceException

Specified by:

browseGroupId in interface BrowseService

Parameters:

groupId - groupId to browse

repositoryId - optionnal (repository to browse if null all available user repositories are used)

Throws:

ArchivaRestServiceException

getVersionsList

public VersionsList getVersionsList(String groupId,
                                    String artifactId,
                                    String repositoryId)
                             throws ArchivaRestServiceException

Specified by:

getVersionsList in interface BrowseService

Throws:

ArchivaRestServiceException

getProjectMetadata

public ProjectVersionMetadata getProjectMetadata(String groupId,
                                                 String artifactId,
                                                 String version,
                                                 String repositoryId)
                                          throws ArchivaRestServiceException

Specified by:

getProjectMetadata in interface BrowseService

Throws:

ArchivaRestServiceException

getProjectVersionMetadata

public ProjectVersionMetadata getProjectVersionMetadata(String groupId,
                                                        String artifactId,
                                                        String repositoryId)
                                                 throws ArchivaRestServiceException

Specified by:

getProjectVersionMetadata in interface BrowseService

Throws:

ArchivaRestServiceException

getTreeEntries

public List<TreeEntry> getTreeEntries(String groupId,
                                      String artifactId,
                                      String version,
                                      String repositoryId)
                               throws ArchivaRestServiceException

Description copied from interface: BrowseService

return the dependency Tree for an artifacts the List result has only one entry

Specified by:

getTreeEntries in interface BrowseService

Throws:

ArchivaRestServiceException

getUserRepositories

public List<ManagedRepository> getUserRepositories()
                                            throws ArchivaRestServiceException

Specified by:

getUserRepositories in interface BrowseService

Returns:

List of managed repositories current user can read

Throws:

ArchivaRestServiceException

getUserManagableRepositories

public List<ManagedRepository> getUserManagableRepositories()
                                                     throws ArchivaRestServiceException

Specified by:

getUserManagableRepositories in interface BrowseService

Returns:

List of repositories current user can manage

Throws:

ArchivaRestServiceException

getDependees

public List<Artifact> getDependees(String groupId,
                                   String artifactId,
                                   String version,
                                   String repositoryId)
                            throws ArchivaRestServiceException

Description copied from interface: BrowseService

List of artifacts using the artifact passed in parameter.

Specified by:

getDependees in interface BrowseService

Throws:

ArchivaRestServiceException

getMetadatas

public List<Entry> getMetadatas(String groupId,
                                String artifactId,
                                String version,
                                String repositoryId)
                         throws ArchivaRestServiceException

Specified by:

getMetadatas in interface BrowseService

Throws:

ArchivaRestServiceException

addMetadata

public Boolean addMetadata(String groupId,
                           String artifactId,
                           String version,
                           String key,
                           String value,
                           String repositoryId)
                    throws ArchivaRestServiceException

Specified by:

addMetadata in interface BrowseService

Throws:

ArchivaRestServiceException

deleteMetadata

public Boolean deleteMetadata(String groupId,
                              String artifactId,
                              String version,
                              String key,
                              String repositoryId)
                       throws ArchivaRestServiceException

Specified by:

deleteMetadata in interface BrowseService

Throws:

ArchivaRestServiceException

getArtifactContentEntries

public List<ArtifactContentEntry> getArtifactContentEntries(String groupId,
                                                            String artifactId,
                                                            String version,
                                                            String classifier,
                                                            String type,
                                                            String path,
                                                            String repositoryId)
                                                     throws ArchivaRestServiceException

Specified by:

getArtifactContentEntries in interface BrowseService

Throws:

ArchivaRestServiceException

getArtifactDownloadInfos

public List<Artifact> getArtifactDownloadInfos(String groupId,
                                               String artifactId,
                                               String version,
                                               String repositoryId)
                                        throws ArchivaRestServiceException

Specified by:

getArtifactDownloadInfos in interface BrowseService

Throws:

ArchivaRestServiceException

getArtifactContentText

public ArtifactContent getArtifactContentText(String groupId,
                                              String artifactId,
                                              String version,
                                              String classifier,
                                              String type,
                                              String path,
                                              String repositoryId)
                                       throws ArchivaRestServiceException

Description copied from interface: BrowseService

if path is empty content of the file is returned (for pom view)

Specified by:

getArtifactContentText in interface BrowseService

Throws:

ArchivaRestServiceException

artifactAvailable

public Boolean artifactAvailable(String groupId,
                                 String artifactId,
                                 String version,
                                 String classifier,
                                 String repositoryId)
                          throws ArchivaRestServiceException

Description copied from interface: BrowseService

verify if an artifact is available locally if not download from proxies will be try

Specified by:

artifactAvailable in interface BrowseService

Throws:

ArchivaRestServiceException

artifactAvailable

public Boolean artifactAvailable(String groupId,
                                 String artifactId,
                                 String version,
                                 String repositoryId)
                          throws ArchivaRestServiceException

Description copied from interface: BrowseService

verify if an artifact is available locally if not download from proxies will be try

Specified by:

artifactAvailable in interface BrowseService

Throws:

ArchivaRestServiceException

getArtifacts

public List<Artifact> getArtifacts(String repositoryId)
                            throws ArchivaRestServiceException

Description copied from interface: BrowseService

return List of all artifacts from this repository

Specified by:

getArtifacts in interface BrowseService

Returns:

Throws:

ArchivaRestServiceException

getArtifactsByProjectVersionMetadata

public List<Artifact> getArtifactsByProjectVersionMetadata(String key,
                                                           String value,
                                                           String repositoryId)
                                                    throws ArchivaRestServiceException

Description copied from interface: BrowseService

Return List of artifacts from this repository with project version level metadata key matching value. If repository is not provided the search runs in all repositories.

Specified by:

getArtifactsByProjectVersionMetadata in interface BrowseService

Returns:

Throws:

ArchivaRestServiceException

getArtifactsByMetadata

public List<Artifact> getArtifactsByMetadata(String key,
                                             String value,
                                             String repositoryId)
                                      throws ArchivaRestServiceException

Description copied from interface: BrowseService

Return List of artifacts from this repository with artifact metadata key matching value. If repository is not provided the search runs in all repositories.

Specified by:

getArtifactsByMetadata in interface BrowseService

Returns:

Throws:

ArchivaRestServiceException

getArtifactsByProperty

public List<Artifact> getArtifactsByProperty(String key,
                                             String value,
                                             String repositoryId)
                                      throws ArchivaRestServiceException

Description copied from interface: BrowseService

Return List of artifacts from this repository with property key matching value. If repository is not provided the search runs in all repositories.

Specified by:

getArtifactsByProperty in interface BrowseService

Returns:

Throws:

ArchivaRestServiceException

importMetadata

public Boolean importMetadata(MetadataAddRequest metadataAddRequest,
                              String repositoryId)
                       throws ArchivaRestServiceException

Specified by:

importMetadata in interface BrowseService

Throws:

ArchivaRestServiceException

searchArtifacts

public List<Artifact> searchArtifacts(String text,
                                      String repositoryId,
                                      Boolean exact)
                               throws ArchivaRestServiceException

Description copied from interface: BrowseService

Search artifacts with any property matching text. If repository is not provided the search runs in all repositories. If exact is true only the artifacts whose property match exactly are returned.

Specified by:

searchArtifacts in interface BrowseService

Returns:

Throws:

ArchivaRestServiceException

searchArtifacts

public List<Artifact> searchArtifacts(String key,
                                      String text,
                                      String repositoryId,
                                      Boolean exact)
                               throws ArchivaRestServiceException

Description copied from interface: BrowseService

Search artifacts with the property specified by key matching text. If repository is not provided the search runs in all repositories. If exact is true only the artifacts whose property match exactly are returned.

Specified by:

searchArtifacts in interface BrowseService

Returns:

Throws:

ArchivaRestServiceException

readFileEntries

protected List<ArtifactContentEntry> readFileEntries(StorageAsset file,
                                                     String filterPath,
                                                     String repoId)
                                              throws IOException

Throws:

IOException

getVersionMetadataCache

public org.apache.archiva.components.cache.Cache<String,ProjectVersionMetadata> getVersionMetadataCache()

setVersionMetadataCache

public void setVersionMetadataCache(org.apache.archiva.components.cache.Cache<String,ProjectVersionMetadata> versionMetadataCache)