com.atlassian.crucible.spi.services

Interface RepositoryService

public interface RepositoryService

Provides an API for working with repositories

Method Summary

Modifier and Type	Method and Description
java.util.List<RepositoryData>	getRepositories() Deprecated. since 3.6.0. Use getRepositories(com.atlassian.crucible.spi.data.RepositoryDataSearchCriteria, com.atlassian.fecru.page.PageRequest) instead.
Page<RepositoryData>	getRepositories(RepositoryDataSearchCriteria criteria, PageRequest pageRequest) Returns filtered list of repositories in this instance that the current user has access to.
RepositoryData	getRepository(java.lang.String name) Returns the details of the repository with the specified key.
RepositoryIndexingStatus	getRepositoryIndexingStatus(java.lang.String name) Returns indexing status for the repository with the specified key.
SCMRepository	getSCMRepository(java.lang.String name) Returns an SCMRepository instance for the Crucible source repository with the given key.

Method Detail

getRepositories

@Deprecated
java.util.List<RepositoryData> getRepositories()

Deprecated. since 3.6.0. Use getRepositories(com.atlassian.crucible.spi.data.RepositoryDataSearchCriteria, com.atlassian.fecru.page.PageRequest) instead.

Returns the details of all the repositories in this instance that the current user has access to.

Returns:

list of repositories the current user has access to

getRepositories

Page<RepositoryData> getRepositories(RepositoryDataSearchCriteria criteria,
                                     PageRequest pageRequest)

Returns filtered list of repositories in this instance that the current user has access to.

Parameters:

criteria - criteria to filter down repositories.

pageRequest - controls fragment of results to be returned.

Returns:

page of repositories the current user has access to.

Since:

3.6.0

getRepository

RepositoryData getRepository(java.lang.String name)

Returns the details of the repository with the specified key. When the repository does not exist or the user has no access to it (possibly because the user is not authenticated), a NotFoundException is raised. The supplied repository key can be either a Crucible SCM plugin repository, or a FishEye repository.

Parameters:

name - the key of a repository.

Returns:

details of the repository with the specified key

getRepositoryIndexingStatus

RepositoryIndexingStatus getRepositoryIndexingStatus(java.lang.String name)

Returns indexing status for the repository with the specified key. When the repository does not exist or the user has no access to it (possibly because the user is not authenticated), a NotFoundException is raised.

Parameters:

name - the key of a repository

Returns:

indexing status of the repository with the specified key.

getSCMRepository

SCMRepository getSCMRepository(java.lang.String name)

Returns an SCMRepository instance for the Crucible source repository with the given key. Crucible source repositories are repositories of type "plugin" and implement PluginRepositoryData.

This method will return null for FishEye repositories. To browse and search FishEye repositories, use the services provided by the com.atlassian.fisheye.spi.services package.

This method requires the caller to be logged in, or Crucible must be configured to allow anonymous access.

Parameters:

name - the key of a Crucible SCM plugin repository.

Returns:

a Crucible source repository with the given key

Throws:

NotPermittedException - when the caller is not logged in and Crucible does not allow anonymous access.

Since:

v2.1