Class JGitEnvironmentRepository

java.lang.Object

org.springframework.cloud.config.server.support.AbstractScmAccessor

org.springframework.cloud.config.server.environment.AbstractScmEnvironmentRepository

org.springframework.cloud.config.server.environment.JGitEnvironmentRepository

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, EnvironmentRepository, SearchPathLocator, org.springframework.context.ResourceLoaderAware, org.springframework.core.Ordered

Direct Known Subclasses:

MultipleJGitEnvironmentRepository, MultipleJGitEnvironmentRepository.PatternMatchingJGitEnvironmentRepository

public class JGitEnvironmentRepository
extends AbstractScmEnvironmentRepository
implements EnvironmentRepository, SearchPathLocator, org.springframework.beans.factory.InitializingBean

An EnvironmentRepository backed by a single git repository.

Author:

Dave Syer, Roy Clarkson, Marcos Barbero, Daniel Lavoie, Ryan Lynch, Gareth Clay, ChaoDong Xi

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JGitEnvironmentRepository.JGitFactory	Wraps the static method calls to Git and CloneCommand allowing for easier unit testing.

Nested classes/interfaces inherited from interface SearchPathLocator

SearchPathLocator.Locations

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MESSAGE	Error message for URI for git repo.

Fields inherited from class AbstractScmAccessor

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
JGitEnvironmentRepository(org.springframework.core.env.ConfigurableEnvironment environment, JGitEnvironmentProperties properties, io.micrometer.observation.ObservationRegistry observationRegistry)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected org.eclipse.jgit.transport.FetchResult	fetch(org.eclipse.jgit.api.Git git, String label)
org.springframework.cloud.config.environment.Environment	findOne(String application, String profile, String label, boolean includeOrigin)
String	getDefaultLabel()
JGitEnvironmentRepository.JGitFactory	getGitFactory()
long	getLastRefresh()
SearchPathLocator.Locations	getLocations(String application, String profile, String label)
int	getRefreshRate()
int	getTimeout()
org.eclipse.jgit.api.TransportConfigCallback	getTransportConfigCallback()
boolean	isCloneOnStart()
boolean	isDeleteUntrackedBranches()
boolean	isForcePull()
boolean	isSkipSslValidation()
boolean	isTryMasterBranch()
protected void	onPullInvalidIndex(org.eclipse.jgit.api.Git git, org.eclipse.jgit.api.errors.JGitInternalException e)
String	refresh(String label)	Get the working directory ready.
void	setCloneOnStart(boolean cloneOnStart)
void	setDefaultLabel(String defaultLabel)
void	setDeleteUntrackedBranches(boolean deleteUntrackedBranches)
void	setForcePull(boolean forcePull)
void	setGitCredentialsProviderFactory(GitCredentialsProviderFactory gitCredentialsProviderFactory)
void	setGitFactory(JGitEnvironmentRepository.JGitFactory gitFactory)
void	setLastRefresh(long lastRefresh)
void	setRefreshRate(int refreshRate)
void	setSkipSslValidation(boolean skipSslValidation)
void	setTimeout(int timeout)
void	setTransportConfigCallback(org.eclipse.jgit.api.TransportConfigCallback transportConfigCallback)
void	setTryMasterBranch(boolean tryMasterBranch)
protected boolean	shouldPull(org.eclipse.jgit.api.Git git)
protected void	warn(String message, Exception ex)

Methods inherited from class AbstractScmEnvironmentRepository

findOne, getOrder, setOrder

Methods inherited from class AbstractScmAccessor

createBaseDir, getBasedir, getEnvironment, getPassphrase, getPassword, getSearchLocations, getSearchPaths, getUri, getUsername, getWorkingDirectory, isStrictHostKeyChecking, setBasedir, setEnvironment, setPassphrase, setPassword, setResourceLoader, setSearchPaths, setStrictHostKeyChecking, setUri, setUsername

Methods inherited from class Object

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

Methods inherited from interface EnvironmentRepository

findOne

Field Details

MESSAGE

public static final String MESSAGE

Error message for URI for git repo.

See Also:

• Constant Field Values

Constructor Details

JGitEnvironmentRepository

public JGitEnvironmentRepository(org.springframework.core.env.ConfigurableEnvironment environment,
 JGitEnvironmentProperties properties,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Method Details

isTryMasterBranch

public boolean isTryMasterBranch()

setTryMasterBranch

public void setTryMasterBranch(boolean tryMasterBranch)

isCloneOnStart

public boolean isCloneOnStart()

setCloneOnStart

public void setCloneOnStart(boolean cloneOnStart)

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

getRefreshRate

public int getRefreshRate()

setRefreshRate

public void setRefreshRate(int refreshRate)

getTransportConfigCallback

public org.eclipse.jgit.api.TransportConfigCallback getTransportConfigCallback()

setTransportConfigCallback

public void setTransportConfigCallback(org.eclipse.jgit.api.TransportConfigCallback transportConfigCallback)

getGitFactory

public JGitEnvironmentRepository.JGitFactory getGitFactory()

setGitFactory

public void setGitFactory(JGitEnvironmentRepository.JGitFactory gitFactory)

setGitCredentialsProviderFactory

public void setGitCredentialsProviderFactory(GitCredentialsProviderFactory gitCredentialsProviderFactory)

getDefaultLabel

public String getDefaultLabel()

setDefaultLabel

public void setDefaultLabel(String defaultLabel)

isForcePull

public boolean isForcePull()

setForcePull

public void setForcePull(boolean forcePull)

isDeleteUntrackedBranches

public boolean isDeleteUntrackedBranches()

setDeleteUntrackedBranches

public void setDeleteUntrackedBranches(boolean deleteUntrackedBranches)

isSkipSslValidation

public boolean isSkipSslValidation()

setSkipSslValidation

public void setSkipSslValidation(boolean skipSslValidation)

findOne

public org.springframework.cloud.config.environment.Environment findOne(String application,
 String profile,
 String label,
 boolean includeOrigin)

Specified by:

findOne in interface EnvironmentRepository

Overrides:

findOne in class AbstractScmEnvironmentRepository

getLocations

public SearchPathLocator.Locations getLocations(String application,
 String profile,
 String label)

Specified by:

getLocations in interface SearchPathLocator

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

refresh

public String refresh(String label)

Get the working directory ready.

Parameters:

label - label to refresh

Returns:

head id

shouldPull

protected boolean shouldPull(org.eclipse.jgit.api.Git git)
                      throws org.eclipse.jgit.api.errors.GitAPIException

Throws:

org.eclipse.jgit.api.errors.GitAPIException

onPullInvalidIndex

protected void onPullInvalidIndex(org.eclipse.jgit.api.Git git,
 org.eclipse.jgit.api.errors.JGitInternalException e)

fetch

protected org.eclipse.jgit.transport.FetchResult fetch(org.eclipse.jgit.api.Git git,
 String label)

warn

protected void warn(String message,
 Exception ex)

getLastRefresh

public long getLastRefresh()

setLastRefresh

public void setLastRefresh(long lastRefresh)