Package org.craftercms.studio.api.v2.service.repository

Interface RepositoryManagementService

All Known Implementing Classes:

RepositoryManagementServiceImpl

public interface RepositoryManagementService

Method Summary

Modifier and Type	Method	Description
boolean	addRemote(String siteId, RemoteRepository remoteRepository)
RepositoryStatus	cancelFailedPull(String siteId)
RepositoryStatus	commitResolution(String siteId, String commitMessage)
DiffConflictedFile	getDiffForConflictedFile(String siteId, String path)
RepositoryStatus	getRepositoryStatus(String siteId)
List<RemoteRepositoryInfo>	listRemotes(String siteId)
boolean	pullFromRemote(String siteId, String remoteName, String remoteBranch, String mergeStrategy)
boolean	pushToRemote(String siteId, String remoteName, String remoteBranch, boolean force)
void	rebuildDatabase(String siteId)
boolean	removeRemote(String siteId, String remoteName)
RepositoryStatus	resolveConflict(String siteId, String path, String resolution)
boolean	unlockRepository(String siteId, GitRepositories repositoryType)	Unlock local git repository

Method Detail

addRemote

boolean addRemote(String siteId,
                  RemoteRepository remoteRepository)
           throws ServiceLayerException,
                  InvalidRemoteUrlException,
                  RemoteRepositoryNotFoundException

Throws:

ServiceLayerException

InvalidRemoteUrlException

RemoteRepositoryNotFoundException

listRemotes

List<RemoteRepositoryInfo> listRemotes(String siteId)
                                throws ServiceLayerException,
                                       org.craftercms.commons.crypto.CryptoException

Throws:

ServiceLayerException

org.craftercms.commons.crypto.CryptoException

pullFromRemote

boolean pullFromRemote(String siteId,
                       String remoteName,
                       String remoteBranch,
                       String mergeStrategy)
                throws InvalidRemoteUrlException,
                       org.craftercms.commons.crypto.CryptoException,
                       ServiceLayerException,
                       InvalidRemoteRepositoryCredentialsException,
                       RemoteRepositoryNotFoundException

Throws:

InvalidRemoteUrlException

org.craftercms.commons.crypto.CryptoException

ServiceLayerException

InvalidRemoteRepositoryCredentialsException

RemoteRepositoryNotFoundException

pushToRemote

boolean pushToRemote(String siteId,
                     String remoteName,
                     String remoteBranch,
                     boolean force)
              throws InvalidRemoteUrlException,
                     ServiceLayerException,
                     org.craftercms.commons.crypto.CryptoException,
                     InvalidRemoteRepositoryCredentialsException,
                     RemoteRepositoryNotFoundException

Throws:

InvalidRemoteUrlException

ServiceLayerException

org.craftercms.commons.crypto.CryptoException

InvalidRemoteRepositoryCredentialsException

RemoteRepositoryNotFoundException

rebuildDatabase

void rebuildDatabase(String siteId)

removeRemote

boolean removeRemote(String siteId,
                     String remoteName)
              throws org.craftercms.commons.crypto.CryptoException,
                     SiteNotFoundException,
                     RemoteNotRemovableException

Throws:

org.craftercms.commons.crypto.CryptoException

SiteNotFoundException

RemoteNotRemovableException

getRepositoryStatus

RepositoryStatus getRepositoryStatus(String siteId)
                              throws org.craftercms.commons.crypto.CryptoException,
                                     ServiceLayerException

Throws:

org.craftercms.commons.crypto.CryptoException

ServiceLayerException

resolveConflict

RepositoryStatus resolveConflict(String siteId,
                                 String path,
                                 String resolution)
                          throws org.craftercms.commons.crypto.CryptoException,
                                 ServiceLayerException

Throws:

org.craftercms.commons.crypto.CryptoException

ServiceLayerException

getDiffForConflictedFile

DiffConflictedFile getDiffForConflictedFile(String siteId,
                                            String path)
                                     throws ServiceLayerException,
                                            org.craftercms.commons.crypto.CryptoException

Throws:

ServiceLayerException

org.craftercms.commons.crypto.CryptoException

commitResolution

RepositoryStatus commitResolution(String siteId,
                                  String commitMessage)
                           throws org.craftercms.commons.crypto.CryptoException,
                                  ServiceLayerException

Throws:

org.craftercms.commons.crypto.CryptoException

ServiceLayerException

cancelFailedPull

RepositoryStatus cancelFailedPull(String siteId)
                           throws ServiceLayerException,
                                  org.craftercms.commons.crypto.CryptoException

Throws:

ServiceLayerException

org.craftercms.commons.crypto.CryptoException

unlockRepository

boolean unlockRepository(String siteId,
                         GitRepositories repositoryType)
                  throws org.craftercms.commons.crypto.CryptoException

Unlock local git repository

Parameters:

siteId - site identifier, if null or empty it is global repository

repositoryType - repository type (GLOBAL, SANDBOX, PUBLISHED)

Returns:

true if successful

Throws:

org.craftercms.commons.crypto.CryptoException