org.craftercms.studio.api.v2.utils

Class GitRepositoryHelper

java.lang.Object

org.craftercms.studio.api.v2.utils.GitRepositoryHelper

public class GitRepositoryHelper
extends Object

Method Summary

Modifier and Type	Method and Description
boolean	addFiles(org.eclipse.jgit.lib.Repository repo, String site, String... paths)
boolean	addGitIgnoreFile(String siteId)
boolean	buildGlobalRepo() Build the global repository as part of system startup and caches it
Path	buildRepoPath(GitRepositories repoType) Builds repository path
Path	buildRepoPath(GitRepositories repoType, String siteId) Builds repository path
boolean	buildSiteRepo(String siteId)
String	commitFiles(org.eclipse.jgit.lib.Repository repo, String site, String comment, org.eclipse.jgit.lib.PersonIdent user, String... paths)
boolean	copyContentFromBlueprint(String blueprintLocation, String site)
org.eclipse.jgit.lib.Repository	createGitRepository(Path path)
boolean	createGlobalRepo()
boolean	createPublishedRepository(String siteId, String sandboxBranch) Create a site published git repository from scratch
boolean	createSandboxRepository(String site, String sandboxBranch) Create a site sandbox git repository from scratch
boolean	createSiteCloneRemoteGitRepo(String siteId, String sandboxBranch, String remoteName, String remoteUrl, String remoteBranch, boolean singleBranch, String authenticationType, String remoteUsername, String remotePassword, String remoteToken, String remotePrivateKey, boolean createAsOrphan, String creator)
boolean	deleteSiteGitRepo(String site)
org.eclipse.jgit.lib.PersonIdent	getAuthorIdent(String author) Return the author identity as a jgit PersonIdent
org.eclipse.jgit.lib.PersonIdent	getAuthorIdent(User user) Return the author identity as a jgit PersonIdent
String	getCommitMessage(String commitMessageKey)
org.eclipse.jgit.lib.PersonIdent	getCurrentUserIdent() Return the current user identity as a jgit PersonIdent
List<String>	getFilesInCommit(org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.revwalk.RevCommit commit)
String	getGitPath(String path)
String[]	getGitPaths(String... paths)
static GitRepositoryHelper	getHelper(StudioConfiguration studioConfiguration, SecurityService securityService, UserServiceInternal userServiceInternal, org.craftercms.commons.crypto.TextEncryptor textEncryptor, GeneralLockService generalLockService, RetryingRepositoryOperationFacade retryingRepositoryOperationFacade)
String	getPublishedRepoLockKey(String site) Returns the key to use when locking Git operations for a site's published repo
org.eclipse.jgit.lib.Repository	getRepository(String siteId, GitRepositories gitRepository)
org.eclipse.jgit.lib.Repository	getRepository(String siteId, GitRepositories gitRepository, String sandboxBranch)
String	getSandboxRepoLockKey(String site) Returns the key to use when locking Git operations for a site's sandbox repo
org.eclipse.jgit.transport.SshSessionFactory	getSshSessionFactory(String privateKey, Path tempKey)
org.eclipse.jgit.revwalk.RevTree	getTreeForCommit(org.eclipse.jgit.lib.Repository repository, String commitId)
org.eclipse.jgit.revwalk.RevTree	getTreeForLastCommit(org.eclipse.jgit.lib.Repository repository)
boolean	isRemoteValid(org.eclipse.jgit.api.Git git, String remote, String authenticationType, String remoteUsername, String remotePassword, String remoteToken, String remotePrivateKey)
org.eclipse.jgit.lib.Repository	openRepository(Path repositoryPath) Opens a git repository
boolean	performInitialCommit(String site, String message, String sandboxBranch, String creator) Perform an initial commit after large changes to a site.
void	removeSandbox(String siteId)
boolean	replaceParameters(String siteId, Map<String,String> parameters)
protected boolean	replaceSiteNameVariable(String site, Path path)
<T extends org.eclipse.jgit.api.TransportCommand> T	setAuthenticationForCommand(T gitCommand, String authenticationType, String username, String password, String token, String privateKey, Path tempKey, boolean decrypt)
boolean	updateSiteNameConfigVar(String site)
boolean	writeFile(org.eclipse.jgit.lib.Repository repo, String site, String path, InputStream content)

Methods inherited from class java.lang.Object

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

Method Detail

getHelper

public static GitRepositoryHelper getHelper(StudioConfiguration studioConfiguration,
                                            SecurityService securityService,
                                            UserServiceInternal userServiceInternal,
                                            org.craftercms.commons.crypto.TextEncryptor textEncryptor,
                                            GeneralLockService generalLockService,
                                            RetryingRepositoryOperationFacade retryingRepositoryOperationFacade)
                                     throws org.craftercms.commons.crypto.CryptoException

Throws:

org.craftercms.commons.crypto.CryptoException

getRepository

public org.eclipse.jgit.lib.Repository getRepository(String siteId,
                                                     GitRepositories gitRepository)

getRepository

public org.eclipse.jgit.lib.Repository getRepository(String siteId,
                                                     GitRepositories gitRepository,
                                                     String sandboxBranch)

buildSiteRepo

public boolean buildSiteRepo(String siteId)

buildRepoPath

public Path buildRepoPath(GitRepositories repoType)

Builds repository path

Parameters:

repoType - repository type

Returns:

repository path

buildRepoPath

public Path buildRepoPath(GitRepositories repoType,
                          String siteId)

Builds repository path

Parameters:

repoType - repository type

siteId - site Id (if empty it is global repository)

Returns:

repository path

openRepository

public org.eclipse.jgit.lib.Repository openRepository(Path repositoryPath)
                                               throws IOException

Opens a git repository

Parameters:

repositoryPath - path to repository to open (including .git)

Returns:

repository object if successful

Throws:

IOException

isRemoteValid

public boolean isRemoteValid(org.eclipse.jgit.api.Git git,
                             String remote,
                             String authenticationType,
                             String remoteUsername,
                             String remotePassword,
                             String remoteToken,
                             String remotePrivateKey)
                      throws org.craftercms.commons.crypto.CryptoException,
                             IOException,
                             ServiceLayerException,
                             org.eclipse.jgit.api.errors.GitAPIException

Throws:

org.craftercms.commons.crypto.CryptoException

IOException

ServiceLayerException

org.eclipse.jgit.api.errors.GitAPIException

getSshSessionFactory

public org.eclipse.jgit.transport.SshSessionFactory getSshSessionFactory(String privateKey,
                                                                         Path tempKey)

setAuthenticationForCommand

public <T extends org.eclipse.jgit.api.TransportCommand> T setAuthenticationForCommand(T gitCommand,
                                                                                       String authenticationType,
                                                                                       String username,
                                                                                       String password,
                                                                                       String token,
                                                                                       String privateKey,
                                                                                       Path tempKey,
                                                                                       boolean decrypt)
                                                                                throws org.craftercms.commons.crypto.CryptoException,
                                                                                       ServiceLayerException

Throws:

org.craftercms.commons.crypto.CryptoException

ServiceLayerException

getGitPath

public String getGitPath(String path)

getGitPaths

public String[] getGitPaths(String... paths)

getAuthorIdent

public org.eclipse.jgit.lib.PersonIdent getAuthorIdent(User user)
                                                throws ServiceLayerException,
                                                       UserNotFoundException

Return the author identity as a jgit PersonIdent

Parameters:

user - author

Returns:

author user as a PersonIdent

Throws:

ServiceLayerException

UserNotFoundException

getTreeForCommit

public org.eclipse.jgit.revwalk.RevTree getTreeForCommit(org.eclipse.jgit.lib.Repository repository,
                                                         String commitId)
                                                  throws IOException

Throws:

IOException

getTreeForLastCommit

public org.eclipse.jgit.revwalk.RevTree getTreeForLastCommit(org.eclipse.jgit.lib.Repository repository)
                                                      throws IOException

Throws:

IOException

getFilesInCommit

public List<String> getFilesInCommit(org.eclipse.jgit.lib.Repository repository,
                                     org.eclipse.jgit.revwalk.RevCommit commit)

createSandboxRepository

public boolean createSandboxRepository(String site,
                                       String sandboxBranch)

Create a site sandbox git repository from scratch

Parameters:

site - site to create

sandboxBranch - sandbox branch name

Returns:

true if successful, false otherwise

createPublishedRepository

public boolean createPublishedRepository(String siteId,
                                         String sandboxBranch)

Create a site published git repository from scratch

Parameters:

siteId - site to create

sandboxBranch - sandbox branch name

Returns:

true if successful, false otherwise

createGitRepository

public org.eclipse.jgit.lib.Repository createGitRepository(Path path)

getCommitMessage

public String getCommitMessage(String commitMessageKey)

copyContentFromBlueprint

public boolean copyContentFromBlueprint(String blueprintLocation,
                                        String site)

updateSiteNameConfigVar

public boolean updateSiteNameConfigVar(String site)

replaceSiteNameVariable

protected boolean replaceSiteNameVariable(String site,
                                          Path path)

replaceParameters

public boolean replaceParameters(String siteId,
                                 Map<String,String> parameters)

addGitIgnoreFile

public boolean addGitIgnoreFile(String siteId)

performInitialCommit

public boolean performInitialCommit(String site,
                                    String message,
                                    String sandboxBranch,
                                    String creator)

Perform an initial commit after large changes to a site. Will not work against the global config repo.

Parameters:

site -

message -

sandboxBranch -

creator - site creator

Returns:

true if successful, false otherwise

createSiteCloneRemoteGitRepo

public boolean createSiteCloneRemoteGitRepo(String siteId,
                                            String sandboxBranch,
                                            String remoteName,
                                            String remoteUrl,
                                            String remoteBranch,
                                            boolean singleBranch,
                                            String authenticationType,
                                            String remoteUsername,
                                            String remotePassword,
                                            String remoteToken,
                                            String remotePrivateKey,
                                            boolean createAsOrphan,
                                            String creator)
                                     throws InvalidRemoteRepositoryException,
                                            InvalidRemoteRepositoryCredentialsException,
                                            RemoteRepositoryNotFoundException,
                                            ServiceLayerException

Throws:

InvalidRemoteRepositoryException

InvalidRemoteRepositoryCredentialsException

RemoteRepositoryNotFoundException

ServiceLayerException

removeSandbox

public void removeSandbox(String siteId)

buildGlobalRepo

public boolean buildGlobalRepo()
                        throws IOException

Build the global repository as part of system startup and caches it

Returns:

true if successful, false otherwise

Throws:

IOException

createGlobalRepo

public boolean createGlobalRepo()

deleteSiteGitRepo

public boolean deleteSiteGitRepo(String site)

writeFile

public boolean writeFile(org.eclipse.jgit.lib.Repository repo,
                         String site,
                         String path,
                         InputStream content)

addFiles

public boolean addFiles(org.eclipse.jgit.lib.Repository repo,
                        String site,
                        String... paths)

commitFiles

public String commitFiles(org.eclipse.jgit.lib.Repository repo,
                          String site,
                          String comment,
                          org.eclipse.jgit.lib.PersonIdent user,
                          String... paths)

getCurrentUserIdent

public org.eclipse.jgit.lib.PersonIdent getCurrentUserIdent()
                                                     throws ServiceLayerException,
                                                            UserNotFoundException

Return the current user identity as a jgit PersonIdent

Returns:

current user as a PersonIdent

Throws:

ServiceLayerException

UserNotFoundException

getAuthorIdent

public org.eclipse.jgit.lib.PersonIdent getAuthorIdent(String author)
                                                throws ServiceLayerException,
                                                       UserNotFoundException

Return the author identity as a jgit PersonIdent

Parameters:

author - author

Returns:

author user as a PersonIdent

Throws:

ServiceLayerException

UserNotFoundException

getSandboxRepoLockKey

public String getSandboxRepoLockKey(String site)

Returns the key to use when locking Git operations for a site's sandbox repo

Parameters:

site - the site name

Returns:

the lock key to use with the lock service

getPublishedRepoLockKey

public String getPublishedRepoLockKey(String site)

Returns the key to use when locking Git operations for a site's published repo

Parameters:

site - the site name

Returns:

the lock key to use with the lock service