io.fabric8.git.internal

Class GitDataStore

java.lang.Object

io.fabric8.api.scr.AbstractComponent

io.fabric8.service.AbstractDataStore<GitDataStore>

io.fabric8.git.internal.GitDataStore

All Implemented Interfaces:

io.fabric8.api.DataStore, io.fabric8.api.scr.Validatable, org.apache.curator.framework.recipes.cache.PathChildrenCacheListener

Direct Known Subclasses:

CachingGitDataStore

@ThreadSafe
public class GitDataStore
extends io.fabric8.service.AbstractDataStore<GitDataStore>

A git based implementation of DataStore which stores the profile configuration versions in a branch per version and directory per profile.

Nested Class Summary

Nested classes/interfaces inherited from interface io.fabric8.api.DataStore

io.fabric8.api.DataStore.ContainerAttribute

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGENT_METADATA_FILE
static String	CONFIGS
static String	CONFIGS_PROFILES
static int	GIT_COMMIT_SHORT_LENGTH
static String	GIT_PULL_PERIOD
static String	GIT_REMOTE_PASSWORD
static String	GIT_REMOTE_URL
static String	GIT_REMOTE_USER
static String[]	SUPPORTED_CONFIGURATION
static String	TYPE

Fields inherited from class io.fabric8.service.AbstractDataStore

JVM_OPTIONS_PATH, REQUIREMENTS_JSON_PATH

Fields inherited from interface io.fabric8.api.DataStore

ATTRIBUTE_PREFIX, DATASTORE_TYPE_PROPERTY, DEFAULT_DATASTORE_TYPE

Constructor Summary

Constructors

Constructor and Description
GitDataStore()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activateInternal()
void	bindGitProxyService(GitProxyService service)
void	bindGitService(GitService service)
protected void	checkoutVersion(org.eclipse.jgit.api.Git git, String version)
String	convertProfileIdToDirectory(String profileId) Takes a profile ID of the form "foo-bar" and if we are using directory trees for profiles then converts it to "foo/bar.profile"
protected void	createOrCheckoutVersion(org.eclipse.jgit.api.Git git, String version)
void	createProfile(String version, String profile)
void	createVersion(String version)
void	createVersion(String parentVersionId, String toVersion)
protected void	deactivateInternal()
void	deleteProfile(String version, String profile)
void	deleteVersion(String version)
protected void	doAddFiles(org.eclipse.jgit.api.Git git, File... files)
protected String	doCreateProfile(org.eclipse.jgit.api.Git git, GitContext context, String profile, String version) Creates the given profile directory in the currently checked out version branch
protected String	doExportProfiles(org.eclipse.jgit.api.Git git, GitContext context, File outputFile, FileFilter filter) exports one or more profile folders from the given version into the zip
protected Map<String,Map<String,String>>	doGetConfigurations(org.eclipse.jgit.api.Git git, String profile)
protected Map<String,byte[]>	doGetFileConfigurations(org.eclipse.jgit.api.Git git, String profile)
protected String	doImportProfiles(org.eclipse.jgit.api.Git git, GitContext context, List<String> profileZipUrls) Imports one or more profile zips into the given version
protected Map<String,String>	doLoadConfiguration(File file)
protected byte[]	doLoadFileConfiguration(File file)
protected void	doPull(org.eclipse.jgit.api.Git git, org.eclipse.jgit.transport.CredentialsProvider credentialsProvider, boolean doDeleteBranches) Performs a pull so the git repo is pretty much up to date before we start performing operations on it.
Iterable<org.eclipse.jgit.transport.PushResult>	doPush(org.eclipse.jgit.api.Git git, GitContext gitContext) Pushes any changes - assumed to be invoked within a gitOperation method!
protected Iterable<org.eclipse.jgit.transport.PushResult>	doPush(org.eclipse.jgit.api.Git git, GitContext gitContext, org.eclipse.jgit.transport.CredentialsProvider credentialsProvider) Pushes any committed changes to the remote repo
protected void	doRecursiveDeleteAndRemove(org.eclipse.jgit.api.Git git, File file)
protected void	doSetConfiguration(org.eclipse.jgit.api.Git git, String profile, String pid, Map<String,String> configuration)
protected void	doSetConfigurations(org.eclipse.jgit.api.Git git, File profileDirectory, String profile, Map<String,Map<String,String>> configurations)
protected void	doSetFileConfiguration(org.eclipse.jgit.api.Git git, String profile, String fileName, byte[] configuration)
protected void	doSetFileConfigurations(org.eclipse.jgit.api.Git git, File profileDirectory, String profile, Map<String,byte[]> configurations)
void	exportProfiles(String version, String outputFileName, String wildcard)
protected List<String>	forceGetVersions()
String	getClusterId()
Map<String,String>	getConfiguration(String version, String profile, String pid)
protected org.eclipse.jgit.transport.CredentialsProvider	getCredentialsProvider()
String	getDefaultJvmOptions()
List<String>	getEnsembleContainers()
byte[]	getFileConfiguration(String version, String profile, String fileName)
Map<String,byte[]>	getFileConfigurations(String version, String profile)
protected String	getFilePattern(File rootDir, File file)
org.eclipse.jgit.api.Git	getGit()
String	getLastModified(String version, String profile)
protected File	getPidFile(File profileDirectory, String pid)
protected String	getPidFromFileName(String relativePath)
String	getProfile(String version, String profile, boolean create)
File	getProfileDirectory(org.eclipse.jgit.api.Git git, String profile)
List<String>	getProfiles(String version)
protected File	getProfilesDirectory(org.eclipse.jgit.api.Git git)
String	getRemote()
io.fabric8.api.FabricRequirements	getRequirements()
String	getType()
Map<String,String>	getVersionAttributes(String version)
List<String>	getVersions()
<T> T	gitOperation(GitOperation<T> operation) Performs a set of operations on the git repository & avoids concurrency issues
<T> T	gitOperation(GitOperation<T> operation, boolean pullFirst)
<T> T	gitOperation(org.eclipse.jgit.lib.PersonIdent personIdent, GitOperation<T> operation, boolean pullFirst)
<T> T	gitOperation(org.eclipse.jgit.lib.PersonIdent personIdent, GitOperation<T> operation, boolean pullFirst, GitContext context)
boolean	hasVersion(String name)
void	importFromFileSystem(File from, String destinationPath, String version, boolean isProfileDir)
void	importFromFilesystem(String path)
void	importFromFileSystem(String from)
void	importProfiles(String version, List<String> profileZipUrls)
protected boolean	isProfileDirectory(File profileDir)
Collection<String>	listFiles(String version, Iterable<String> profiles, String path)
protected void	pull()
protected void	push()
protected void	recursiveAddLegacyProfileDirectoryFiles(org.eclipse.jgit.api.Git git, File from, File toDir, String path) Recursively copies the profiles in a single flat directory into the new directory layout; changing "foo-bar" directory into "foo/bar.profile" along the way
protected void	recursiveCopyAndAdd(org.eclipse.jgit.api.Git git, File from, File toDir, String path, boolean useToDirAsDestination) Recursively copies the given files from the given directory to the specified directory adding them to the git repo along the way
void	setConfiguration(String version, String profile, String pid, Map<String,String> configuration)
void	setConfigurationFile(String version, String profile, String fileName, byte[] data)
void	setConfigurations(String version, String profile, Map<String,Map<String,String>> configurations)
void	setDefaultJvmOptions(String jvmOptions)
void	setFileConfiguration(String version, String profile, String fileName, byte[] configuration)
void	setFileConfigurations(String version, String profile, Map<String,byte[]> configurations)
void	setRemote(String remote) Sets the name of the remote repository
void	setRequirements(io.fabric8.api.FabricRequirements requirements)
void	setVersionAttribute(String version, String key, String value)

Methods inherited from class io.fabric8.service.AbstractDataStore

bindCurator, bindRegistrationHandler, bindRuntimeProperties, childEvent, clearCaches, createContainerConfig, createContainerConfig, deleteContainer, doRunCallbacks, fireChangeNotifications, getConfigurationFileNames, getConfigurations, getContainerAttribute, getContainerMetadata, getContainerParent, getContainerProfiles, getContainers, getContainerVersion, getCurator, getDataStoreProperties, getDefaultVersion, getProfileAttributes, getRuntimeProperties, getTreeCache, hasContainer, hasProfile, isContainerAlive, protectedActivate, protectedDeactivate, runCallbacks, setContainerAlive, setContainerAttribute, setContainerMetadata, setContainerProfiles, setContainerVersion, setDefaultVersion, setProfileAttribute, trackConfiguration, unbindCurator, unbindRegistrationHandler, unbindRuntimeProperties, untrackConfiguration

Methods inherited from class io.fabric8.api.scr.AbstractComponent

activateComponent, assertValid, deactivateComponent, isValid

Methods inherited from class java.lang.Object

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

Field Detail

GIT_PULL_PERIOD

public static final String GIT_PULL_PERIOD

See Also:

Constant Field Values

GIT_REMOTE_URL

public static final String GIT_REMOTE_URL

See Also:

Constant Field Values

GIT_REMOTE_USER

public static final String GIT_REMOTE_USER

See Also:

Constant Field Values

GIT_REMOTE_PASSWORD

public static final String GIT_REMOTE_PASSWORD

See Also:

Constant Field Values

SUPPORTED_CONFIGURATION

public static final String[] SUPPORTED_CONFIGURATION

CONFIGS

public static final String CONFIGS

See Also:

Constant Field Values

CONFIGS_PROFILES

public static final String CONFIGS_PROFILES

AGENT_METADATA_FILE

public static final String AGENT_METADATA_FILE

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

GIT_COMMIT_SHORT_LENGTH

public static final int GIT_COMMIT_SHORT_LENGTH

See Also:

Constant Field Values

Constructor Detail

GitDataStore

public GitDataStore()

Method Detail

activateInternal

protected void activateInternal()

Overrides:

activateInternal in class io.fabric8.service.AbstractDataStore<GitDataStore>

deactivateInternal

protected void deactivateInternal()

Overrides:

deactivateInternal in class io.fabric8.service.AbstractDataStore<GitDataStore>

importFromFilesystem

public void importFromFilesystem(String path)

getRemote

public String getRemote()

setRemote

public void setRemote(String remote)

Sets the name of the remote repository

importFromFileSystem

public void importFromFileSystem(String from)

Specified by:

importFromFileSystem in interface io.fabric8.api.DataStore

Specified by:

importFromFileSystem in class io.fabric8.service.AbstractDataStore<GitDataStore>

importFromFileSystem

public void importFromFileSystem(File from,
                        String destinationPath,
                        String version,
                        boolean isProfileDir)

createVersion

public void createVersion(String version)

createVersion

public void createVersion(String parentVersionId,
                 String toVersion)

deleteVersion

public void deleteVersion(String version)

getVersions

public List<String> getVersions()

forceGetVersions

protected List<String> forceGetVersions()

hasVersion

public boolean hasVersion(String name)

getProfiles

public List<String> getProfiles(String version)

getProfilesDirectory

protected File getProfilesDirectory(org.eclipse.jgit.api.Git git)

getProfileDirectory

public File getProfileDirectory(org.eclipse.jgit.api.Git git,
                       String profile)

getProfile

public String getProfile(String version,
                String profile,
                boolean create)

importProfiles

public void importProfiles(String version,
                  List<String> profileZipUrls)

exportProfiles

public void exportProfiles(String version,
                  String outputFileName,
                  String wildcard)

createProfile

public void createProfile(String version,
                 String profile)

deleteProfile

public void deleteProfile(String version,
                 String profile)

getVersionAttributes

public Map<String,String> getVersionAttributes(String version)

setVersionAttribute

public void setVersionAttribute(String version,
                       String key,
                       String value)

getLastModified

public String getLastModified(String version,
                     String profile)

listFiles

public Collection<String> listFiles(String version,
                           Iterable<String> profiles,
                           String path)

getFileConfigurations

public Map<String,byte[]> getFileConfigurations(String version,
                                       String profile)

doGetFileConfigurations

protected Map<String,byte[]> doGetFileConfigurations(org.eclipse.jgit.api.Git git,
                                         String profile)
                                              throws IOException

Throws:

IOException

doGetConfigurations

protected Map<String,Map<String,String>> doGetConfigurations(org.eclipse.jgit.api.Git git,
                                                 String profile)
                                                      throws IOException

Throws:

IOException

getFileConfiguration

public byte[] getFileConfiguration(String version,
                          String profile,
                          String fileName)

setFileConfigurations

public void setFileConfigurations(String version,
                         String profile,
                         Map<String,byte[]> configurations)

doSetFileConfigurations

protected void doSetFileConfigurations(org.eclipse.jgit.api.Git git,
                           File profileDirectory,
                           String profile,
                           Map<String,byte[]> configurations)
                                throws IOException,
                                       org.eclipse.jgit.api.errors.GitAPIException

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

doSetConfigurations

protected void doSetConfigurations(org.eclipse.jgit.api.Git git,
                       File profileDirectory,
                       String profile,
                       Map<String,Map<String,String>> configurations)
                            throws IOException,
                                   org.eclipse.jgit.api.errors.GitAPIException

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

setFileConfiguration

public void setFileConfiguration(String version,
                        String profile,
                        String fileName,
                        byte[] configuration)

doSetFileConfiguration

protected void doSetFileConfiguration(org.eclipse.jgit.api.Git git,
                          String profile,
                          String fileName,
                          byte[] configuration)
                               throws IOException,
                                      org.eclipse.jgit.api.errors.GitAPIException

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

doSetConfiguration

protected void doSetConfiguration(org.eclipse.jgit.api.Git git,
                      String profile,
                      String pid,
                      Map<String,String> configuration)
                           throws IOException,
                                  org.eclipse.jgit.api.errors.GitAPIException

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

getPidFile

protected File getPidFile(File profileDirectory,
              String pid)

getPidFromFileName

protected String getPidFromFileName(String relativePath)
                             throws IOException

Throws:

IOException

getConfiguration

public Map<String,String> getConfiguration(String version,
                                  String profile,
                                  String pid)

setConfigurations

public void setConfigurations(String version,
                     String profile,
                     Map<String,Map<String,String>> configurations)

setConfiguration

public void setConfiguration(String version,
                    String profile,
                    String pid,
                    Map<String,String> configuration)

setConfigurationFile

public void setConfigurationFile(String version,
                        String profile,
                        String fileName,
                        byte[] data)

getDefaultJvmOptions

public String getDefaultJvmOptions()

setDefaultJvmOptions

public void setDefaultJvmOptions(String jvmOptions)

getRequirements

public io.fabric8.api.FabricRequirements getRequirements()

setRequirements

public void setRequirements(io.fabric8.api.FabricRequirements requirements)
                     throws IOException

Throws:

IOException

getClusterId

public String getClusterId()

getEnsembleContainers

public List<String> getEnsembleContainers()

getGit

public org.eclipse.jgit.api.Git getGit()
                                throws IOException

Throws:

IOException

gitOperation

public <T> T gitOperation(GitOperation<T> operation)

Performs a set of operations on the git repository & avoids concurrency issues

gitOperation

public <T> T gitOperation(GitOperation<T> operation,
                 boolean pullFirst)

gitOperation

public <T> T gitOperation(org.eclipse.jgit.lib.PersonIdent personIdent,
                 GitOperation<T> operation,
                 boolean pullFirst)

gitOperation

public <T> T gitOperation(org.eclipse.jgit.lib.PersonIdent personIdent,
                 GitOperation<T> operation,
                 boolean pullFirst,
                 GitContext context)

doPush

public Iterable<org.eclipse.jgit.transport.PushResult> doPush(org.eclipse.jgit.api.Git git,
                                                     GitContext gitContext)
                                                       throws Exception

Pushes any changes - assumed to be invoked within a gitOperation method!

Throws:

Exception

doPush

protected Iterable<org.eclipse.jgit.transport.PushResult> doPush(org.eclipse.jgit.api.Git git,
                                                     GitContext gitContext,
                                                     org.eclipse.jgit.transport.CredentialsProvider credentialsProvider)
                                                          throws Exception

Pushes any committed changes to the remote repo

Throws:

Exception

getCredentialsProvider

protected org.eclipse.jgit.transport.CredentialsProvider getCredentialsProvider()

doPull

protected void doPull(org.eclipse.jgit.api.Git git,
          org.eclipse.jgit.transport.CredentialsProvider credentialsProvider,
          boolean doDeleteBranches)

Performs a pull so the git repo is pretty much up to date before we start performing operations on it.

Parameters:

git - The Git instance to use.

credentialsProvider - The CredentialsProvider to use.

doDeleteBranches - Flag that determines if local branches that don't exist in remote should get deleted.

doCreateProfile

protected String doCreateProfile(org.eclipse.jgit.api.Git git,
                     GitContext context,
                     String profile,
                     String version)
                          throws IOException,
                                 org.eclipse.jgit.api.errors.GitAPIException

Creates the given profile directory in the currently checked out version branch

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

doImportProfiles

protected String doImportProfiles(org.eclipse.jgit.api.Git git,
                      GitContext context,
                      List<String> profileZipUrls)
                           throws org.eclipse.jgit.api.errors.GitAPIException,
                                  IOException

Imports one or more profile zips into the given version

Throws:

org.eclipse.jgit.api.errors.GitAPIException

IOException

doExportProfiles

protected String doExportProfiles(org.eclipse.jgit.api.Git git,
                      GitContext context,
                      File outputFile,
                      FileFilter filter)
                           throws IOException

exports one or more profile folders from the given version into the zip

Throws:

IOException

recursiveCopyAndAdd

protected void recursiveCopyAndAdd(org.eclipse.jgit.api.Git git,
                       File from,
                       File toDir,
                       String path,
                       boolean useToDirAsDestination)
                            throws org.eclipse.jgit.api.errors.GitAPIException,
                                   IOException

Recursively copies the given files from the given directory to the specified directory adding them to the git repo along the way

Throws:

org.eclipse.jgit.api.errors.GitAPIException

IOException

recursiveAddLegacyProfileDirectoryFiles

protected void recursiveAddLegacyProfileDirectoryFiles(org.eclipse.jgit.api.Git git,
                                           File from,
                                           File toDir,
                                           String path)
                                                throws org.eclipse.jgit.api.errors.GitAPIException,
                                                       IOException

Recursively copies the profiles in a single flat directory into the new directory layout; changing "foo-bar" directory into "foo/bar.profile" along the way

Throws:

org.eclipse.jgit.api.errors.GitAPIException

IOException

isProfileDirectory

protected boolean isProfileDirectory(File profileDir)

convertProfileIdToDirectory

public String convertProfileIdToDirectory(String profileId)

Takes a profile ID of the form "foo-bar" and if we are using directory trees for profiles then converts it to "foo/bar.profile"

pull

protected void pull()

push

protected void push()

createOrCheckoutVersion

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

Throws:

org.eclipse.jgit.api.errors.GitAPIException

checkoutVersion

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

Throws:

org.eclipse.jgit.api.errors.GitAPIException

doAddFiles

protected void doAddFiles(org.eclipse.jgit.api.Git git,
              File... files)
                   throws org.eclipse.jgit.api.errors.GitAPIException,
                          IOException

Throws:

org.eclipse.jgit.api.errors.GitAPIException

IOException

doRecursiveDeleteAndRemove

protected void doRecursiveDeleteAndRemove(org.eclipse.jgit.api.Git git,
                              File file)
                                   throws IOException,
                                          org.eclipse.jgit.api.errors.GitAPIException

Throws:

IOException

org.eclipse.jgit.api.errors.GitAPIException

doLoadFileConfiguration

protected byte[] doLoadFileConfiguration(File file)
                                  throws IOException

Throws:

IOException

doLoadConfiguration

protected Map<String,String> doLoadConfiguration(File file)
                                          throws IOException

Throws:

IOException

getFilePattern

protected String getFilePattern(File rootDir,
                    File file)
                         throws IOException

Throws:

IOException

getType

public String getType()

bindGitService

public void bindGitService(GitService service)

bindGitProxyService

public void bindGitProxyService(GitProxyService service)