HistoryService

Retrieves a page of changes between sinceId (exclusively) and untilId (inclusively).

Retrieves a page of changes between two changesets. If the since changeset is not specified, the until changeset's first parent is used automatically.

Retrieves a changeset by its id or the most recent changeset affecting a branch or tag. The specified attributesToLoad will also be loaded. These attributes are metadata associated with the changeset by a given ChangesetIndexer.

Retrieves the most recent changeset affecting the specified repository and path, starting from the changeset identified by changesetId, which may be a commit, branch or tag.

Retrieves the most recent changeset affecting the specified repository and path, starting from the changeset identified by changesetId, which may be a commit, branch or tag. The specified attributesToLoad will also be loaded. These attributes are metadata associated with the changeset by a given ChangesetIndexer.

Retrieves a changeset by its id or the most recent changeset affecting a branch or tag.

Retrieves a page of changesets for the provided path on the specified branch.

If the provided changesetId is null, the default branch for the repository will be assumed. If the path is null, changesets are returned starting from (and including) the provided changesetId (where, again, the repository's default branch will be used if null). As a result this service call may be used to:

• Retrieve pages of changesets on a given branch or tag
• Retrieve pages of ancestral changesets for a given changeset
• Retrieve pages of changesets where a given file has be modified

Note: If the provided path is renamed at some point in its history, changesets will not follow the path across the rename. In other words, only changesets for the exact path provided will be included.

Retrieves a page of changesets for the provided path on the specified branch.

If the provided changesetId is null, the default branch for the repository will be assumed. If the path is null, changesets are returned starting from (and including) the provided changesetId (where, again, the repository's default branch will be used if null). As a result this service call may be used to:

• Retrieve pages of changesets on a given branch or tag
• Retrieve pages of ancestral changesets for a given changeset
• Retrieve pages of changesets where a given file has be modified

Note: If the provided path is renamed at some point in its history, changesets will not follow the path across the rename. In other words, only changesets for the exact path provided will be included.

Retrieves a page of changesets between the included changesets and the excluded changesets. Included and excluded changesets may be specified by branch or tag name or by hash. The changesets returned are those which are reachable an included changeset and not reachable from any excluded changeset. While this may imply an ancestral relationship between include and exclude IDs, that is not strictly required. When the IDs are unrelated, all changesets referenceable from included changesets are candidates for the returned page, and excluded changesets are effectively ignored. Paths may be provided to further narrow the results, restricting the returned changesets to only those affecting one or more of the specified paths.

Which changesets are included and which are excluded is important here. Consider the following example:

1. Branch "feature-A" was created from "master" when "master" was at changeset A
2. Changesets FA1, FA2 and FA3 were created on the "feature-A" branch
3. Changesets B and C were made on "master" after the branch was created

 ---- A ---- B ---- C
       \
        \
        FA1 ---- FA2 ---- FA3
 

Warning: Changesets specified using branch or tag names, will be resolved against the primary repository. When retrieving changesets between repositories, changesets in the secondary repository may only be specified by hash. This means requesting a page like this will not work:

     ChangesetsBetweenRequest request = new ChangesetsBetweenRequest.Builder(repository)
             .exclude("master")
             .include("master")
             .secondaryRepository(forkOfRepository)
             .build();
     Page<Changeset> page = historyService.getChangesetsBetween(request, PageUtils.newRequest(0, 25));
 

Retrieves each of the changesets in getChangesetIds() changesetIds} and returns their details, including the first page of changes between the changeset in question and its first parent.

If the page size is less than the size of the collection of IDs, a subset of the collection will be returned. Otherwise, detailed changesets for all IDs in the requested collection are returned.

Streams changes between the until and since changesets. If the since changeset is not specified, the until changeset's first parent is used automatically.

Streams changesets between the included changesets and the excluded changesets.

This method promises to call onStart(ChangesetContext) on the supplied callback once followed by zero or more calls to onChangeset(Changeset), one for each changeset to be streamed (until false is returned by onChangeset(...) or there are no more changesets), followed by a single call to onEnd(ChangesetSummary).

See getChangesetsBetween(...) for a description of the semantics of the changesets returned.