io.hawt.git

Class GitFacade

java.lang.Object

io.hawt.util.MBeanSupport

io.hawt.git.GitFacadeSupport

io.hawt.git.GitFacade

All Implemented Interfaces:

GitFacadeMXBean, GitFileManager

public class GitFacade
extends GitFacadeSupport

A git bean to create a local git repo for configuration data which if configured will push/pull from some central repo

Constructor Summary

Constructors

Constructor and Description
GitFacade()

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	branches() Returns all the branch names we can use in the local repo
protected void	checkoutBranch(org.eclipse.jgit.api.Git git, String branch)
List<String>	completePath(String branch, String completionText, boolean directoriesOnly) Provides a file/path completion hook so we can start typing the name of a file or directory
protected void	configureBranch(String branch)
void	createBranch(String fromBranch, String newBranch) Creates a new branch from the given branch
CommitInfo	createDirectory(String branch, String path, String commitMessage, String authorName, String authorEmail) Creates a new file if it doesn't already exist
String	currentBranch()
void	destroy()
String	diff(String objectId, String baseObjectId, String path) Performs a diff of the latest or a specifc version of the given blobPath against either the previous or a given baseObjectId
protected void	doPull()
protected Iterable<org.eclipse.jgit.transport.PushResult>	doPush(org.eclipse.jgit.api.Git git)
FileInfo	exists(String branch, String pathOrEmpty) Checks if the file exists and if so what its file metadata is.
static Date	getCommitDate(org.eclipse.jgit.revwalk.RevCommit commit) Retrieves a Java Date from a Git commit.
CommitInfo	getCommitInfo(String commitId) Returns details about the commit, such as its message etc
List<CommitTreeInfo>	getCommitTree(String commitId) Returns the commit tree for the given commit id
String	getConfigDirName()
String	getContent(String objectId, String blobPath) Get the contents of a blobPath for a given commit objectId
org.eclipse.jgit.transport.CredentialsProvider	getCredentials()
String	getDefaultBranch() Defaults to the current branch on disk if not explicitly configured
String	getDefaultGitAttributes()
String	getDefaultRemoteRepository()
String	getHEAD()
String	getInitialImportURLs()
long	getPullTimePeriod()
String	getRemote()
String	getRemoteRepository()
File	getRootGitDirectory()
static GitFacade	getSingleton()
org.eclipse.jgit.lib.PersonIdent	getStashPersonIdent()
Timer	getTimer()
protected <T> T	gitOperation(org.eclipse.jgit.lib.PersonIdent personIdent, Callable<T> callable) Performs the given operations on a clean git repository
List<CommitInfo>	history(String branch, String objectId, String path, int limit) Return the history of the repository or a specific directory or file path
protected void	importInitialContent(org.eclipse.jgit.api.Git git, File rootFolder, String branch) When creating an empty initial git repository lets see if there are a list of URLs for zips of content to include
void	init()
void	initialiseGitRepo()
boolean	isCloneAllBranches()
boolean	isCloneRemoteRepoOnStartup()
boolean	isPullBeforeOperation()
boolean	isPullOnStartup()
boolean	isPushOnCommit()
protected boolean	localBranchExists(String branch)
protected void	logPull(String message)
FileContents	read(String branch, String pathOrEmpty) Reads the contents of a file or a directory
<T> T	readFile(String branch, String pathOrEmpty, Function<File,T> callback)
String	readJsonChildContent(String branch, String path, String fileNameWildcardOrBlank, String search) Reads the child JSON file contents which match the given search string (if specified) and which match the given file name wildcard (using * to match any characters in the name).
void	remove(String branch, String path, String commitMessage, String authorName, String authorEmail)
void	rename(String branch, String oldPath, String newPath, String commitMessage, String authorName, String authorEmail) Renames the given oldPath to the newPath location for the given branch, commit message and user
void	revertTo(String branch, String objectId, String blobPath, String commitMessage, String authorName, String authorEmail) Reverts the file to a previous value
void	setCloneAllBranches(boolean cloneAllBranches)
void	setCloneRemoteRepoOnStartup(boolean cloneRemoteRepoOnStartup)
void	setConfigDirectory(File configDirectory)
void	setConfigDirName(String configDirName)
void	setCredentials(org.eclipse.jgit.transport.CredentialsProvider credentials)
void	setDefaultBranch(String defaultBranch)
void	setDefaultGitAttributes(String defaultGitAttributes)
void	setDefaultRemoteRepository(String defaultRemoteRepository)
void	setInitialImportURLs(String initialImportURLs) Sets the URLs which are used to import content in a newly created git repository
void	setPullBeforeOperation(boolean pullBeforeOperation)
void	setPullOnStartup(boolean pullOnStartup)
void	setPullTimePeriod(long pullTimePeriod)
void	setPushOnCommit(boolean pushOnCommit)
void	setRemote(String remote)
void	setRemoteRepository(String remoteRepository)
void	setStashPersonIdent(org.eclipse.jgit.lib.PersonIdent stashPersonIdent)
void	setTimer(Timer timer)
org.eclipse.jgit.api.Status	status()
static String	trimLeadingSlash(String path)
void	uploadFile(String branch, String path, boolean unzip, String sourceFileName, String destName) Uploads the given local file name to the given branch and path; unzipping any zips if the flag is true
void	uploadFiles(String branch, String path, boolean unzip, Map<String,File> uploadFiles) Uploads a list of files to the given branch and path
CommitInfo	write(String branch, String path, String commitMessage, String authorName, String authorEmail, String contents)
CommitInfo	writeBase64(String branch, String path, String commitMessage, String authorName, String authorEmail, String contentsBase64)
<T> T	writeFile(String branch, String pathOrEmpty, WriteCallback<T> callback)

Methods inherited from class io.hawt.git.GitFacadeSupport

commitThenPush, createCommitInfo, defaultObjectId, doCompletePath, doCreateBranch, doCreateDirectory, doDiff, doExists, doExists, doGetCommitInfo, doGetCommitTree, doGetContent, doGetHead, doHistory, doListBranches, doRead, doReadFile, doReadJsonChildContent, doRemove, doRename, doRevert, doWrite, doWriteFile, getBranchObjectId, getDefaultObjectName, getFile, getFilePattern, getRepositoryLabel, getShortCommitHash, isIgnoreFile, removeLeadingSlash, setRepositoryLabel, toString

Methods inherited from class io.hawt.util.MBeanSupport

getMBeanServer, getObjectName, setMBeanServer, setObjectName

Methods inherited from class java.lang.Object

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

Constructor Detail

GitFacade

public GitFacade()

Method Detail

getSingleton

public static GitFacade getSingleton()

trimLeadingSlash

public static String trimLeadingSlash(String path)

init

public void init()
          throws Exception

Overrides:

init in class MBeanSupport

Throws:

Exception

destroy

public void destroy()
             throws Exception

Overrides:

destroy in class MBeanSupport

Throws:

Exception

getStashPersonIdent

public org.eclipse.jgit.lib.PersonIdent getStashPersonIdent()

setStashPersonIdent

public void setStashPersonIdent(org.eclipse.jgit.lib.PersonIdent stashPersonIdent)

getRemoteRepository

public String getRemoteRepository()

setRemoteRepository

public void setRemoteRepository(String remoteRepository)

getRemote

public String getRemote()

setRemote

public void setRemote(String remote)

getConfigDirName

public String getConfigDirName()

setConfigDirName

public void setConfigDirName(String configDirName)

getDefaultRemoteRepository

public String getDefaultRemoteRepository()

setDefaultRemoteRepository

public void setDefaultRemoteRepository(String defaultRemoteRepository)

isPullOnStartup

public boolean isPullOnStartup()

setPullOnStartup

public void setPullOnStartup(boolean pullOnStartup)

isCloneAllBranches

public boolean isCloneAllBranches()

setCloneAllBranches

public void setCloneAllBranches(boolean cloneAllBranches)

isPushOnCommit

public boolean isPushOnCommit()

Specified by:

isPushOnCommit in class GitFacadeSupport

setPushOnCommit

public void setPushOnCommit(boolean pushOnCommit)

isPullBeforeOperation

public boolean isPullBeforeOperation()

setPullBeforeOperation

public void setPullBeforeOperation(boolean pullBeforeOperation)

isCloneRemoteRepoOnStartup

public boolean isCloneRemoteRepoOnStartup()

setCloneRemoteRepoOnStartup

public void setCloneRemoteRepoOnStartup(boolean cloneRemoteRepoOnStartup)

getCredentials

public org.eclipse.jgit.transport.CredentialsProvider getCredentials()

setCredentials

public void setCredentials(org.eclipse.jgit.transport.CredentialsProvider credentials)

getPullTimePeriod

public long getPullTimePeriod()

setPullTimePeriod

public void setPullTimePeriod(long pullTimePeriod)

getTimer

public Timer getTimer()

setTimer

public void setTimer(Timer timer)

getDefaultBranch

public String getDefaultBranch()

Defaults to the current branch on disk if not explicitly configured

setDefaultBranch

public void setDefaultBranch(String defaultBranch)

getInitialImportURLs

public String getInitialImportURLs()

setInitialImportURLs

public void setInitialImportURLs(String initialImportURLs)

Sets the URLs which are used to import content in a newly created git repository

getContent

public String getContent(String objectId,
                String blobPath)

Description copied from interface: GitFacadeMXBean

Get the contents of a blobPath for a given commit objectId

read

public FileContents read(String branch,
                String pathOrEmpty)
                  throws IOException,
                         org.eclipse.jgit.api.errors.GitAPIException

Description copied from interface: GitFacadeMXBean

Reads the contents of a file or a directory

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

readFile

public <T> T readFile(String branch,
             String pathOrEmpty,
             Function<File,T> callback)
           throws IOException,
                  org.eclipse.jgit.api.errors.GitAPIException

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

writeFile

public <T> T writeFile(String branch,
              String pathOrEmpty,
              WriteCallback<T> callback)
            throws IOException,
                   org.eclipse.jgit.api.errors.GitAPIException

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

exists

public FileInfo exists(String branch,
              String pathOrEmpty)
                throws IOException,
                       org.eclipse.jgit.api.errors.GitAPIException

Description copied from interface: GitFacadeMXBean

Checks if the file exists and if so what its file metadata is.

Will by default be case in-sensitive, eg checking if readme.md exists, will return file data, if the file in git is named ReadMe.md.

Returns:

the metadata for the given file or null if it does not exist

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

completePath

public List<String> completePath(String branch,
                        String completionText,
                        boolean directoriesOnly)

Description copied from interface: GitFacadeMXBean

Provides a file/path completion hook so we can start typing the name of a file or directory

readJsonChildContent

public String readJsonChildContent(String branch,
                          String path,
                          String fileNameWildcardOrBlank,
                          String search)
                            throws IOException

Description copied from interface: GitFacadeMXBean

Reads the child JSON file contents which match the given search string (if specified) and which match the given file name wildcard (using * to match any characters in the name).

Throws:

IOException

writeBase64

public CommitInfo writeBase64(String branch,
                     String path,
                     String commitMessage,
                     String authorName,
                     String authorEmail,
                     String contentsBase64)

write

public CommitInfo write(String branch,
               String path,
               String commitMessage,
               String authorName,
               String authorEmail,
               String contents)

createDirectory

public CommitInfo createDirectory(String branch,
                         String path,
                         String commitMessage,
                         String authorName,
                         String authorEmail)

Description copied from interface: GitFacadeMXBean

Creates a new file if it doesn't already exist

Returns:

the commit metadata for the newly created file or null if it already exists

createBranch

public void createBranch(String fromBranch,
                String newBranch)

Description copied from interface: GitFacadeMXBean

Creates a new branch from the given branch

getCommitTree

public List<CommitTreeInfo> getCommitTree(String commitId)

Description copied from interface: GitFacadeMXBean

Returns the commit tree for the given commit id

getCommitInfo

public CommitInfo getCommitInfo(String commitId)

Description copied from interface: GitFacadeMXBean

Returns details about the commit, such as its message etc

revertTo

public void revertTo(String branch,
            String objectId,
            String blobPath,
            String commitMessage,
            String authorName,
            String authorEmail)

Description copied from interface: GitFacadeMXBean

Reverts the file to a previous value

rename

public void rename(String branch,
          String oldPath,
          String newPath,
          String commitMessage,
          String authorName,
          String authorEmail)

Description copied from interface: GitFacadeMXBean

Renames the given oldPath to the newPath location for the given branch, commit message and user

remove

public void remove(String branch,
          String path,
          String commitMessage,
          String authorName,
          String authorEmail)

branches

public List<String> branches()

Description copied from interface: GitFacadeMXBean

Returns all the branch names we can use in the local repo

doPush

protected Iterable<org.eclipse.jgit.transport.PushResult> doPush(org.eclipse.jgit.api.Git git)
                                                          throws Exception

Specified by:

doPush in class GitFacadeSupport

Throws:

Exception

getHEAD

public String getHEAD()

getDefaultGitAttributes

public String getDefaultGitAttributes()

setDefaultGitAttributes

public void setDefaultGitAttributes(String defaultGitAttributes)

history

public List<CommitInfo> history(String branch,
                       String objectId,
                       String path,
                       int limit)

Description copied from interface: GitFacadeMXBean

Return the history of the repository or a specific directory or file path

getCommitDate

public static Date getCommitDate(org.eclipse.jgit.revwalk.RevCommit commit)

Retrieves a Java Date from a Git commit.

Parameters:

commit - the commit

Returns:

date of the commit or Date(0) if the commit is null

diff

public String diff(String objectId,
          String baseObjectId,
          String path)

Description copied from interface: GitFacadeMXBean

Performs a diff of the latest or a specifc version of the given blobPath against either the previous or a given baseObjectId

uploadFile

public void uploadFile(String branch,
              String path,
              boolean unzip,
              String sourceFileName,
              String destName)
                throws IOException,
                       org.eclipse.jgit.api.errors.GitAPIException

Uploads the given local file name to the given branch and path; unzipping any zips if the flag is true

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

uploadFiles

public void uploadFiles(String branch,
               String path,
               boolean unzip,
               Map<String,File> uploadFiles)
                 throws IOException,
                        org.eclipse.jgit.api.errors.GitAPIException

Uploads a list of files to the given branch and path

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

getRootGitDirectory

public File getRootGitDirectory()

setConfigDirectory

public void setConfigDirectory(File configDirectory)

initialiseGitRepo

public void initialiseGitRepo()
                       throws IOException,
                              org.eclipse.jgit.api.errors.GitAPIException

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

importInitialContent

protected void importInitialContent(org.eclipse.jgit.api.Git git,
                        File rootFolder,
                        String branch)

When creating an empty initial git repository lets see if there are a list of URLs for zips of content to include

Parameters:

git -

branch -

doPull

protected void doPull()

logPull

protected void logPull(String message)

status

public org.eclipse.jgit.api.Status status()

gitOperation

protected <T> T gitOperation(org.eclipse.jgit.lib.PersonIdent personIdent,
                 Callable<T> callable)

Performs the given operations on a clean git repository

currentBranch

public String currentBranch()

checkoutBranch

protected void checkoutBranch(org.eclipse.jgit.api.Git git,
                  String branch)
                       throws org.eclipse.jgit.api.errors.GitAPIException

Specified by:

checkoutBranch in class GitFacadeSupport

Throws:

org.eclipse.jgit.api.errors.GitAPIException

configureBranch

protected void configureBranch(String branch)

localBranchExists

protected boolean localBranchExists(String branch)
                             throws org.eclipse.jgit.api.errors.GitAPIException

Throws:

org.eclipse.jgit.api.errors.GitAPIException