Package hudson.plugins.git

Interface IGitAPI

All Superinterfaces:

GitClient

All Known Implementing Classes:

CliGitAPIImpl, GitAPI, JGitAPIImpl

@Deprecated
public interface IGitAPI
extends GitClient

Deprecated.

methods here are deprecated until proven useful by a plugin

IGitAPI interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jenkinsci.plugins.gitclient.GitClient

GitClient.ConfigLevel

Field Summary

Fields inherited from interface org.jenkinsci.plugins.gitclient.GitClient

CREDENTIALS_MATCHER, quietRemoteBranches, verbose

Method Summary

Modifier and Type	Method	Description
void	changelog(String revFrom, String revTo, OutputStream fos)	Deprecated. changelog.
void	checkoutBranch(String branch, String commitish)	Deprecated. Regardless of the current state of the workspace (whether there is some dirty files, etc) and the state of the repository (whether the branch of the specified name exists or not), when this method exits the following conditions hold: The branch of the specified name branch exists and points to the specified ref HEAD points to branch.
void	clone(org.eclipse.jgit.transport.RemoteConfig source)	Deprecated. Clone repository from source to this repository.
void	clone(org.eclipse.jgit.transport.RemoteConfig rc, boolean useShallowClone)	Deprecated. Clone repository from RemoteConfig rc to this repository.
void	fetch()	Deprecated. Retrieve commits from default remote.
void	fetch(String repository, String refspec)	Deprecated. Retrieve commits based on refspec from repository.
void	fetch(org.eclipse.jgit.transport.RemoteConfig remoteRepository)	Deprecated. Retrieve commits from RemoteConfig.
void	fixSubmoduleUrls(String remote, TaskListener listener)	Deprecated. fixSubmoduleUrls.
String	getAllLogEntries(String branch)	Deprecated.
List<Branch>	getBranchesContaining(String revspec)	Deprecated. Use GitClient.getBranchesContaining(String, boolean) instead.
String	getDefaultRemote(String _default_)	Deprecated. Returns name of default remote.
String	getRemoteUrl(String name, String GIT_DIR)	Deprecated. Returns URL of remote name in repository GIT_DIR.
String	getSubmoduleUrl(String name)	Deprecated. Returns URL of the named submodule.
List<Tag>	getTagsOnCommit(String revName)	Deprecated. getTagsOnCommit.
boolean	hasGitModules(String treeIsh)	Deprecated. Returns true if this repository has submodules.
boolean	isBareRepository()	Deprecated. Returns true if this repository is bare.
boolean	isBareRepository(String GIT_DIR)	Deprecated. Detect whether a repository at the given path is bare or not.
List<IndexEntry>	lsTree(String treeIsh)	Deprecated. Use lsTree(String, boolean) to be explicit about the recursion behaviour.
List<IndexEntry>	lsTree(String treeIsh, boolean recursive)	Deprecated. lsTree.
void	merge(String revSpec)	Deprecated. Merge commits from revspec into the current branch.
org.eclipse.jgit.lib.ObjectId	mergeBase(org.eclipse.jgit.lib.ObjectId sha1, org.eclipse.jgit.lib.ObjectId sha2)	Deprecated. mergeBase.
void	push(org.eclipse.jgit.transport.RemoteConfig repository, String revspec)	Deprecated. Push revspec to repository.
void	reset()	Deprecated. Reset the contents of the working directory of this repository.
void	reset(boolean hard)	Deprecated. Reset the contents of the working directory of this repository.
List<org.eclipse.jgit.lib.ObjectId>	revListBranch(String branchId)	Deprecated. revListBranch.
void	setRemoteUrl(String name, String url, String GIT_DIR)	Deprecated. Set remote repository name and URL.
void	setSubmoduleUrl(String name, String url)	Deprecated. Sets URL of the named submodule.
void	setupSubmoduleUrls(String remote, TaskListener listener)	Deprecated.
List<String>	showRevision(Revision r)	Deprecated. showRevision.
void	submoduleSync()	Deprecated. Synchronizes submodules' remote URL configuration setting to the value specified in .gitmodules.

Methods inherited from interface org.jenkinsci.plugins.gitclient.GitClient

add, addCredentials, addDefaultCredentials, addNote, addRemoteUrl, addSubmodule, appendNote, branch, changelog, changelog, checkout, checkout, checkout, clean, clean, clearCredentials, clone, clone_, commit, commit, config, deleteBranch, deleteRef, deleteTag, describe, fetch, fetch, fetch, fetch_, getBranches, getBranchesContaining, getHeadRev, getHeadRev, getRefNames, getRemoteBranches, getRemoteReferences, getRemoteSymbolicReferences, getRemoteTagNames, getRemoteUrl, getRepository, getSubmodules, getTagMessage, getTagNames, getTags, getWorkTree, hasGitModules, hasGitRepo, hasGitRepo, init, init_, isCommitInRepo, maintenance, merge, merge, prune, push, push, push, rebase, ref, refExists, revList, revList_, revListAll, revParse, setAuthor, setAuthor, setCommitter, setCommitter, setCredentials, setProxy, setRemoteUrl, setupSubmoduleUrls, showRevision, showRevision, showRevision, subGit, submoduleClean, submoduleInit, submoduleUpdate, submoduleUpdate, submoduleUpdate, submoduleUpdate, submoduleUpdate, tag, tagExists, withRepository

Method Details

hasGitModules

boolean hasGitModules(String treeIsh)
               throws GitException,
InterruptedException

Deprecated.

Returns true if this repository has submodules.

Parameters:

treeIsh - an ignored argument, kept for compatibility

Returns:

true if this repository has submodules (git modules file)

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

See Also:

• GitClient.hasGitModules()

getRemoteUrl

String getRemoteUrl(String name,
 String GIT_DIR)
             throws GitException,
InterruptedException

Deprecated.

Returns URL of remote name in repository GIT_DIR.

Parameters:

name - name for the remote repository, for example, "origin"

GIT_DIR - directory containing git repository

Returns:

URL of remote "name" in repository GIT_DIR.

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

setRemoteUrl

void setRemoteUrl(String name,
 String url,
 String GIT_DIR)
           throws GitException,
InterruptedException

Deprecated.

Set remote repository name and URL.

Parameters:

name - name for the remote repository, for example, "origin"

url - URL for the remote repository, for example https://github.com/jenkinsci/git-client-plugin.git

GIT_DIR - directory containing git repository

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

getDefaultRemote

String getDefaultRemote(String _default_)
                 throws GitException,
InterruptedException

Deprecated.

Returns name of default remote.

Parameters:

_default_ - value to return if no remote is defined in this repository

Returns:

name of default remote

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

isBareRepository

boolean isBareRepository()
                  throws GitException,
InterruptedException

Deprecated.

Returns true if this repository is bare.

Returns:

true if this repository is bare

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

isBareRepository

boolean isBareRepository(String GIT_DIR)
                  throws GitException,
InterruptedException

Deprecated.

Detect whether a repository at the given path is bare or not.

Parameters:

GIT_DIR - The path to the repository (must be to .git dir).

Returns:

true if this repository is bare

Throws:

GitException - on failure

InterruptedException - if interrupted

submoduleSync

void submoduleSync()
            throws GitException,
InterruptedException

Deprecated.

Synchronizes submodules' remote URL configuration setting to the value specified in .gitmodules. Refer to git submodule sync documentation for more details.

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

getSubmoduleUrl

String getSubmoduleUrl(String name)
                throws GitException,
InterruptedException

Deprecated.

Returns URL of the named submodule.

Parameters:

name - submodule name whose URL will be returned

Returns:

URL of the named submodule

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

setSubmoduleUrl

void setSubmoduleUrl(String name,
 String url)
              throws GitException,
InterruptedException

Deprecated.

Sets URL of the named submodule.

Parameters:

name - submodule name whose URL will be set

url - URL for the named submodule

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

fixSubmoduleUrls

void fixSubmoduleUrls(String remote,
 TaskListener listener)
               throws GitException,
InterruptedException

Deprecated.

fixSubmoduleUrls.

Parameters:

remote - a String object.

listener - a TaskListener object.

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

setupSubmoduleUrls

void setupSubmoduleUrls(String remote,
 TaskListener listener)
                 throws GitException,
InterruptedException

Deprecated.

Throws:

GitException

InterruptedException

fetch

void fetch(String repository,
 String refspec)
    throws GitException,
InterruptedException

Deprecated.

Retrieve commits based on refspec from repository.

Parameters:

repository - URL of the repository to be retrieved

refspec - definition of mapping from remote refs to local refs

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

fetch

void fetch(org.eclipse.jgit.transport.RemoteConfig remoteRepository)
    throws GitException,
InterruptedException

Deprecated.

Retrieve commits from RemoteConfig.

Parameters:

remoteRepository - remote configuration from which refs will be retrieved

Throws:

InterruptedException - if interrupted.

GitException

fetch

void fetch()
    throws GitException,
InterruptedException

Deprecated.

Retrieve commits from default remote.

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

reset

void reset(boolean hard)
    throws GitException,
InterruptedException

Deprecated.

Reset the contents of the working directory of this repository. Refer to git reset documentation.

Parameters:

hard - reset as though "--hard" were passed to "git reset"

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

reset

void reset()
    throws GitException,
InterruptedException

Deprecated.

Reset the contents of the working directory of this repository. Refer to git reset documentation.

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

push

void push(org.eclipse.jgit.transport.RemoteConfig repository,
 String revspec)
   throws GitException,
InterruptedException

Deprecated.

Push revspec to repository.

Parameters:

repository - git repository to receive commits

revspec - commits to be pushed

Throws:

GitException - if underlying git operating fails

InterruptedException - if interrupted

merge

void merge(String revSpec)
    throws GitException,
InterruptedException

Deprecated.

Merge commits from revspec into the current branch.

Parameters:

revSpec - the revision specification to be merged (for example, origin/main)

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

clone

void clone(org.eclipse.jgit.transport.RemoteConfig source)
    throws GitException,
InterruptedException

Deprecated.

Clone repository from source to this repository.

Parameters:

source - remote repository to be cloned

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

clone

void clone(org.eclipse.jgit.transport.RemoteConfig rc,
 boolean useShallowClone)
    throws GitException,
InterruptedException

Deprecated.

Clone repository from RemoteConfig rc to this repository.

Parameters:

rc - the remote config for the remote repository

useShallowClone - if true, use a shallow clone

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

getBranchesContaining

@Deprecated
List<Branch> getBranchesContaining(String revspec)
                            throws GitException,
InterruptedException

Deprecated.

Use GitClient.getBranchesContaining(String, boolean) instead. This method does work only with local branches on one implementation and with all the branches - in the other

Find all the branches that include the given commit.

Parameters:

revspec - substring to be searched for branch name

Returns:

list of branches containing revspec

Throws:

GitException - on failure

InterruptedException - if interrupted

lsTree

@Deprecated
List<IndexEntry> lsTree(String treeIsh)
                 throws GitException,
InterruptedException

Deprecated.

Use lsTree(String, boolean) to be explicit about the recursion behaviour.

This method has been implemented as non-recursive historically, but often that is not what the caller wants.

Parameters:

treeIsh - string representation of a treeIsh item

Returns:

list of IndexEntry items starting at treeIsh

Throws:

GitException - on failure

InterruptedException - if interrupted

lsTree

List<IndexEntry> lsTree(String treeIsh,
 boolean recursive)
                 throws GitException,
InterruptedException

Deprecated.

lsTree.

Parameters:

treeIsh - a String object.

recursive - a boolean.

Returns:

a List object.

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

revListBranch

List<org.eclipse.jgit.lib.ObjectId> revListBranch(String branchId)
                                           throws GitException,
InterruptedException

Deprecated.

revListBranch.

Parameters:

branchId - a String object.

Returns:

a List object.

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

getTagsOnCommit

List<Tag> getTagsOnCommit(String revName)
                   throws GitException,
IOException,
InterruptedException

Deprecated.

getTagsOnCommit.

Parameters:

revName - a String object.

Returns:

a List object.

Throws:

GitException - if underlying git operation fails.

IOException - if any IO failure

InterruptedException - if interrupted.

changelog

void changelog(String revFrom,
 String revTo,
 OutputStream fos)
        throws GitException,
InterruptedException

Deprecated.

changelog.

Specified by:

changelog in interface GitClient

Parameters:

revFrom - a String object.

revTo - a String object.

fos - a OutputStream object.

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

checkoutBranch

void checkoutBranch(String branch,
 String commitish)
             throws GitException,
InterruptedException

Deprecated.

Regardless of the current state of the workspace (whether there is some dirty files, etc) and the state of the repository (whether the branch of the specified name exists or not), when this method exits the following conditions hold:

• The branch of the specified name branch exists and points to the specified ref
• HEAD points to branch. In other words, the workspace is on the specified branch.
• Both index and workspace are the same tree with ref. (no dirty files and no staged changes, although this method will not touch untracked files in the workspace.)

This method is preferred over the GitClient.checkout(String, String) family of methods, as this method is affected far less by the current state of the repository. The checkout methods, in their attempt to emulate the "git checkout" command line behaviour, have too many side effects. In Jenkins, where you care a lot less about throwing away local changes and care a lot more about resetting the workspace into a known state, methods like this is more useful.

For compatibility reasons, the order of the parameter is different from GitClient.checkout(String, String).

Specified by:

checkoutBranch in interface GitClient

Parameters:

branch - a String object.

commitish - a String object.

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

mergeBase

org.eclipse.jgit.lib.ObjectId mergeBase(org.eclipse.jgit.lib.ObjectId sha1,
 org.eclipse.jgit.lib.ObjectId sha2)
                                 throws GitException,
InterruptedException

Deprecated.

mergeBase.

Parameters:

sha1 - a ObjectId object.

sha2 - a ObjectId object.

Returns:

a ObjectId object.

Throws:

InterruptedException - if interrupted.

GitException

showRevision

List<String> showRevision(Revision r)
                   throws GitException,
InterruptedException

Deprecated.

showRevision.

Parameters:

r - a Revision object.

Returns:

a List object.

Throws:

GitException - if underlying git operation fails.

InterruptedException - if interrupted.

getAllLogEntries

@Restricted(org.kohsuke.accmod.restrictions.NoExternalUse.class)
@Deprecated
String getAllLogEntries(String branch)
                 throws GitException,
InterruptedException

Deprecated.

This method makes no sense, in that it lists all log entries across all refs and yet it takes a meaningless 'branch' parameter. Please do not use this.

Parameters:

branch - a String object.

Returns:

a String object.

Throws:

InterruptedException - if interrupted.

GitException