io.hawt.git

Interface GitFacadeMXBean

All Known Implementing Classes:

GitFacade, GitFacadeSupport

public interface GitFacadeMXBean

The JMX MBean interface for working with git configuration files

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	branches() Returns all the branch names we can use in the local repo
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
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	diff(String objectId, String baseObjectId, String blobPath) Performs a diff of the latest or a specifc version of the given blobPath against either the previous or a given baseObjectId
FileInfo	exists(String branch, String pathOrEmpty) Checks if the file exists and if so what its file metadata is.
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	getContent(String objectId, String blobPath) Get the contents of a blobPath for a given commit objectId
String	getHEAD()
String	getRepositoryLabel()
List<CommitInfo>	history(String branch, String objectId, String path, int limit) Return the history of the repository or a specific directory or file path
FileContents	read(String branch, String path) Reads the contents of a file or a directory
String	readJsonChildContent(String branch, String path, String fileNameWildcard, 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	uploadFile(String branch, String path, boolean unzip, String sourceFileName, String destName)
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)

Method Detail

getRepositoryLabel

String getRepositoryLabel()

exists

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

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

read

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

Reads the contents of a file or a directory

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

write

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

writeBase64

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

createDirectory

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

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

void createBranch(String fromBranch,
                String newBranch)

Creates a new branch from the given branch

rename

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

remove

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

getHEAD

String getHEAD()

history

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

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

getCommitTree

List<CommitTreeInfo> getCommitTree(String commitId)

Returns the commit tree for the given commit id

getCommitInfo

CommitInfo getCommitInfo(String commitId)

Returns details about the commit, such as its message etc

getContent

String getContent(String objectId,
                String blobPath)

Get the contents of a blobPath for a given commit objectId

completePath

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

readJsonChildContent

String readJsonChildContent(String branch,
                          String path,
                          String fileNameWildcard,
                          String search)
                            throws IOException

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

diff

String diff(String objectId,
          String baseObjectId,
          String blobPath)

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

revertTo

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

Reverts the file to a previous value

branches

List<String> branches()

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

uploadFile

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

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException