com.atlassian.fisheye.spi.services

Interface RevisionDataService

public interface RevisionDataService

Provides an API for getting information about changesets and filerevisions indexed by fisheye

Method Summary

Modifier and Type	Method and Description
ChangesetDataFE	getChangeset(java.lang.String repository, java.lang.String csid)
FileRevisionData	getRevision(java.lang.String repository, java.lang.String path, java.lang.String rev)
RevisionGraphSliceData	getSliceInRevisionGraph(java.lang.String repository, java.lang.String startingRev, int max, Direction direction)
RevisionGraphSliceData	getSliceInRevisionGraph(java.lang.String repository, java.lang.String startingRev, java.util.Set<java.lang.String> branches, int max, Direction direction)
ChangesetsData	listChangesets(java.lang.String repository, java.lang.String path)
ChangesetsData	listChangesets(java.lang.String repository, java.lang.String path, java.util.Date start)
ChangesetsData	listChangesets(java.lang.String repository, java.lang.String path, java.util.Date start, java.util.Date end, int max)
java.util.List<FileRevisionData>	listPathHistory(java.lang.String repository, java.lang.String path)
java.util.List<PathInfoData>	listPaths(java.lang.String repository, java.lang.String path)
java.util.List<java.lang.String>	listTagsForRevision(java.lang.String repository, java.lang.String path, java.lang.String rev)

Method Detail

listPaths

java.util.List<PathInfoData> listPaths(java.lang.String repository,
                                       java.lang.String path)

Parameters:

repository - the key of the repository to query

path - the path to query, with respect to the fisheye repository root

Returns:

a list of information about files and directories in the path

getRevision

FileRevisionData getRevision(java.lang.String repository,
                             java.lang.String path,
                             java.lang.String rev)

Parameters:

repository - the key of the repository to query

path - the path of the filerevision, with respect to the fisheye repository root

rev - the id of the filerevision to retrieve

Returns:

information about the specified filerevision

listTagsForRevision

java.util.List<java.lang.String> listTagsForRevision(java.lang.String repository,
                                                     java.lang.String path,
                                                     java.lang.String rev)

Parameters:

repository - the key of the repository to query

path - the path of the filerevision, with respect to the fisheye repository root

rev - the id of the filerevision to retrieve

Returns:

a list of tags associated with this revision

listPathHistory

java.util.List<FileRevisionData> listPathHistory(java.lang.String repository,
                                                 java.lang.String path)

Parameters:

repository - the key of the repository to query

path - the path to query

Returns:

a list of the filerevisions of this path

getChangeset

ChangesetDataFE getChangeset(java.lang.String repository,
                             java.lang.String csid)

Parameters:

repository - the key of the repository to query

csid - the ChangesetID of the changeset to return

Returns:

the changeset specified by csid

Throws:

NotFoundException - if the changeset doesn't exist

listChangesets

ChangesetsData listChangesets(java.lang.String repository,
                              java.lang.String path)

Parameters:

repository - the key of the repository to query

path - restrict the changesets to those in this path, should be "/" to look at the whole repository

Returns:

the list of changeset ids, and the value of maxReturn (the limit to the number of changesets to return)

listChangesets

ChangesetsData listChangesets(java.lang.String repository,
                              java.lang.String path,
                              java.util.Date start)

Parameters:

repository - the key of the repository to query

path - restrict the changesets to those in this path, should be "/" to look at the whole repository

start - only return changesets after this date

Returns:

the list of changeset ids, and the value of maxReturn (the limit to the number of changesets to return)

listChangesets

ChangesetsData listChangesets(java.lang.String repository,
                              java.lang.String path,
                              java.util.Date start,
                              java.util.Date end,
                              int max)

Parameters:

repository - the key of the repository to query

path - restrict the changesets to those in this path, should be "/" to look at the whole repository

start - only return changesets after this date

end - only return changesets before this date

max - the maximum number of changesets to return, must be greater than 0

Returns:

the list of changeset ids, and the value of maxReturn (the limit to the number of changesets to return)

getSliceInRevisionGraph

RevisionGraphSliceData getSliceInRevisionGraph(java.lang.String repository,
                                               java.lang.String startingRev,
                                               int max,
                                               Direction direction)

Parameters:

repository - the key of the repository to query

startingRev - the revision to start from

max - the maximum number of revisions to return

direction - specifies whether changesets before, after or in both directions from the startingRev are returned

Returns:

a set of changesets in the in the changeset graph for the specified slice

getSliceInRevisionGraph

RevisionGraphSliceData getSliceInRevisionGraph(java.lang.String repository,
                                               java.lang.String startingRev,
                                               java.util.Set<java.lang.String> branches,
                                               int max,
                                               Direction direction)

Parameters:

repository - the key of the repository to query

startingRev - the changeset to start from

branches - the branches to restrict the query to

max - the maximum number of revisions to return

direction - specifies whether changesets before, after or in both directions from the startingRev are returned

Returns:

a set of changesets in the in the changeset graph for the specified slice