Class FileRepository
- java.lang.Object
-
- org.eclipse.jgit.lib.Repository
-
- org.eclipse.jgit.internal.storage.file.FileRepository
-
- All Implemented Interfaces:
AutoCloseable
public class FileRepository extends Repository
Represents a Git repository. A repository holds all objects and refs used for managing source code (could by any type of file, but source code is what SCM's are typically used for). In Git terms all data is stored in GIT_DIR, typically a directory called .git. A work tree is maintained unless the repository is a bare repository. Typically the .git directory is located at the root of the work dir.- GIT_DIR
- objects/ - objects
- refs/ - tags and heads
- config - configuration
- info/ - more configurations
This class is thread-safe.
This implementation only handles a subtly undocumented subset of git features.
-
-
Constructor Summary
Constructors Constructor Description FileRepository(File gitDir)
Construct a representation of a Git repository.FileRepository(String gitDir)
A convenience API forFileRepository(File)
.FileRepository(BaseRepositoryBuilder options)
Create a repository using the local file system.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
autoGC(ProgressMonitor monitor)
Check whether any housekeeping is required; if yes, run garbage collection; if not, exit without performing any work.void
convertRefStorage(String format, boolean writeLogs, boolean backup)
Converts between ref storage formats.void
create(boolean bare)
Create a new Git repository initializing the necessary files and directories.AttributesNodeProvider
createAttributesNodeProvider()
Create a newAttributesNodeProvider
.Set<ObjectId>
getAdditionalHaves()
Objects known to exist but not expressed byRepository.getAllRefs()
.FileBasedConfig
getConfig()
Get the configuration of this repository.String
getGitwebDescription()
Read theGIT_DIR/description
file for gitweb.String
getIdentifier()
Get repository identifier.ObjectDirectory
getObjectDatabase()
Get the object database which stores this repository's data.File
getObjectsDirectory()
Get the directory containing the objects owned by this repositoryRefDatabase
getRefDatabase()
Get the reference database which stores the reference namespace.ReflogReader
getReflogReader(String refName)
Get the reflog readervoid
notifyIndexChanged(boolean internal)
Notify that the index changed by firing an IndexChangedEvent.void
openPack(File pack)
Add a single existing pack to the list of available pack files.void
scanForRepoChanges()
Force a scan for changed refs.void
setGitwebDescription(String description)
Set theGIT_DIR/description
file for gitweb.-
Methods inherited from class org.eclipse.jgit.lib.Repository
close, create, doClose, exactRef, findRef, fireEvent, getAllRefs, getAllRefsByPeeledObjectId, getBranch, getDirectory, getFS, getFullBranch, getGlobalListenerList, getIndexFile, getInitialBranch, getListenerList, getRemoteName, getRemoteNames, getRepositoryState, getTags, getWorkTree, hasObject, incrementOpen, isBare, isValidRefName, lockDirCache, newObjectInserter, newObjectReader, normalizeBranchName, open, open, parseCommit, peel, readCherryPickHead, readCommitEditMsg, readDirCache, readMergeCommitMsg, readMergeHeads, readOrigHead, readRebaseTodo, readRevertHead, readSquashCommitMsg, renameRef, resolve, shortenRefName, shortenRemoteBranchName, simplify, stripWorkDir, toString, updateRef, updateRef, writeCherryPickHead, writeCommitEditMsg, writeMergeCommitMsg, writeMergeHeads, writeOrigHead, writeRebaseTodoFile, writeRevertHead, writeSquashCommitMsg
-
-
-
-
Constructor Detail
-
FileRepository
public FileRepository(File gitDir) throws IOException
Construct a representation of a Git repository.The work tree, object directory, alternate object directories and index file locations are deduced from the given git directory and the default rules by running
FileRepositoryBuilder
. This constructor is the same as saying:new FileRepositoryBuilder().setGitDir(gitDir).build()
- Parameters:
gitDir
- GIT_DIR (the location of the repository metadata).- Throws:
IOException
- the repository appears to already exist but cannot be accessed.- See Also:
FileRepositoryBuilder
-
FileRepository
public FileRepository(String gitDir) throws IOException
A convenience API forFileRepository(File)
.- Parameters:
gitDir
- GIT_DIR (the location of the repository metadata).- Throws:
IOException
- the repository appears to already exist but cannot be accessed.- See Also:
FileRepositoryBuilder
-
FileRepository
public FileRepository(BaseRepositoryBuilder options) throws IOException
Create a repository using the local file system.- Parameters:
options
- description of the repository's important paths.- Throws:
IOException
- the user configuration file or repository configuration file cannot be accessed.
-
-
Method Detail
-
create
public void create(boolean bare) throws IOException
Create a new Git repository initializing the necessary files and directories.Create a new Git repository initializing the necessary files and directories.
- Specified by:
create
in classRepository
- Parameters:
bare
- if true, a bare repository (a repository without a working directory) is created.- Throws:
IOException
- in case of IO problem
-
getObjectsDirectory
public File getObjectsDirectory()
Get the directory containing the objects owned by this repository- Returns:
- the directory containing the objects owned by this repository.
-
getObjectDatabase
public ObjectDirectory getObjectDatabase()
Get the object database which stores this repository's data.- Specified by:
getObjectDatabase
in classRepository
- Returns:
- the object database which stores this repository's data.
-
getRefDatabase
public RefDatabase getRefDatabase()
Get the reference database which stores the reference namespace.- Specified by:
getRefDatabase
in classRepository
- Returns:
- the reference database which stores the reference namespace.
-
getIdentifier
public String getIdentifier()
Get repository identifier.- Specified by:
getIdentifier
in classRepository
- Returns:
- repository identifier. The returned identifier has to be unique within a given Git server.
-
getConfig
public FileBasedConfig getConfig()
Get the configuration of this repository.- Specified by:
getConfig
in classRepository
- Returns:
- the configuration of this repository.
-
getGitwebDescription
@Nullable public String getGitwebDescription() throws IOException
Read theGIT_DIR/description
file for gitweb.- Overrides:
getGitwebDescription
in classRepository
- Returns:
- description text; null if no description has been configured.
- Throws:
IOException
- description cannot be accessed.
-
setGitwebDescription
public void setGitwebDescription(@Nullable String description) throws IOException
Set theGIT_DIR/description
file for gitweb.- Overrides:
setGitwebDescription
in classRepository
- Parameters:
description
- new description; null to clear the description.- Throws:
IOException
- description cannot be persisted.
-
getAdditionalHaves
public Set<ObjectId> getAdditionalHaves() throws IOException
Objects known to exist but not expressed byRepository.getAllRefs()
.When a repository borrows objects from another repository, it can advertise that it safely has that other repository's references, without exposing any other details about the other repository. This may help a client trying to push changes avoid pushing more than it needs to.
Objects known to exist but not expressed by
#getAllRefs()
.When a repository borrows objects from another repository, it can advertise that it safely has that other repository's references, without exposing any other details about the other repository. This may help a client trying to push changes avoid pushing more than it needs to.
- Overrides:
getAdditionalHaves
in classRepository
- Returns:
- unmodifiable collection of other known objects.
- Throws:
IOException
-
openPack
public void openPack(File pack) throws IOException
Add a single existing pack to the list of available pack files.- Parameters:
pack
- path of the pack file to open.- Throws:
IOException
- index file could not be opened, read, or is not recognized as a Git pack file index.
-
scanForRepoChanges
public void scanForRepoChanges() throws IOException
Force a scan for changed refs. Fires an IndexChangedEvent(false) if changes are detected.- Specified by:
scanForRepoChanges
in classRepository
- Throws:
IOException
-
notifyIndexChanged
public void notifyIndexChanged(boolean internal)
Notify that the index changed by firing an IndexChangedEvent.- Specified by:
notifyIndexChanged
in classRepository
- Parameters:
internal
-true
if the index was changed by the same JGit process
-
getReflogReader
public ReflogReader getReflogReader(String refName) throws IOException
Get the reflog reader- Specified by:
getReflogReader
in classRepository
- Parameters:
refName
- aString
object.- Returns:
- a
ReflogReader
for the supplied refname, ornull
if the named ref does not exist. - Throws:
IOException
- the ref could not be accessed.
-
createAttributesNodeProvider
public AttributesNodeProvider createAttributesNodeProvider()
Create a newAttributesNodeProvider
.- Specified by:
createAttributesNodeProvider
in classRepository
- Returns:
- a new
AttributesNodeProvider
. ThisAttributesNodeProvider
is lazy loaded only once. It means that it will not be updated after loading. Prefer creating new instance for each use.
-
autoGC
public void autoGC(ProgressMonitor monitor)
Check whether any housekeeping is required; if yes, run garbage collection; if not, exit without performing any work. Some JGit commands run autoGC after performing operations that could create many loose objects.Currently this option is supported for repositories of type
FileRepository
only. SeeGC.setAuto(boolean)
for configuration details.- Overrides:
autoGC
in classRepository
- Parameters:
monitor
- to report progress
-
convertRefStorage
public void convertRefStorage(String format, boolean writeLogs, boolean backup) throws IOException
Converts between ref storage formats.- Parameters:
format
- the format to convert to, either "reftable" or "refdir"writeLogs
- whether to write reflogsbackup
- whether to make a backup of the old data- Throws:
IOException
- on I/O problems.
-
-