Package com.atlassian.bamboo.plugins.github

Class GitHubBranchDetector

java.lang.Object
com.atlassian.bamboo.plugins.github.AbstractGitHubExecutor
com.atlassian.bamboo.plugins.github.GitHubBranchDetector
All Implemented Interfaces:
IdentifyingExecutor<VcsBranchDetector>, VcsBranchDetector
public class GitHubBranchDetector extends AbstractGitHubExecutor implements VcsBranchDetector

  • Constructor Details

    • GitHubBranchDetector

      @Inject public GitHubBranchDetector(VcsRepositoryManager vcsRepositoryManager)

  • Method Details

    • getVcsIdForExecutor

      @Nullable public @Nullable ContextualVcsId<VcsBranchDetector> getVcsIdForExecutor(@NotNull @NotNull VcsRepositoryData vcsRepositoryData)
      Description copied from interface: IdentifyingExecutor
      Returned id has to fulfill the following: Given two VcsRepositoryData objects A and B, and executor e returning equal ContextualVcsId (in terms of equals()), for any operation foo() provided by the executor, the calls e::foo(A) and e::foo(B) should be equivalent. To be more precise: given any time point t and any variable context v, calling a::foo(A) should yield the same results as calling e::foo(B). Given the above it follows that - calculation of the id should take into account global and plan variables. This means, that calling this method on the same object in different variable context can (possibly must) yield different results. - equal ids need not (and should not) guarantee equal call results over indefinite time. In particular, result of e:foo(A).equals(e::foo(A)) is allowed to be false, since 2 calls to e::foo(A) do not happen at the same time. Example: 2 git repositories with the same url and credentials are considered equal in context of VcsBranchDetector. If they also point to the same branch, they are considered equal in context of VcsChangeDetector
      Specified by:
      getVcsIdForExecutor in interface IdentifyingExecutor<VcsBranchDetector>
      Returns:
      the id of repository, can be null if no feasible identification algorithm exists

    • getOpenBranches

      @NotNull public @NotNull List<VcsBranch> getOpenBranches(@NotNull @NotNull VcsRepositoryData repositoryData) throws RepositoryException
      Description copied from interface: VcsBranchDetector
      Set of open branches that are discovered in the repository. Returns empty collection if no branches at all (can that happen?). Used for monitoring repositories for new branches. An open branch is a branch that is considered 'open' by underlying VCS - it has nothing to do with the actual development on that branch (recent commits or so).
      Specified by:
      getOpenBranches in interface VcsBranchDetector
      Returns:
      List of branch names. May be empty.
      Throws:
      RepositoryException

    • getLastCommit

      @NotNull public @NotNull CommitContext getLastCommit(@NotNull @NotNull VcsRepositoryData repositoryData) throws RepositoryException
      Description copied from interface: VcsBranchDetector
      Retrieve last commit on the branch set on this Repository. Method is used by Chain Branch automatic expiry. If this method returns null Chain Branch is not expired.
      Specified by:
      getLastCommit in interface VcsBranchDetector
      Returns:
      the last commit
      Throws:
      RepositoryException

    • getFirstCommitApproximation

      @NotNull public @NotNull CommitContext getFirstCommitApproximation(@NotNull @NotNull VcsRepositoryData repositoryData) throws RepositoryException
      Description copied from interface: VcsBranchDetector
      Retrieve an old, preferably the first commit on a branch. Implementations must not return null. The default implementation may return null.
      Specified by:
      getFirstCommitApproximation in interface VcsBranchDetector
      Throws:
      RepositoryException

    • getFirstCommit

      @Nullable public @Nullable CommitContext getFirstCommit(@NotNull @NotNull VcsRepositoryData repositoryData) throws RepositoryException
      Description copied from interface: VcsBranchDetector
      Retrieve the commit that created the Branch (if that information is possible to retrieve)
      Specified by:
      getFirstCommit in interface VcsBranchDetector
      Returns:
      the first commit to the branch or null if N/A.
      Throws:
      RepositoryException