+ *
+ * This method must be invoked prior to any of the following: + *
$tag^{} ; false to omit it from the output.
+ */
+ public void setDerefTags(final boolean deref) {
derefTags = deref;
}
- void advertiseCapability(String name) {
+ /**
+ * Add one protocol capability to the initial advertisement.
+ * + * This method must be invoked prior to any of the following: + *
+ * The magic {@code .have} advertisement is not available for fetching by a + * client, but can be used by a client when considering a delta base + * candidate before transferring data in a push. Within the record created + * by this method the ref name is simply the invalid string {@code .have}. + * + * @param id + * identity of the object that is assumed to exist. + * @throws IOException + * the underlying output stream failed to write out an + * advertisement record. + */ + public void advertiseHave(AnyObjectId id) throws IOException { RevObject obj = parseAnyOrNull(id); if (obj != null) { advertiseAnyOnce(obj, ".have"); @@ -113,7 +193,14 @@ class RefAdvertiser { } } - void includeAdditionalHaves() throws IOException { + /** + * Include references of alternate repositories as {@code .have} lines. + * + * @throws IOException + * the underlying output stream failed to write out an + * advertisement record. + */ + public void includeAdditionalHaves() throws IOException { additionalHaves(walk.getRepository().getObjectDatabase()); } @@ -129,7 +216,8 @@ class RefAdvertiser { advertiseHave(r.getObjectId()); } - boolean isEmpty() { + /** @return true if no advertisements have been sent yet. */ + public boolean isEmpty() { return first; } @@ -172,7 +260,22 @@ class RefAdvertiser { advertiseAny(tag.getObject(), refName); } - void advertiseId(final AnyObjectId id, final String refName) + /** + * Advertise one object under a specific name. + *
+ * If the advertised object is a tag, this method does not advertise the + * peeled version of it. + * + * @param id + * the object to advertise. + * @param refName + * name of the reference to advertise the object as, can be any + * string not including the NUL byte. + * @throws IOException + * the underlying output stream failed to write out an + * advertisement record. + */ + public void advertiseId(final AnyObjectId id, final String refName) throws IOException { tmpLine.setLength(0); id.copyTo(tmpId, tmpLine); @@ -190,6 +293,27 @@ class RefAdvertiser { } } tmpLine.append('\n'); - pckOut.writeString(tmpLine.toString()); + writeOne(tmpLine); } + + /** + * Write a single advertisement line. + * + * @param line + * the advertisement line to be written. The line always ends + * with LF. Never null or the empty string. + * @throws IOException + * the underlying output stream failed to write out an + * advertisement record. + */ + protected abstract void writeOne(CharSequence line) throws IOException; + + /** + * Mark the end of the advertisements. + * + * @throws IOException + * the underlying output stream failed to write out an + * advertisement record. + */ + protected abstract void end() throws IOException; } diff --git a/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java b/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java index fe2afbe9b..6b81bc492 100644 --- a/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java +++ b/org.eclipse.jgit/src/org/eclipse/jgit/transport/UploadPack.java @@ -70,6 +70,7 @@ import org.eclipse.jgit.revwalk.RevFlagSet; import org.eclipse.jgit.revwalk.RevObject; import org.eclipse.jgit.revwalk.RevTag; import org.eclipse.jgit.revwalk.RevWalk; +import org.eclipse.jgit.transport.RefAdvertiser.PacketLineOutRefAdvertiser; import org.eclipse.jgit.util.io.InterruptTimer; import org.eclipse.jgit.util.io.TimeoutInputStream; import org.eclipse.jgit.util.io.TimeoutOutputStream; @@ -282,7 +283,7 @@ public class UploadPack { private void service() throws IOException { if (biDirectionalPipe) - sendAdvertisedRefs(); + sendAdvertisedRefs(new PacketLineOutRefAdvertiser(pckOut)); else { refs = db.getAllRefs(); for (Ref r : refs.values()) { @@ -309,8 +310,16 @@ public class UploadPack { sendPack(); } - private void sendAdvertisedRefs() throws IOException { - final RefAdvertiser adv = new RefAdvertiser(pckOut, walk, ADVERTISED); + /** + * Generate an advertisement of available refs and capabilities. + * + * @param adv + * the advertisement formatter. + * @throws IOException + * the formatter failed to write an advertisement. + */ + public void sendAdvertisedRefs(final RefAdvertiser adv) throws IOException { + adv.init(walk, ADVERTISED); adv.advertiseCapability(OPTION_INCLUDE_TAG); adv.advertiseCapability(OPTION_MULTI_ACK_DETAILED); adv.advertiseCapability(OPTION_MULTI_ACK); @@ -322,7 +331,7 @@ public class UploadPack { adv.setDerefTags(true); refs = db.getAllRefs(); adv.send(refs.values()); - pckOut.end(); + adv.end(); } private void recvWants() throws IOException {