Show url of the repository where 'git gc' failed
[teamcity/git-plugin.git] / git-common / src / jetbrains / buildServer / buildTriggers / vcs / git / MirrorManager.java
1 /*
2  * Copyright 2000-2014 JetBrains s.r.o.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package jetbrains.buildServer.buildTriggers.vcs.git;
18
19 import org.jetbrains.annotations.NotNull;
20 import org.jetbrains.annotations.Nullable;
21
22 import java.io.File;
23 import java.util.Map;
24
25 /**
26  * Manages local mirror dirs of remote repositories
27  * @author dmitry.neverov
28  */
29 public interface MirrorManager {
30
31   /**
32    * @return parent dir of local repositories
33    */
34   @NotNull
35   File getBaseMirrorsDir();
36
37   /**
38    * Get default directory for remote repository with specified url
39    * @param repositoryUrl remote repository url
40    * @return see above
41    */
42   @NotNull
43   File getMirrorDir(@NotNull String repositoryUrl);
44
45   /**
46    * Mark dir as invalid, urls mapped to this dir will get another mapping
47    * on subsequent call to getMirrorDir()
48    * @param dir dir of interest
49    */
50   void invalidate(@NotNull File dir);
51
52
53   @NotNull
54   Map<String, File> getMappings();
55
56   long getLastUsedTime(@NotNull final File dir);
57
58   /**
59    * Returns url for the given clone directory name inside the baseMirrorsDir
60    * or null if mapping from the url is not found
61    * @param cloneDirName clone directory name of interest
62    * @return see above
63    */
64   @Nullable
65   String getUrl(@NotNull String cloneDirName);
66 }