com.google.gerrit.server.git

Class LocalDiskRepositoryManager

java.lang.Object

com.google.gerrit.server.git.LocalDiskRepositoryManager

All Implemented Interfaces:

GitRepositoryManager

public class LocalDiskRepositoryManager
extends java.lang.Object
implements GitRepositoryManager

Manages Git repositories stored on the local filesystem.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalDiskRepositoryManager.Lifecycle
static class	LocalDiskRepositoryManager.Module

Method Summary

Modifier and Type	Method and Description
org.eclipse.jgit.lib.Repository	createRepository(com.google.gerrit.reviewdb.client.Project.NameKey name) Create (and open) a repository by name.
java.io.File	getBasePath()
java.lang.String	getProjectDescription(com.google.gerrit.reviewdb.client.Project.NameKey name) Read the GIT_DIR/description file for gitweb.
java.util.SortedSet<com.google.gerrit.reviewdb.client.Project.NameKey>	list()
org.eclipse.jgit.lib.Repository	openMetadataRepository(com.google.gerrit.reviewdb.client.Project.NameKey name) Open the repository storing metadata for the given project.
org.eclipse.jgit.lib.Repository	openRepository(com.google.gerrit.reviewdb.client.Project.NameKey name) Get (or open) a repository by name.
void	setProjectDescription(com.google.gerrit.reviewdb.client.Project.NameKey name, java.lang.String description) Set the GIT_DIR/description file for gitweb.

Methods inherited from class java.lang.Object

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

Method Detail

getBasePath

public java.io.File getBasePath()

Returns:

base directory under which all projects are stored.

openRepository

public org.eclipse.jgit.lib.Repository openRepository(com.google.gerrit.reviewdb.client.Project.NameKey name)
                                               throws org.eclipse.jgit.errors.RepositoryNotFoundException

Description copied from interface: GitRepositoryManager

Get (or open) a repository by name.

Specified by:

openRepository in interface GitRepositoryManager

Parameters:

name - the repository name, relative to the base directory.

Returns:

the cached Repository instance. Caller must call close() when done to decrement the resource handle.

Throws:

org.eclipse.jgit.errors.RepositoryNotFoundException - the name does not denote an existing repository.

createRepository

public org.eclipse.jgit.lib.Repository createRepository(com.google.gerrit.reviewdb.client.Project.NameKey name)
                                                 throws org.eclipse.jgit.errors.RepositoryNotFoundException,
                                                        RepositoryCaseMismatchException

Description copied from interface: GitRepositoryManager

Create (and open) a repository by name.

If the implementation supports separate metadata repositories, this method must also create the metadata repository, but does not open it.

Specified by:

createRepository in interface GitRepositoryManager

Parameters:

name - the repository name, relative to the base directory.

Returns:

the cached Repository instance. Caller must call close() when done to decrement the resource handle.

Throws:

RepositoryCaseMismatchException - the name collides with an existing repository name, but only in case of a character within the name.

org.eclipse.jgit.errors.RepositoryNotFoundException - the name is invalid.

openMetadataRepository

public org.eclipse.jgit.lib.Repository openMetadataRepository(com.google.gerrit.reviewdb.client.Project.NameKey name)
                                                       throws org.eclipse.jgit.errors.RepositoryNotFoundException,
                                                              java.io.IOException

Description copied from interface: GitRepositoryManager

Open the repository storing metadata for the given project.

This includes any project-specific metadata except what is stored in refs/meta/config. Implementations may choose to store all metadata in the original project.

Specified by:

openMetadataRepository in interface GitRepositoryManager

Parameters:

name - the base project name name.

Returns:

the cached metadata Repository instance. Caller must call close() when done to decrement the resource handle.

Throws:

org.eclipse.jgit.errors.RepositoryNotFoundException - the name does not denote an existing repository.

java.io.IOException - the name cannot be read as a repository.

getProjectDescription

public java.lang.String getProjectDescription(com.google.gerrit.reviewdb.client.Project.NameKey name)
                                       throws org.eclipse.jgit.errors.RepositoryNotFoundException,
                                              java.io.IOException

Description copied from interface: GitRepositoryManager

Read the GIT_DIR/description file for gitweb.

NB: This code should really be in JGit, as a member of the Repository object. Until it moves there, its here.

Specified by:

getProjectDescription in interface GitRepositoryManager

Parameters:

name - the repository name, relative to the base directory.

Returns:

description text; null if no description has been configured.

Throws:

org.eclipse.jgit.errors.RepositoryNotFoundException - the named repository does not exist.

java.io.IOException - the description file exists, but is not readable by this process.

setProjectDescription

public void setProjectDescription(com.google.gerrit.reviewdb.client.Project.NameKey name,
                                  java.lang.String description)

Description copied from interface: GitRepositoryManager

Set the GIT_DIR/description file for gitweb.

NB: This code should really be in JGit, as a member of the Repository object. Until it moves there, its here.

Specified by:

setProjectDescription in interface GitRepositoryManager

Parameters:

name - the repository name, relative to the base directory.

description - new description text for the repository.

list

public java.util.SortedSet<com.google.gerrit.reviewdb.client.Project.NameKey> list()

Specified by:

list in interface GitRepositoryManager

Returns:

set of all known projects, sorted by natural NameKey order.