]> source.dussan.org Git - jgit.git/commitdiff
Remove dependency by ArchiveCommand on archive formats 63/12563/4
authorJonathan Nieder <jrn@google.com>
Fri, 24 May 2013 23:57:10 +0000 (16:57 -0700)
committerJonathan Nieder <jrn@google.com>
Fri, 24 May 2013 23:57:10 +0000 (16:57 -0700)
Provide static registerFormat and unregisterFormat methods to allow
formats to register themselves without the ArchiveCommand code being
aware of them.

Register the basic "zip" and "tar" support at bundle activation time
(and deregister them when unloading the bundle).  For anyone using
this code as an OSGi plugin it should continue to just work.

The jgit program does not load org.eclipse.jgit.pgm as an OSGi bundle,
so let the Archive command register the formats it uses explicitly
with registerFormat.

Change-Id: Id39c03ea6923d0aed8316ed7b6bd04d5ced570a7

org.eclipse.jgit.pgm/META-INF/MANIFEST.MF
org.eclipse.jgit.pgm/pom.xml
org.eclipse.jgit.pgm/resources/org/eclipse/jgit/pgm/internal/CLIText.properties
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/Archive.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/archive/ArchiveCommand.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/archive/FormatActivator.java [new file with mode: 0644]
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/archive/TarFormat.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/archive/ZipFormat.java
org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/internal/CLIText.java
pom.xml

index a6e5e21915c34e4d968d92518ef412b977aade7c..a26e4b4663c258652174a09b3d0e57d10cb1912a 100644 (file)
@@ -34,8 +34,10 @@ Import-Package: org.apache.commons.compress.archivers;version="[1.3,2.0)",
  org.eclipse.jgit.util;version="[3.0.0,3.1.0)",
  org.eclipse.jgit.util.io;version="[3.0.0,3.1.0)",
  org.kohsuke.args4j;version="[2.0.12,2.1.0)",
- org.kohsuke.args4j.spi;version="[2.0.12,2.1.0)"
+ org.kohsuke.args4j.spi;version="[2.0.12,2.1.0)",
+ org.osgi.framework;version="[4.0,5.0)"
 Bundle-ActivationPolicy: lazy
+Bundle-Activator: org.eclipse.jgit.pgm.archive.FormatActivator
 Export-Package: org.eclipse.jgit.pgm;version="3.0.0";
   uses:="org.eclipse.jgit.lib,
    org.eclipse.jgit.nls,
index b51019c181068d025361a3399e7611ddf02785df..fe1c3b2a151e825a64de152165b367031c21e921 100644 (file)
       <artifactId>org.eclipse.jgit.ui</artifactId>
       <version>${project.version}</version>
     </dependency>
+
+    <dependency>
+      <groupId>org.osgi</groupId>
+      <artifactId>org.osgi.core</artifactId>
+    </dependency>
   </dependencies>
 
   <profiles>
index 3fa167e95a8d5eb85cd54e15a3b9cc05b79f3191..4a1548134fa473828aba8aec98bfd098511bf526 100644 (file)
@@ -7,6 +7,8 @@ N=N
 
 alreadyOnBranch=Already on ''{0}''
 alreadyUpToDate=Already up-to-date.
+archiveFormatAlreadyRegistered=Archive format already registered: {0}
+archiveFormatAlreadyAbsent=Archive format already absent: {0}
 authorInfo=Author: {0} <{1}>
 averageMSPerRead=average {0} ms/read
 branchAlreadyExists=A branch named ''{0}'' already exists.
index 6d4f5aa5145466296d5f346f3b9f4b0de7b32924..06f6f40f9cff82a81ebed6b3f60a98ec11ac7e90 100644 (file)
@@ -47,12 +47,19 @@ import org.eclipse.jgit.api.errors.GitAPIException;
 import org.eclipse.jgit.lib.ObjectId;
 import org.eclipse.jgit.pgm.TextBuiltin;
 import org.eclipse.jgit.pgm.archive.ArchiveCommand;
+import org.eclipse.jgit.pgm.archive.TarFormat;
+import org.eclipse.jgit.pgm.archive.ZipFormat;
 import org.eclipse.jgit.pgm.internal.CLIText;
 import org.kohsuke.args4j.Argument;
 import org.kohsuke.args4j.Option;
 
 @Command(common = true, usage = "usage_archive")
 class Archive extends TextBuiltin {
+       static {
+               ArchiveCommand.registerFormat("tar", new TarFormat());
+               ArchiveCommand.registerFormat("zip", new ZipFormat());
+       }
+
        @Argument(index = 0, metaVar = "metaVar_treeish")
        private ObjectId tree;
 
index 437c613a34c1f9d5a4949390aed63f8f6e0e55a3..5e572373fc40605a7fa5bc051b135b9bece22aeb 100644 (file)
@@ -71,24 +71,28 @@ import org.eclipse.jgit.treewalk.TreeWalk;
  * Create a tarball from HEAD:
  *
  * <pre>
+ * ArchiveCommand.registerFormat("tar", new TarFormat());
  * cmd = new ArchiveCommand(git.getRepository());
  * try {
  *     cmd.setTree(db.resolve(&quot;HEAD&quot;))
  *             .setOutputStream(out).call();
  * } finally {
  *     cmd.release();
+ *     ArchiveCommand.unregisterFormat("tar");
  * }
  * </pre>
  * <p>
  * Create a ZIP file from master:
  *
  * <pre>
+ * ArchiveCommand.registerFormat("zip", new ZipFormat());
  * try {
  *     cmd.setTree(db.resolve(&quot;master&quot;))
  *             .setFormat("zip")
  *             .setOutputStream(out).call();
  * } finally {
  *     cmd.release();
+ *     ArchiveCommand.unregisterFormat("zip");
  * }
  * </pre>
  *
@@ -150,9 +154,39 @@ public class ArchiveCommand extends GitCommand<OutputStream> {
        private static final ConcurrentMap<String, Format<?>> formats =
                        new ConcurrentHashMap<String, Format<?>>();
 
-       static {
-               formats.put("zip", new ZipFormat());
-               formats.put("tar", new TarFormat());
+       /**
+        * Adds support for an additional archival format.  To avoid
+        * unnecessary dependencies, ArchiveCommand does not have support
+        * for any formats built in; use this function to add them.
+        *
+        * OSGi plugins providing formats should call this function at
+        * bundle activation time.
+        *
+        * @param name name of a format (e.g., "tar" or "zip").
+        * @param fmt archiver for that format
+        * @throws JGitInternalException
+        *              An archival format with that name was already registered.
+        */
+       public static void registerFormat(String name, Format<?> fmt) {
+               if (formats.putIfAbsent(name, fmt) != null)
+                       throw new JGitInternalException(MessageFormat.format(
+                                       CLIText.get().archiveFormatAlreadyRegistered,
+                                       name));
+       }
+
+       /**
+        * Removes support for an archival format so its Format can be
+        * garbage collected.
+        *
+        * @param name name of format (e.g., "tar" or "zip").
+        * @throws JGitInternalException
+        *              No such archival format was registered.
+        */
+       public static void unregisterFormat(String name) {
+               if (formats.remove(name) == null)
+                       throw new JGitInternalException(MessageFormat.format(
+                                       CLIText.get().archiveFormatAlreadyAbsent,
+                                       name));
        }
 
        private static Format<?> lookupFormat(String formatName) throws UnsupportedFormatException {
diff --git a/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/archive/FormatActivator.java b/org.eclipse.jgit.pgm/src/org/eclipse/jgit/pgm/archive/FormatActivator.java
new file mode 100644 (file)
index 0000000..4889faf
--- /dev/null
@@ -0,0 +1,58 @@
+/*
+ * Copyright (C) 2013 Google Inc.
+ * and other copyright owners as documented in the project's IP log.
+ *
+ * This program and the accompanying materials are made available
+ * under the terms of the Eclipse Distribution License v1.0 which
+ * accompanies this distribution, is reproduced below, and is
+ * available at http://www.eclipse.org/org/documents/edl-v10.php
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or
+ * without modification, are permitted provided that the following
+ * conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above
+ *   copyright notice, this list of conditions and the following
+ *   disclaimer in the documentation and/or other materials provided
+ *   with the distribution.
+ *
+ * - Neither the name of the Eclipse Foundation, Inc. nor the
+ *   names of its contributors may be used to endorse or promote
+ *   products derived from this software without specific prior
+ *   written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+ * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+ * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package org.eclipse.jgit.pgm.archive;
+
+import org.osgi.framework.BundleActivator;
+import org.osgi.framework.BundleContext;
+
+public class FormatActivator implements BundleActivator {
+       public void start(BundleContext context) throws Exception {
+               ArchiveCommand.registerFormat("tar", new TarFormat());
+               ArchiveCommand.registerFormat("zip", new ZipFormat());
+       }
+
+       public void stop(BundleContext context) throws Exception {
+               ArchiveCommand.unregisterFormat("zip");
+               ArchiveCommand.unregisterFormat("tar");
+       }
+}
index 52252593d5a310ce6dc4092476866adbfe9a9039..55f6ca942e80b9b10065b07f7e691674e2e3b5dc 100644 (file)
@@ -52,7 +52,7 @@ import org.apache.commons.compress.archivers.tar.TarConstants;
 import org.eclipse.jgit.lib.FileMode;
 import org.eclipse.jgit.lib.ObjectLoader;
 
-class TarFormat implements ArchiveCommand.Format<ArchiveOutputStream> {
+public class TarFormat implements ArchiveCommand.Format<ArchiveOutputStream> {
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s) {
                return new TarArchiveOutputStream(s);
        }
index d264161c5b217a5b05f3d5332c82f7ba69148c93..a23cc9f38a5a416bab1d9adc4b94edc95001e9e0 100644 (file)
@@ -51,7 +51,7 @@ import org.apache.commons.compress.archivers.zip.ZipArchiveOutputStream;
 import org.eclipse.jgit.lib.FileMode;
 import org.eclipse.jgit.lib.ObjectLoader;
 
-class ZipFormat implements ArchiveCommand.Format<ArchiveOutputStream> {
+public class ZipFormat implements ArchiveCommand.Format<ArchiveOutputStream> {
        public ArchiveOutputStream createArchiveOutputStream(OutputStream s) {
                return new ZipArchiveOutputStream(s);
        }
index 937707bd32dd16474b0269111830a5507489d32c..b5580bf34ff0d1a3bdb15af04aa061b0acd0cc50 100644 (file)
@@ -76,6 +76,8 @@ public class CLIText extends TranslationBundle {
        // @formatter:off
        /***/ public String alreadyOnBranch;
        /***/ public String alreadyUpToDate;
+       /***/ public String archiveFormatAlreadyRegistered;
+       /***/ public String archiveFormatAlreadyAbsent;
        /***/ public String authorInfo;
        /***/ public String averageMSPerRead;
        /***/ public String branchAlreadyExists;
diff --git a/pom.xml b/pom.xml
index ee1e45f40becb9186832b8b8e25c069d3e313a9e..76ba5c006caee47e5224978a699eb680cb2f5e28 100644 (file)
--- a/pom.xml
+++ b/pom.xml
     <!-- TODO: update Maven dependency for args4j to 2.0.21 as soon as available on Maven Central -->
     <args4j-version>2.0.12</args4j-version>
     <commons-compress-version>1.4.1</commons-compress-version>
+    <osgi-core-version>4.3.1</osgi-core-version>
     <servlet-api-version>2.5</servlet-api-version>
     <jetty-version>7.6.0.v20120127</jetty-version>
     <clirr-version>2.4</clirr-version>
         <artifactId>jetty-servlet</artifactId>
         <version>${jetty-version}</version>
       </dependency>
+
+      <dependency>
+        <groupId>org.osgi</groupId>
+        <artifactId>org.osgi.core</artifactId>
+        <version>${osgi-core-version}</version>
+      </dependency>
     </dependencies>
   </dependencyManagement>