org.azyva.dragom.git.impl

Class DefaultGitImpl

java.lang.Object

org.azyva.dragom.git.impl.DefaultGitImpl

All Implemented Interfaces:

Git

public class DefaultGitImpl
extends Object
implements Git

Main implementation of Git.

Author:

David Raymond

Nested Class Summary

Nested classes/interfaces inherited from interface org.azyva.dragom.git.Git

Git.AheadBehindInfo, Git.AllowExitCode

Constructor Summary

Constructors

Constructor and Description
DefaultGitImpl()

Method Summary

Modifier and Type	Method and Description
void	addCommit(Path pathWorkspace, String message, Map<String,String> mapCommitAttr, boolean indPush) Synchronizes the working copy with the index and commits.
void	checkout(Path pathWorkspace, org.azyva.dragom.model.Version version) Git checkout.
void	clone(String reposUrl, org.azyva.dragom.model.Version version, Path pathWorkspace) Git clone.
void	config(Path pathWorkspace, String param, String value) Sets a configuration parameter within the Git workspace (local repository).
String	convertToRef(org.azyva.dragom.model.Version version) Converts a Version to a Git reference such as refs/tags/<tag> or refs/remotes/origin/<branch>.
void	createBranch(Path pathModuleWorkspace, String branch, boolean indSwitch) Creates a branch.
void	createTag(Path pathModuleWorkspace, String tag, String message) Creates a tag.
int	executeGitCommand(String[] arrayArg, boolean indProvideCredentials, Git.AllowExitCode allowExitCode, Path pathWorkingDirectory, StringBuilder stringBuilderOutput) Helper method to execute a Git command.
void	fetch(Path pathWorkspace, String reposUrl, String refspec, boolean indFetchingIntoCurrentBranch) Git fetch.
Git.AheadBehindInfo	getAheadBehindInfo(Path pathWorkspace) Determines if the remote repository contains changes that are not in the local repository (behind) and/or if the local repository contains changes that are not in the remote repository (ahead).
String	getBranch(Path pathWorkspace) Returns the current branch or null if detached.
List<org.azyva.dragom.model.Version>	getListVersionStatic(Path pathWorkspace) Returns the List of all static Version's (tags).
org.azyva.dragom.model.Version	getVersion(Path pathWorkspace) Returns the current version.
boolean	isLocalChanges(Path pathWorkspace) Verifies there are local changes that are not pushed.
boolean	isReposExists()
boolean	isVersionExists(Path pathWorkspace, org.azyva.dragom.model.Version version) Tests if a Version exists.
boolean	mergeSimple(Path pathWorkspace) Merges the current branch's remote counterpart into the current branch.
boolean	pull(Path pathWorkspace) Git pull.
void	push(Path pathWorkspace) Pushes all refs, branches and tags.
void	push(Path pathWorkspace, String gitRef) Git push.
boolean	rebaseSimple(Path pathWorkspace) Rebases the current branch on its remote counterpart.
void	setPassword(String password) Sets the password to access Git repositories.
void	setPathExecutable(Path pathExecutable) Sets the Path to the git executable.
void	setReposUrl(String reposUrl) Sets the repository URL.
void	setUser(String user) Sets the user to access Git repositories.
boolean	validateCredentials()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultGitImpl

public DefaultGitImpl()

Method Detail

setPathExecutable

public void setPathExecutable(Path pathExecutable)

Description copied from interface: Git

Sets the Path to the git executable. If not set, git is invoked with no Path,, relying on it beinng available in the environment PATH.

Specified by:

setPathExecutable in interface Git

Parameters:

pathExecutable - See description.

setReposUrl

public void setReposUrl(String reposUrl)

Description copied from interface: Git

Sets the repository URL.

Specified by:

setReposUrl in interface Git

Parameters:

reposUrl - See description.

setUser

public void setUser(String user)

Description copied from interface: Git

Sets the user to access Git repositories. If null (or not set) Git is accessed without specifying credentials, which may or may not cause credentials to be used, depending on how Git is configured.

If not null and the repository URL contains a user (i.e.: https://jsmith@acme.com/my-repos.git), the user specified must be the same.

Specified by:

setUser in interface Git

Parameters:

user - See description.

setPassword

public void setPassword(String password)

Description copied from interface: Git

Sets the password to access Git repositories. null if user (see Git.setUser(java.lang.String)) is null.

Specified by:

setPassword in interface Git

Parameters:

password - See description.

executeGitCommand

public int executeGitCommand(String[] arrayArg,
                             boolean indProvideCredentials,
                             Git.AllowExitCode allowExitCode,
                             Path pathWorkingDirectory,
                             StringBuilder stringBuilderOutput)

Description copied from interface: Git

Helper method to execute a Git command.

Mostly used internally, but can be used by callers in order to submit a Git command that is not directly supported by this class.

Specified by:

executeGitCommand in interface Git

Parameters:

arrayArg - Command line arguments to Git.

indProvideCredentials - Indicates to provide the user credentials to Git, if available.

allowExitCode - Specifies which exit codes are allowed and will not trigger an exception.

pathWorkingDirectory - Path to the working directory. The command will be executed with this current working directory. If null current working directy is used.

stringBuilderOutput - If not null, any output (stdout) of the command will be copied in this StringBuilder.

Returns:

The exit code of the command.

validateCredentials

public boolean validateCredentials()

Specified by:

validateCredentials in interface Git

Returns:

Indicates if the credentials provided are valid.

isReposExists

public boolean isReposExists()

Specified by:

isReposExists in interface Git

Returns:

Indicates if the Git repository exists.

getBranch

public String getBranch(Path pathWorkspace)

Description copied from interface: Git

Returns the current branch or null if detached.

Can be used to check if the current Version is branch by comparing to null.

Specified by:

getBranch in interface Git

Parameters:

pathWorkspace - Path to the workspace.

Returns:

See description.

config

public void config(Path pathWorkspace,
                   String param,
                   String value)

Description copied from interface: Git

Sets a configuration parameter within the Git workspace (local repository).

Specified by:

config in interface Git

Parameters:

pathWorkspace - Path to the workspace.

param - Parameter name.

value - Parameter value.

clone

public void clone(String reposUrl,
                  org.azyva.dragom.model.Version version,
                  Path pathWorkspace)

Description copied from interface: Git

Git clone.

Specified by:

clone in interface Git

Parameters:

reposUrl - Repository URL. Can be null in which case the repository URL specified with Git.setReposUrl(java.lang.String) is used. Specifying the repository URL allows the caller to clone from a local repository. When reposUrl is specified it must use the file:// protocol.

version - Version to checkout after clone. If null, no version is checked out, not even master.

pathWorkspace - Path to the workspace.

fetch

public void fetch(Path pathWorkspace,
                  String reposUrl,
                  String refspec,
                  boolean indFetchingIntoCurrentBranch)

Description copied from interface: Git

Git fetch.

Specified by:

fetch in interface Git

Parameters:

pathWorkspace - Path.

reposUrl - Repository URL. Can be null in which case fetch occurs from the remote named "origin" within the configuration of the workspace, and thus implicitly from the remote repository specified with Git.setReposUrl(java.lang.String). Can be a repository URL in which case refspec should be specified otherwise Git will not know which refs to update. This allows the caller to fetch between local repositories. When reposUrl is specified, it must use the file:// protocol.

refspec - The Git refspec to pass to git fetch. See the documentation for git fetch for more information. Can be null if no refspec is to be passed to git, letting git essentially use the default refs/heads/*:refs/remotes/origin/heads/* refspec.

indFetchingIntoCurrentBranch - This is to handle the special case where the caller knows what is fetched into is the current branch, meaning that refspec is specifed and ends with ":refs/heads/...". In such a case this method specifies the --update-head-ok option to "git fetch" (otherwise git complains that fetching into the current local branch is not allowed).

pull

public boolean pull(Path pathWorkspace)

Description copied from interface: Git

Git pull.

Specified by:

pull in interface Git

Parameters:

pathWorkspace - Path to the workspace.

Returns:

true if conflicts are encountered.

rebaseSimple

public boolean rebaseSimple(Path pathWorkspace)

Description copied from interface: Git

Rebases the current branch on its remote counterpart.

Specified by:

rebaseSimple in interface Git

Parameters:

pathWorkspace - Path to the workspace.

Returns:

true if conflicts are encountered.

mergeSimple

public boolean mergeSimple(Path pathWorkspace)

Description copied from interface: Git

Merges the current branch's remote counterpart into the current branch.

Specified by:

mergeSimple in interface Git

Parameters:

pathWorkspace - Path to the workspace.

Returns:

true if conflicts are encountered.

push

public void push(Path pathWorkspace,
                 String gitRef)

Description copied from interface: Git

Git push.

If gitRef is not null --set-upstream used. This is to allow to always set the upstream tracking information because the push can be delayed and new branches can be pushed on the call to this method other than the one immediately after creating the branch.

In the case gitRef is a tag, --set-upstream has no effect.

Specified by:

push in interface Git

Parameters:

pathWorkspace - Path to the workspace.

gitRef - Git reference to push. If null, the current branch is pushed.

checkout

public void checkout(Path pathWorkspace,
                     org.azyva.dragom.model.Version version)

Description copied from interface: Git

Git checkout.

Specified by:

checkout in interface Git

Parameters:

pathWorkspace - Path to the workspace.

version - Version to checkout.

isVersionExists

public boolean isVersionExists(Path pathWorkspace,
                               org.azyva.dragom.model.Version version)

Description copied from interface: Git

Tests if a Version exists.

Specified by:

isVersionExists in interface Git

Parameters:

pathWorkspace - Path to the workspace.

version - Version.

Returns:

See description.

getAheadBehindInfo

public Git.AheadBehindInfo getAheadBehindInfo(Path pathWorkspace)

Description copied from interface: Git

Determines if the remote repository contains changes that are not in the local repository (behind) and/or if the local repository contains changes that are not in the remote repository (ahead).

Specified by:

getAheadBehindInfo in interface Git

Parameters:

pathWorkspace - Path to the workspace.

Returns:

AheadBehindInfo.

isLocalChanges

public boolean isLocalChanges(Path pathWorkspace)

Description copied from interface: Git

Verifies there are local changes that are not pushed.

Specified by:

isLocalChanges in interface Git

Parameters:

pathWorkspace - Path to the workspace.

Returns:

See description.

push

public void push(Path pathWorkspace)

Description copied from interface: Git

Pushes all refs, branches and tags.

Specified by:

push in interface Git

Parameters:

pathWorkspace - Path to the workspace.

getVersion

public org.azyva.dragom.model.Version getVersion(Path pathWorkspace)

Description copied from interface: Git

Returns the current version.

If not on a branch, returns the tag corresponding to the current commit, if any.

Specified by:

getVersion in interface Git

Parameters:

pathWorkspace - Path to the workspace.

Returns:

See description.

getListVersionStatic

public List<org.azyva.dragom.model.Version> getListVersionStatic(Path pathWorkspace)

Description copied from interface: Git

Returns the List of all static Version's (tags).

Specified by:

getListVersionStatic in interface Git

Parameters:

pathWorkspace - Path to the workspace.

Returns:

See description.

createBranch

public void createBranch(Path pathModuleWorkspace,
                         String branch,
                         boolean indSwitch)

Description copied from interface: Git

Creates a branch.

Specified by:

createBranch in interface Git

Parameters:

pathModuleWorkspace - Path to the workspace.

branch - Branch.

indSwitch - Indicates whether we must switch (checkout) to the new branch.

createTag

public void createTag(Path pathModuleWorkspace,
                      String tag,
                      String message)

Description copied from interface: Git

Creates a tag.

Specified by:

createTag in interface Git

Parameters:

pathModuleWorkspace - Path to the workspace.

tag - Tag.

message - Tag message.

addCommit

public void addCommit(Path pathWorkspace,
                      String message,
                      Map<String,String> mapCommitAttr,
                      boolean indPush)

Description copied from interface: Git

Synchronizes the working copy with the index and commits.

Specified by:

addCommit in interface Git

Parameters:

pathWorkspace - Path to the workspace.

message - Commit message.

mapCommitAttr - Map of commit attributes.

indPush - Indicates to perform a push immediately after the commit.

convertToRef

public String convertToRef(org.azyva.dragom.model.Version version)

Description copied from interface: Git

Converts a Version to a Git reference such as refs/tags/<tag> or refs/remotes/origin/<branch>.

In the case of a dynamic Version, the remote branch is used.

Specified by:

convertToRef in interface Git

Parameters:

version - Version.

Returns:

Git reference.