();
delegateListener = new DelegateListener();
+ gitRepository.increaseClientUsage();
}
/**
@@ -755,6 +756,17 @@
cmd.execute();
return cmd.getResult();
}
+
+ /**
+ * Marks this client as released and notifies the repository it does not
+ * have to stay open for this client. When all repository's clients are
+ * released the repository closes, flushes all cached metadata and closes
+ * all opened metadata files and file descriptors.
+ * @since 1.5
+ */
+ public void release () {
+ gitRepository.decreaseClientUsage();
+ }
/**
* Removes given files/folders from the index and/or from the working tree
diff --git a/libs.git/src/org/netbeans/libs/git/GitRepository.java b/libs.git/src/org/netbeans/libs/git/GitRepository.java
--- a/libs.git/src/org/netbeans/libs/git/GitRepository.java
+++ b/libs.git/src/org/netbeans/libs/git/GitRepository.java
@@ -55,14 +55,20 @@
* still have to provide a local file which indicates where the repository would be created when
* {@link GitClient#init(org.netbeans.libs.git.progress.ProgressMonitor) } was called.
* To get an instance of GitClient to run git commands with, use {@link #createClient() } method. It always returns
- * a new instance of the GitClient, it is not shared among the callers.
+ * a new instance of the GitClient, it is not shared among the callers.
+ *
When done with the client - you finish calling all desired commands and do not
+ * plan to use the client's instance any more - {@link GitClient#release() } must be called.
+ * When all created clients are released this way, repository metadata are flushed,
+ * all open metadata files are closed and thus do not block any external tools
+ * (such as a commandline client).
* Internally the class keeps a map of its instances that are cached under
* a weak reference to the instance of the local file passed in the {@link #getInstance(java.io.File) } method.
* Along with the instance it caches also all repository metadata (branches, index, references etc.)
* needed to construct the client and operate with the actual Git repository.
* Every call to the getInstance method with the same instance of the file
* will always return the same instance of GitRepository. It is up to a caller's
- * responsibility to hold a strong reference to the file so all metadata are kept in memory and not garbage collected.
+ * responsibility to hold a strong reference to the file so a created client always works with
+ * the same instance of the git repository.
*
* @author Ondra Vrabec
*/
@@ -119,7 +125,7 @@
}
}
- private GitClient createClient (JGitRepository repository) {
+ private GitClient createClient (JGitRepository repository) throws GitException {
return new GitClient(repository);
}
diff --git a/libs.git/src/org/netbeans/libs/git/jgit/JGitRepository.java b/libs.git/src/org/netbeans/libs/git/jgit/JGitRepository.java
--- a/libs.git/src/org/netbeans/libs/git/jgit/JGitRepository.java
+++ b/libs.git/src/org/netbeans/libs/git/jgit/JGitRepository.java
@@ -53,11 +53,23 @@
* @author ondra
*/
public final class JGitRepository {
- private final Repository repository;
- private boolean closed;
+ private Repository repository;
+ private final File location;
- public JGitRepository (File location) throws GitException {
- this.repository = getRepository(location);
+ public JGitRepository (File location) {
+ this.location = location;
+ }
+
+ public synchronized void increaseClientUsage () throws GitException {
+ if (repository == null) {
+ repository = getRepository(location);
+ } else {
+ repository.incrementOpen();
+ }
+ }
+
+ public synchronized void decreaseClientUsage () {
+ repository.close();
}
private Repository getRepository (File workDir) throws GitException {
@@ -75,21 +87,7 @@
}
public Repository getRepository () {
+ assert repository != null;
return repository;
}
-
- public synchronized void close () {
- if (repository != null) {
- if (!closed) {
- repository.close();
- closed = true;
- }
- }
- }
-
- @Override
- protected void finalize () throws Throwable {
- close();
- super.finalize();
- }
}
diff --git a/libs.git/test/unit/src/org/netbeans/libs/git/jgit/AbstractGitTestCase.java b/libs.git/test/unit/src/org/netbeans/libs/git/jgit/AbstractGitTestCase.java
--- a/libs.git/test/unit/src/org/netbeans/libs/git/jgit/AbstractGitTestCase.java
+++ b/libs.git/test/unit/src/org/netbeans/libs/git/jgit/AbstractGitTestCase.java
@@ -180,10 +180,12 @@
if (createLocalClone()) {
GitRepository fact = GitRepository.getInstance(wc);
- fact.createClient().init(NULL_PROGRESS_MONITOR);
+ GitClient client = fact.createClient();
+ client.init(NULL_PROGRESS_MONITOR);
Field f = GitRepository.class.getDeclaredField("gitRepository");
f.setAccessible(true);
localRepository = (JGitRepository) f.get(fact);
+ client.release();
}
}
diff --git a/libs.git/test/unit/src/org/netbeans/libs/git/jgit/factory/CreateClientTest.java b/libs.git/test/unit/src/org/netbeans/libs/git/jgit/factory/CreateClientTest.java
--- a/libs.git/test/unit/src/org/netbeans/libs/git/jgit/factory/CreateClientTest.java
+++ b/libs.git/test/unit/src/org/netbeans/libs/git/jgit/factory/CreateClientTest.java
@@ -43,7 +43,9 @@
import java.io.File;
import java.io.IOException;
+import java.lang.reflect.Field;
import java.util.Map;
+import java.util.concurrent.atomic.AtomicInteger;
import org.eclipse.jgit.lib.ConfigConstants;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.lib.StoredConfig;
@@ -126,4 +128,39 @@
assertStatus(statuses, subRepo, newFile, true, GitStatus.Status.STATUS_ADDED, GitStatus.Status.STATUS_NORMAL, GitStatus.Status.STATUS_ADDED, false);
}
+ public void testClientRelease () throws Exception {
+ GitClient client1 = GitRepository.getInstance(workDir).createClient();
+ Repository jgitRepo1 = getRepository(client1);
+ assertRepoClients(jgitRepo1, 1);
+ client1.release();
+ assertRepoClients(jgitRepo1, 0);
+
+ client1 = GitRepository.getInstance(workDir).createClient();
+ assertEquals(jgitRepo1, getRepository(client1));
+ assertRepoClients(jgitRepo1, 1);
+ // some commands
+ client1.getStatus(new File[] { workDir }, NULL_PROGRESS_MONITOR);
+ client1.add(new File[] { workDir }, NULL_PROGRESS_MONITOR);
+
+ GitClient client2 = GitRepository.getInstance(workDir).createClient();
+ assertEquals(jgitRepo1, getRepository(client2));
+ assertRepoClients(jgitRepo1, 2);
+ // some commands
+ client2.getStatus(new File[] { workDir }, NULL_PROGRESS_MONITOR);
+ client2.add(new File[] { workDir }, NULL_PROGRESS_MONITOR);
+
+ assertRepoClients(jgitRepo1, 2);
+ client1.release();
+ assertRepoClients(jgitRepo1, 1);
+ client2.release();
+ assertRepoClients(jgitRepo1, 0);
+ }
+
+ private void assertRepoClients (Repository jgitRepo1, int expectedClients) throws Exception {
+ Field f = Repository.class.getDeclaredField("useCnt");
+ f.setAccessible(true);
+ AtomicInteger cnt = (AtomicInteger) f.get(jgitRepo1);
+ assertEquals(expectedClients, cnt.intValue());
+ }
+
}