org.nuiton.scmwebeditor.git

Class GitConnection

java.lang.Object

org.nuiton.scmwebeditor.git.GitConnection

All Implemented Interfaces:

ScmConnection

public class GitConnection
extends Object
implements ScmConnection

Implementation of the Git's main features

Field Summary

Fields

Modifier and Type	Field and Description
protected String	addressGit path to the directory of the file to edit
protected static String	DEFAULT_BRANCH the default branch to use when the requested one was not found
protected String	fileName the name of the file to edit
protected org.eclipse.jgit.lib.Repository	gitRepo git existing repository
protected File	localDirectory the local directory where the repository has been cloned to
protected String	pathToLocalRepos the path to the directory which contains all the repositories
protected String	REPOSITORY_EXTENSION

Constructor Summary

Constructors

Constructor and Description
GitConnection(String address, String pathToLocalRepos) Creates a new connection to a Git repository

Method Summary

Methods

Modifier and Type	Method and Description
BrowseResultDto	browse(BrowseDto dto)
void	changeBranch(String branchName) Changing for another branch
protected void	cloneRepository(org.eclipse.jgit.transport.CredentialsProvider credentials) Clones the repository (clone command)
CommitResultDto	commit(CommitDto dto)
protected void	doCommit(org.eclipse.jgit.api.Git git, String authorName, String authorEmail, String commitMessage) Calls the commit command
String	getAddressGit()
File	getDiffs(String path, String username, String password, String revision1, String revision2)
File	getFileContent(String path, String username, String password)
File	getFileContentAtRevision(String path, String username, String password, String revision)
String	getFileName()
String	getFilePath(String address, String repositoryRoot, String username, String password)
org.eclipse.jgit.lib.Repository	getGitRepo()
String	getHeadRevisionNumber(String path, String username, String password)
File	getLocalDirectory()
String	getPathToLocalRepos()
String	getRepositoryId()
Map<ScmRevision,String>	getRevisions(String address, String username, String password)
protected void	handlePushException(org.eclipse.jgit.api.errors.GitAPIException e) Handles the exception thrown by a push command
protected String	hash(String toHash, String algorithm) Hashes a String with then given algorithms
void	setGitRepo(org.eclipse.jgit.lib.Repository gitRepo)
void	setLocalDirectory(File localDirectory)
void	setPathToLocalRepos(String pathToLocalRepos)
void	updateRepository(String username, String password) Updates the repository to the last version by a clone or a pull command

Methods inherited from class java.lang.Object

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

Field Detail

gitRepo

protected org.eclipse.jgit.lib.Repository gitRepo

git existing repository

localDirectory

protected File localDirectory

the local directory where the repository has been cloned to

addressGit

protected String addressGit

path to the directory of the file to edit

fileName

protected String fileName

the name of the file to edit

pathToLocalRepos

protected String pathToLocalRepos

the path to the directory which contains all the repositories

DEFAULT_BRANCH

protected static final String DEFAULT_BRANCH

the default branch to use when the requested one was not found

See Also:

Constant Field Values

REPOSITORY_EXTENSION

protected final String REPOSITORY_EXTENSION

See Also:

Constant Field Values

Constructor Detail

GitConnection

public GitConnection(String address,
             String pathToLocalRepos)
              throws IOException

Creates a new connection to a Git repository

Parameters:

address - the address of the Git repository to connect to

pathToLocalRepos - the path to the local folder which will store the user's repositories

Throws:

IOException - if the repository can not be reached

Method Detail

getGitRepo

public org.eclipse.jgit.lib.Repository getGitRepo()

setGitRepo

public void setGitRepo(org.eclipse.jgit.lib.Repository gitRepo)

getLocalDirectory

public File getLocalDirectory()

setLocalDirectory

public void setLocalDirectory(File localDirectory)

getAddressGit

public String getAddressGit()

getPathToLocalRepos

public String getPathToLocalRepos()

setPathToLocalRepos

public void setPathToLocalRepos(String pathToLocalRepos)

browse

public BrowseResultDto browse(BrowseDto dto)

Specified by:

browse in interface ScmConnection

commit

public CommitResultDto commit(CommitDto dto)

Specified by:

commit in interface ScmConnection

getFileContent

public File getFileContent(String path,
                  String username,
                  String password)
                    throws AuthenticationException

Specified by:

getFileContent in interface ScmConnection

Throws:

AuthenticationException

getHeadRevisionNumber

public String getHeadRevisionNumber(String path,
                           String username,
                           String password)
                             throws AuthenticationException

Specified by:

getHeadRevisionNumber in interface ScmConnection

Throws:

AuthenticationException

getRepositoryId

public String getRepositoryId()

Specified by:

getRepositoryId in interface ScmConnection

getFileName

public String getFileName()

Specified by:

getFileName in interface ScmConnection

getFilePath

public String getFilePath(String address,
                 String repositoryRoot,
                 String username,
                 String password)

Specified by:

getFilePath in interface ScmConnection

getRevisions

public Map<ScmRevision,String> getRevisions(String address,
                                   String username,
                                   String password)

Specified by:

getRevisions in interface ScmConnection

getFileContentAtRevision

public File getFileContentAtRevision(String path,
                            String username,
                            String password,
                            String revision)
                              throws AuthenticationException

Specified by:

getFileContentAtRevision in interface ScmConnection

Throws:

AuthenticationException

getDiffs

public File getDiffs(String path,
            String username,
            String password,
            String revision1,
            String revision2)
              throws AuthenticationException

Specified by:

getDiffs in interface ScmConnection

Throws:

AuthenticationException

changeBranch

public void changeBranch(String branchName)
                  throws IOException

Changing for another branch

Parameters:

branchName - the new branch's name

Throws:

IOException - if reaching the repository is not possible

updateRepository

public void updateRepository(String username,
                    String password)
                      throws RepositoryNotFoundException

Updates the repository to the last version by a clone or a pull command

Parameters:

username - the username to use to connect to the repository

password - the password to use to connect to the repository

Throws:

RepositoryNotFoundException - if the repository is not found

cloneRepository

protected void cloneRepository(org.eclipse.jgit.transport.CredentialsProvider credentials)
                        throws IOException,
                               AuthenticationException,
                               RepositoryNotFoundException

Clones the repository (clone command)

Parameters:

credentials - the username and password to use to connect to the repository

Throws:

RepositoryNotFoundException - if the repository is not found

IOException - if it is not possible to reach the repository

AuthenticationException - if there is a problem during the authentication process

hash

protected String hash(String toHash,
          String algorithm)

Hashes a String with then given algorithms

Parameters:

toHash - the String to hash

algorithm - the algorithm to use to hash the String

Returns:

the hashed String

doCommit

protected void doCommit(org.eclipse.jgit.api.Git git,
            String authorName,
            String authorEmail,
            String commitMessage)
                 throws org.eclipse.jgit.api.errors.GitAPIException

Calls the commit command

Parameters:

git - the git repository which will receive the commit

authorName - the name of the commit's author

authorEmail - the e-mail address of the author

commitMessage - the message that describes the commit

Throws:

org.eclipse.jgit.api.errors.GitAPIException - if there is a problem during the commit process

handlePushException

protected void handlePushException(org.eclipse.jgit.api.errors.GitAPIException e)

Handles the exception thrown by a push command

Parameters:

e - the exception thrown by a push command