1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
// Copyright (C) 2009 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.gerrit.server.git;
import com.google.gerrit.reviewdb.client.Project;
import com.google.inject.Singleton;
import org.eclipse.jgit.errors.RepositoryNotFoundException;
import org.eclipse.jgit.lib.Repository;
import java.io.IOException;
import java.util.SortedSet;
/**
* Manages Git repositories for the Gerrit server process.
* <p>
* Implementations of this interface should be a {@link Singleton} and
* registered in Guice so they are globally available within the server
* environment.
*/
public interface GitRepositoryManager {
/** Notes branch successful reviews are written to after being merged. */
public static final String REFS_NOTES_REVIEW = "refs/notes/review";
/** Note tree listing commits we refuse {@code refs/meta/reject-commits} */
public static final String REF_REJECT_COMMITS = "refs/meta/reject-commits";
/** Configuration settings for a project {@code refs/meta/config} */
public static final String REF_CONFIG = "refs/meta/config";
/**
* Prefix applied to merge commit base nodes.
* <p>
* References in this directory should take the form
* {@code refs/cache-automerge/xx/yyyy...} where xx is
* the first two digits of the merge commit's object
* name, and yyyyy... is the remaining 38. The reference
* should point to a treeish that is the automatic merge
* result of the merge commit's parents.
*/
public static final String REFS_CACHE_AUTOMERGE = "refs/cache-automerge/";
/**
* Get (or open) a repository by name.
*
* @param name the repository name, relative to the base directory.
* @return the cached Repository instance. Caller must call {@code close()}
* when done to decrement the resource handle.
* @throws RepositoryNotFoundException the name does not denote an existing
* repository, or the name cannot be read as a repository.
*/
public abstract Repository openRepository(Project.NameKey name)
throws RepositoryNotFoundException;
/**
* Create (and open) a repository by name.
*
* @param name the repository name, relative to the base directory.
* @return the cached Repository instance. Caller must call {@code 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.
* @throws RepositoryNotFoundException the name is invalid.
*/
public abstract Repository createRepository(Project.NameKey name)
throws RepositoryCaseMismatchException, RepositoryNotFoundException;
/** @return set of all known projects, sorted by natural NameKey order. */
public abstract SortedSet<Project.NameKey> list();
/**
* Read the {@code GIT_DIR/description} file for gitweb.
* <p>
* NB: This code should really be in JGit, as a member of the Repository
* object. Until it moves there, its here.
*
* @param name the repository name, relative to the base directory.
* @return description text; null if no description has been configured.
* @throws RepositoryNotFoundException the named repository does not exist.
* @throws IOException the description file exists, but is not readable by
* this process.
*/
public abstract String getProjectDescription(Project.NameKey name)
throws RepositoryNotFoundException, IOException;
/**
* Set the {@code GIT_DIR/description} file for gitweb.
* <p>
* NB: This code should really be in JGit, as a member of the Repository
* object. Until it moves there, its here.
*
* @param name the repository name, relative to the base directory.
* @param description new description text for the repository.
*/
public abstract void setProjectDescription(Project.NameKey name,
final String description);
}
|
