org.cyclopsgroup.gitcon.jgit

Class JGitSource

java.lang.Object

org.cyclopsgroup.gitcon.jgit.JGitSource

All Implemented Interfaces:

Source

Direct Known Subclasses:

JGitLocalResourceRepository

public class JGitSource
extends Object
implements Source

Implementation of Source that gets file from a Git repository. There are several ways of authenticating access to git.

1. Username and password is supported, but it's the least recommended approach. User can call setUserPassword(String, String) or setUserPassword(String) to pass username and password to the instance.
2. If the OS default SSH for current run-as-user is good to access Git repo, nothing needs to be configured and default setting will pick up system SSH key in $user.home/.ssh/.
3. Specify an SSH private key by calling setSshIdentity(String) or setSshIdentityFile(File)
4. Gitcon library comes with a build-in SSH private key for user gitconreader in both Github and BitBucket. Calling setBuildInSshIdentityUsed(boolean) with true or setSshIdentity(String) with buildin tells the class to use the build-in private key. Beaware that since everyone can get this build-in private key from Gitcon jar file, exposing your Git repo to user gitconreader is equivalent to exposing it to public.

Constructor Summary

Constructors

Constructor and Description
JGitSource(String repoUri) Constructor that uses a working directory under system temporary directory

Method Summary

Methods

Modifier and Type	Method and Description
String	getBranchOrCommmit()
File	initWorkingDirectory(File workingDirectory) Get files from logical source into local working directory when application starts
void	setBranchOrCommit(String branch) Caller sets branchOrCommit in order to checkout files from a non-default branch or specified commit.
void	setBuildInSshIdentityUsed(boolean buildInSshIdentityUsed) Gitcon jar file comes with a build-in SSH private key for user gitconreader in both Github and BitBucket.
void	setSshIdentity(String privateKeyPath) Use specified SSH private key for authentication
void	setSshIdentityFile(File privateKeyFile) An alternative of setSshIdentity(String) that takes a File instead of file path.
void	setUserPassword(String userAndPassword) An alternative method of setUserPassword(String, String) which takes parameters from one single string
void	setUserPassword(String user, String password) Set user and password used to authenticate access to Git repository.
void	updateWorkingDirectory(File workingDirectory) Update local repository by running a git pull command

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JGitSource

public JGitSource(String repoUri)

Constructor that uses a working directory under system temporary directory

Parameters:

repoUri - Git repository URI

Method Detail

getBranchOrCommmit

public String getBranchOrCommmit()

initWorkingDirectory

public File initWorkingDirectory(File workingDirectory)
                          throws org.eclipse.jgit.api.errors.GitAPIException,
                                 IOException

Description copied from interface: Source

Get files from logical source into local working directory when application starts

Specified by:

initWorkingDirectory in interface Source

Parameters:

workingDirectory - Local working directory, the root of local repository

Returns:

The root of copied files from logical source under working directory. It's not necessarily the same working directory, since the implementation of Source may choose to download remote files into a subdirectory under working directory, in which case the subdirectory is returned.

Throws:

org.eclipse.jgit.api.errors.GitAPIException

IOException

setBranchOrCommit

public void setBranchOrCommit(String branch)

Caller sets branchOrCommit in order to checkout files from a non-default branch or specified commit. When specified, a git checkout command will be called right after git clone when application starts.

Parameters:

branch - Branch or commit in Git repository

setBuildInSshIdentityUsed

public void setBuildInSshIdentityUsed(boolean buildInSshIdentityUsed)

Gitcon jar file comes with a build-in SSH private key for user gitconreader in both Github and BitBucket. This method tells JGitSource to use the build-in SSH key.

Parameters:

buildInSshIdentityUsed - True to use the build-in SSH priavate key

setSshIdentity

public void setSshIdentity(String privateKeyPath)

Use specified SSH private key for authentication

Parameters:

privateKeyPath - Path to SSH private key. However if value is default, the default OS SSH key will be used. If value is buildin, a build-in SSH private key, which is registered for user gitconreader in Github and BitBucket will be used.

See Also:

setBuildInSshIdentityUsed(boolean)

setSshIdentityFile

public void setSshIdentityFile(File privateKeyFile)

An alternative of setSshIdentity(String) that takes a File instead of file path.

Parameters:

privateKeyFile - SSH private key file object

setUserPassword

public void setUserPassword(String userAndPassword)

An alternative method of setUserPassword(String, String) which takes parameters from one single string

Parameters:

userAndPassword - One string in form of <user>:<password>

setUserPassword

public void setUserPassword(String user,
                   String password)

Set user and password used to authenticate access to Git repository. It's often used when Git repo URI starts with https where basic authentication is used.

Parameters:

user - Login user name

password - Login password

updateWorkingDirectory

public void updateWorkingDirectory(File workingDirectory)
                            throws org.eclipse.jgit.api.errors.GitAPIException

Update local repository by running a git pull command

Specified by:

updateWorkingDirectory in interface Source

Parameters:

workingDirectory - Local working directory

Throws:

org.eclipse.jgit.api.errors.GitAPIException - Allows JGit exceptions