This project has retired. For details please refer to its Attic page.
RepositoryBrowsing

org.apache.maven.archiva.database.browsing
Interface RepositoryBrowsing

Package class diagram package RepositoryBrowsing
All Known Implementing Classes:
DefaultRepositoryBrowsing

public interface RepositoryBrowsing

Repository Browsing component


Method Summary
 java.util.List<java.lang.String> getOtherSnapshotVersions(java.util.List<java.lang.String> observableRepositoryIds, java.lang.String groupId, java.lang.String artifactId, java.lang.String version)
          Get the other versions of the given SNAPSHOT version.
 java.lang.String getRepositoryId(java.lang.String principle, java.util.List<java.lang.String> observableRepositoryIds, java.lang.String groupId, java.lang.String artifactId, java.lang.String version)
           
 BrowsingResults getRoot(java.lang.String principle, java.util.List<java.lang.String> observableRepositoryIds)
          Get the BrowsingResults for the root of the repository.
 java.util.List<org.apache.maven.archiva.model.ArchivaProjectModel> getUsedBy(java.lang.String principle, java.util.List<java.lang.String> observableRepositoryIds, java.lang.String groupId, java.lang.String artifactId, java.lang.String version)
          Get the List of ArchivaProjectModel that are used by the provided groupId, artifactId, and version specified.
 BrowsingResults selectArtifactId(java.lang.String principle, java.util.List<java.lang.String> observableRepositoryIds, java.lang.String groupId, java.lang.String artifactId)
          Get the BrowsingResults for the selected groupId & artifactId.
 BrowsingResults selectGroupId(java.lang.String principle, java.util.List<java.lang.String> observableRepositoryIds, java.lang.String groupId)
          Get the BrowsingResults for the selected groupId.
 org.apache.maven.archiva.model.ArchivaProjectModel selectVersion(java.lang.String principle, java.util.List<java.lang.String> observableRepositoryIds, java.lang.String groupId, java.lang.String artifactId, java.lang.String version)
          Get the ArchivaProjectModel for the selected groupId / artifactId / version combo.
 

Method Detail

getRoot

BrowsingResults getRoot(java.lang.String principle,
                        java.util.List<java.lang.String> observableRepositoryIds)
Get the BrowsingResults for the root of the repository.

Returns:
the root browsing results.

selectGroupId

BrowsingResults selectGroupId(java.lang.String principle,
                              java.util.List<java.lang.String> observableRepositoryIds,
                              java.lang.String groupId)
Get the BrowsingResults for the selected groupId.

Parameters:
groupId - the groupId to select.
Returns:
the BrowsingResults for the specified groupId.

selectArtifactId

BrowsingResults selectArtifactId(java.lang.String principle,
                                 java.util.List<java.lang.String> observableRepositoryIds,
                                 java.lang.String groupId,
                                 java.lang.String artifactId)
Get the BrowsingResults for the selected groupId & artifactId.

Parameters:
groupId - the groupId selected
artifactId - the artifactId selected
Returns:
the BrowsingResults for the specified groupId / artifactId combo.

selectVersion

org.apache.maven.archiva.model.ArchivaProjectModel selectVersion(java.lang.String principle,
                                                                 java.util.List<java.lang.String> observableRepositoryIds,
                                                                 java.lang.String groupId,
                                                                 java.lang.String artifactId,
                                                                 java.lang.String version)
                                                                 throws ObjectNotFoundException,
                                                                        ArchivaDatabaseException
Get the ArchivaProjectModel for the selected groupId / artifactId / version combo.

Parameters:
groupId - the groupId selected
artifactId - the artifactId selected
version - the version selected
Returns:
the ArchivaProjectModel for the selected groupId / artifactId / version combo.
Throws:
ObjectNotFoundException - if the artifact object or project object isn't found in the database.
ArchivaDatabaseException - if there is a fundamental database error.

getUsedBy

java.util.List<org.apache.maven.archiva.model.ArchivaProjectModel> getUsedBy(java.lang.String principle,
                                                                             java.util.List<java.lang.String> observableRepositoryIds,
                                                                             java.lang.String groupId,
                                                                             java.lang.String artifactId,
                                                                             java.lang.String version)
                                                                             throws ArchivaDatabaseException
Get the List of ArchivaProjectModel that are used by the provided groupId, artifactId, and version specified.

Parameters:
groupId - the groupId selected
artifactId - the artifactId selected
version - the version selected
Returns:
the List of ArchivaProjectModel objects. (never null, but can be empty)
Throws:
ArchivaDatabaseException - if there is a fundamental database error.

getRepositoryId

java.lang.String getRepositoryId(java.lang.String principle,
                                 java.util.List<java.lang.String> observableRepositoryIds,
                                 java.lang.String groupId,
                                 java.lang.String artifactId,
                                 java.lang.String version)
                                 throws ObjectNotFoundException,
                                        ArchivaDatabaseException
Throws:
ObjectNotFoundException
ArchivaDatabaseException

getOtherSnapshotVersions

java.util.List<java.lang.String> getOtherSnapshotVersions(java.util.List<java.lang.String> observableRepositoryIds,
                                                          java.lang.String groupId,
                                                          java.lang.String artifactId,
                                                          java.lang.String version)
                                                          throws ObjectNotFoundException,
                                                                 ArchivaDatabaseException
Get the other versions of the given SNAPSHOT version.

Parameters:
observableRepositoryIds -
groupId -
artifactId -
version -
Returns:
Throws:
ObjectNotFoundException
ArchivaDatabaseException