@ -61,12 +61,28 @@ import org.eclipse.jgit.revwalk.RevTag;
import org.eclipse.jgit.revwalk.RevWalk ;
/** Support for the start of {@link UploadPack} and {@link ReceivePack}. */
class RefAdvertiser {
private final PacketLineOut pckOut ;
public abstract class RefAdvertiser {
static class PacketLineOutRefAdvertiser extends RefAdvertiser {
private final PacketLineOut pckOut ;
private final RevWalk walk ;
PacketLineOutRefAdvertiser ( PacketLineOut out ) {
pckOut = out ;
}
@Override
protected void writeOne ( final CharSequence line ) throws IOException {
pckOut . writeString ( line . toString ( ) ) ;
}
private final RevFlag ADVERTISED ;
@Override
protected void end ( ) throws IOException {
pckOut . end ( ) ;
}
}
private RevWalk walk ;
private RevFlag ADVERTISED ;
private final StringBuilder tmpLine = new StringBuilder ( 100 ) ;
@ -78,22 +94,72 @@ class RefAdvertiser {
private boolean first = true ;
RefAdvertiser ( final PacketLineOut out , final RevWalk protoWalk ,
final RevFlag advertisedFlag ) {
pckOut = out ;
/ * *
* Initialize a new advertisement formatter .
*
* @param protoWalk
* the RevWalk used to parse objects that are advertised .
* @param advertisedFlag
* flag marked on any advertised objects parsed out of the
* { @code protoWalk } ' s object pool , permitting the caller to
* later quickly determine if an object was advertised ( or not ) .
* /
public void init ( final RevWalk protoWalk , final RevFlag advertisedFlag ) {
walk = protoWalk ;
ADVERTISED = advertisedFlag ;
}
void setDerefTags ( final boolean deref ) {
/ * *
* Toggle tag peeling .
* < p >
* < p >
* This method must be invoked prior to any of the following :
* < ul >
* < li > { @link # send ( Collection ) }
* < li > { @link # advertiseHave ( AnyObjectId ) }
* < li > { @link # includeAdditionalHaves ( ) }
* < / ul >
*
* @param deref
* true to show the dereferenced value of a tag as the special
* ref < code > $tag ^ { } < / code > ; 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 .
* < p >
* This method must be invoked prior to any of the following :
* < ul >
* < li > { @link # send ( Collection ) }
* < li > { @link # advertiseHave ( AnyObjectId ) }
* < li > { @link # includeAdditionalHaves ( ) }
* < / ul >
*
* @param name
* the name of a single protocol capability supported by the
* caller . The set of capabilities are sent to the client in the
* advertisement , allowing the client to later selectively enable
* features it recognizes .
* /
public void advertiseCapability ( String name ) {
capablities . add ( name ) ;
}
void send ( final Collection < Ref > refs ) throws IOException {
/ * *
* Format an advertisement for the supplied refs .
*
* @param refs
* zero or more refs to format for the client . The collection is
* copied and sorted before display and therefore may appear in
* any order .
* @throws IOException
* the underlying output stream failed to write out an
* advertisement record .
* /
public void send ( final Collection < Ref > refs ) throws IOException {
for ( final Ref r : RefComparator . sort ( refs ) ) {
final RevObject obj = parseAnyOrNull ( r . getObjectId ( ) ) ;
if ( obj ! = null ) {
@ -104,7 +170,21 @@ class RefAdvertiser {
}
}
void advertiseHave ( AnyObjectId id ) throws IOException {
/ * *
* Advertise one object is available using the magic { @code . have } .
* < p >
* 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 .
* < p >
* 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 ;
}
Shawn O. Pearce
15 years ago