LocalDiskRepositoryManager (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.git.LocalDiskRepositoryManager

All Implemented Interfaces:

com.google.gerrit.extensions.events.LifecycleListener, GitRepositoryManager, EventListener

Direct Known Subclasses:

MultiBaseLocalDiskRepositoryManager
```
public class LocalDiskRepositoryManager
extends Object
implements GitRepositoryManager, com.google.gerrit.extensions.events.LifecycleListener
```
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`
`protected class`	`LocalDiskRepositoryManager.ProjectVisitor`

Method Summary

Methods
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.
`Path`	`getBasePath(com.google.gerrit.reviewdb.client.Project.NameKey name)` Return the basePath under which the specified project is stored.
`String`	`getProjectDescription(com.google.gerrit.reviewdb.client.Project.NameKey name)` Read the `GIT_DIR/description` file for gitweb.
`SortedSet<com.google.gerrit.reviewdb.client.Project.NameKey>`	`list()`
`org.eclipse.jgit.lib.Repository`	`openRepository(com.google.gerrit.reviewdb.client.Project.NameKey name)` Get (or open) a repository by name.
`protected void`	`scanProjects(LocalDiskRepositoryManager.ProjectVisitor visitor)`
`void`	`setProjectDescription(com.google.gerrit.reviewdb.client.Project.NameKey name, String description)` Set the `GIT_DIR/description` file for gitweb.
`void`	`start()`
`void`	`stop()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - start
```
public void start()
```
    Specified by:
    
    start in interface com.google.gerrit.extensions.events.LifecycleListener
  - stop
```
public void stop()
```
    Specified by:
    
    stop in interface com.google.gerrit.extensions.events.LifecycleListener
  - getBasePath
```
public Path getBasePath(com.google.gerrit.reviewdb.client.Project.NameKey name)
```
    Return the basePath under which the specified project is stored.
    
    Parameters:
    name - the name of the project
    
    Returns:
    base directory
  - 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.
    
    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.
  - getProjectDescription
```
public String getProjectDescription(com.google.gerrit.reviewdb.client.Project.NameKey name)
                             throws org.eclipse.jgit.errors.RepositoryNotFoundException,
                                    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.
    
    IOException - the description file exists, but is not readable by this process.
  - setProjectDescription
```
public void setProjectDescription(com.google.gerrit.reviewdb.client.Project.NameKey name,
                         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 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.
  - scanProjects
```
protected void scanProjects(LocalDiskRepositoryManager.ProjectVisitor visitor)
```

Class LocalDiskRepositoryManager

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

start

stop

getBasePath

openRepository

createRepository

getProjectDescription

setProjectDescription

list

scanProjects