JGit 7.2.0.202503040940-r · org.eclipse.jgit.transport.BasePackFetchConnection

Modifier and Type	Class and Description
private static class	BasePackFetchConnection.CancelledException
pack-priv static class	BasePackFetchConnection.FetchConfig
private static class	BasePackFetchConnection.FetchStateV2

Field Summary

Modifier and Type	Field and Description
pack-priv final RevFlag	ADVERTISED Marks a commit listed in the advertised refs.
private boolean	allowOfsDelta
pack-priv final RevFlag	COMMON Marks a commit known to both sides of the connection.
private List<String>	deepenNots
private Instant	deepenSince
private Integer	depth
private final FilterSpec	filterSpec Either FilterSpec.NO_FILTER for a filter that doesn't filter anything, or a filter that indicates what and what not to send to the server.
private boolean	includeTags
private String	lockMessage
private static final int	MAX_HAVES Maximum number of 'have' lines to send before giving up.
private int	maxHaves
protected static final int	MIN_CLIENT_BUFFER Amount of data the client sends before starting to read.
private GitProtocolConstants.MultiAck	multiAck
private boolean	noDone
private boolean	noProgress
public static final String	OPTION_ALLOW_REACHABLE_SHA1_IN_WANT The client supports fetching objects that are reachable from a tip of a ref that is allowed to fetch.
public static final String	OPTION_ALLOW_TIP_SHA1_IN_WANT The client supports fetching objects at the tip of any ref, even if not advertised.
public static final String	OPTION_FILTER The client specified a filter expression.
public static final String	OPTION_INCLUDE_TAG Include tags if we are also including the referenced objects.
public static final String	OPTION_MULTI_ACK Multi-ACK support for improved negotiation.
public static final String	OPTION_MULTI_ACK_DETAILED Multi-ACK detailed support for improved negotiation.
public static final String	OPTION_NO_DONE The client supports receiving a pack before it has sent "done".
public static final String	OPTION_NO_PROGRESS The client does not want progress messages and will ignore them.
public static final String	OPTION_OFS_DELTA The client supports packs with OFS deltas.
public static final String	OPTION_SHALLOW The client supports shallow fetches.
public static final String	OPTION_SIDE_BAND The client supports using the side-band for progress messages.
public static final String	OPTION_SIDE_BAND_64K The client supports using the 64K side-band for progress messages.
public static final String	OPTION_THIN_PACK The client supports packs with deltas but not their bases.
private PackLock	packLock
private PacketLineOut	pckState
pack-priv final RevFlag	REACHABLE Marks an object as having all its dependencies.
private RevCommitList<RevCommit>	reachableCommits All commits that are immediately reachable by a local ref.
private boolean	sideband
private final RevFlag	STATE Like `COMMON` but means its also in `pckState`.
private TemporaryBuffer.Heap	state RPC state, if `BasePackConnection#statelessRPC` is true or protocol V2 is used.
private boolean	thinPack
private boolean	useNegotiationTip
private final RevWalk	walk

Inherited from org.eclipse.jgit.transport.BasePackConnection:: additionalHaves CAPABILITY_SYMREF_PREFIX in local out outNeedsEnd pckIn pckOut statelessRPC timeoutIn timeoutOut transport uri

Constructor Summary

Access	Constructor and Description
public	BasePackFetchConnection(PackTransport the transport. packTransport) Create a new connection to fetch using the native git transport.

Method Summary

Modifier and Type	Method and Description
private void	clearState()
public void	close() Overrides org.eclipse.jgit.transport.BasePackConnection.close. Implements org.eclipse.jgit.transport.Connection.close. Closes this resource, relinquishing any underlying resources.
public boolean	didFetchIncludeTags() Implements org.eclipse.jgit.transport.FetchConnection.didFetchIncludeTags. Did the last `fetch(ProgressMonitor, Collection, Set)` get tags?
public boolean	didFetchTestConnectivity() Implements org.eclipse.jgit.transport.FetchConnection.didFetchTestConnectivity. Did the last `fetch(ProgressMonitor, Collection, Set)` validate graph?
protected void	doFetch(final ProgressMonitor progress monitor to receive status updates. If the monitor is the `org.eclipse.jgit.lib.NullProgressMonitor#INSTANCE`, then the no-progress option enabled. monitor, final Collection<Ref> the advertised remote references the caller wants to fetch. want, final Set<ObjectId> additional objects to assume that already exist locally. This will be added to the set of objects reachable from the destination repository's references. have, OutputStream ouputStream to write sideband messages to outputStream) Execute common ancestor negotiation and fetch the objects.
private void	doFetchV2(ProgressMonitor monitor, Collection<Ref> want, OutputStream outputStream, boolean hasObjects)
private String	enableCapabilities()
public final void	fetch(final ProgressMonitor progress monitor to inform the end-user about the amount of work completed, or to indicate cancellation. Implementations should poll the monitor at regular intervals to look for cancellation requests from the user. monitor, final Collection<Ref> one or more refs advertised by this connection that the caller wants to store locally. want, final Set<ObjectId> additional objects known to exist in the destination repository, especially if they aren't yet reachable by the ref database. Connections should take this set as an addition to what is reachable through all Refs, not in replace of it. have) Implements org.eclipse.jgit.transport.FetchConnection.fetch. Fetch objects we don't have but that are reachable from advertised refs.
public final void	fetch(final ProgressMonitor progress monitor to inform the end-user about the amount of work completed, or to indicate cancellation. Implementations should poll the monitor at regular intervals to look for cancellation requests from the user. monitor, final Collection<Ref> one or more refs advertised by this connection that the caller wants to store locally. want, final Set<ObjectId> additional objects known to exist in the destination repository, especially if they aren't yet reachable by the ref database. Connections should take this set as an addition to what is reachable through all Refs, not in replace of it. have, OutputStream OutputStream to write sideband messages to outputStream) Implements org.eclipse.jgit.transport.FetchConnection.fetch. Fetch objects we don't have but that are reachable from advertised refs.
private Set<String>	getCapabilitiesV2(Set<String> advertisedCapabilities)
pack-priv BasePackFetchConnection.FetchConfig	getFetchConfig()
public Collection<PackLock>	getPackLocks() Implements org.eclipse.jgit.transport.FetchConnection.getPackLocks. All locks created by the last `fetch(ProgressMonitor, Collection, Set)` call.
private static ObjectId	getRefObjectId(Ref ref)
private String	handleShallowUnshallow(Set<ObjectId> advertisedShallowCommits, PacketLineIn input)
private void	markAdvertised(AnyObjectId id)
private void	markCommon(RevObject obj, PacketLineIn.AckNackResult anr, boolean useState)
private void	markReachable(Collection<Ref> want, Set<ObjectId> have, int maxTime)
private void	markReachable(ObjectId id)
private void	markReachableRefTips(Collection<Ref> references that client is requesting to be marked. refsToMark) Marks commits reachable.
private void	markRefsAdvertised()
private int	maxTimeWanted(Collection<Ref> wants, boolean hasObjects)
private void	negotiate(ProgressMonitor monitor, boolean mayHaveShallow, Set<ObjectId> shallowCommits)
private void	negotiateBegin()
protected void	onReceivePack() Notification event delivered just before the pack is received from the network.
private boolean	Returns: `true` if a "ready" was received and a packfile is expected next readAcknowledgments(BasePackFetchConnection.FetchStateV2 to update fetchState, PacketLineIn to read from input, ProgressMonitor for progress reporting and cancellation monitor) Reads and processes acknowledgments, adding ACKed objects as "have"s to the global state `TemporaryBuffer`.
private void	receivePack(final ProgressMonitor monitor, OutputStream outputStream)
private boolean	Returns: `true` if a "done" was written and we should thus expect a packfile next sendNextHaveBatch(BasePackFetchConnection.FetchStateV2 is updated with information about the number of items written, and whether to expect a packfile next fetchState, PacketLineOut to write to output, ProgressMonitor for progress reporting and cancellation monitor) Sends the next batch of "have"s and terminates the `output`.
private void	sendShallow(Set<ObjectId> shallowCommits, PacketLineOut output)
private boolean	sendWants(Collection<Ref> want, PacketLineOut p, boolean hasObjects)
public void	setPackLockMessage(String message to use when holding a pack in place. message) Implements org.eclipse.jgit.transport.FetchConnection.setPackLockMessage. Set the lock message used when holding a pack out of garbage collection.
private Collection<Ref>	translateToLocalTips(Collection<Ref> want)

Inherited from org.eclipse.jgit.transport.BasePackConnection:: addUserAgentCapability endOut getCapability getPeerUserAgent getProtocolVersion init isCapableOf lsRefs noRepository readAdvertisedRefs setProtocolVersion updateWithSymRefs wantCapability

Field Detail

ADVERTISED	back to summary
pack-priv final RevFlag ADVERTISED Marks a commit listed in the advertised refs.

allowOfsDelta	back to summary
private boolean allowOfsDelta

COMMON	back to summary
pack-priv final RevFlag COMMON Marks a commit known to both sides of the connection.

deepenNots	back to summary
private List<String> deepenNots

deepenSince	back to summary
private Instant deepenSince

depth	back to summary
private Integer depth

filterSpec	back to summary
private final FilterSpec filterSpec Either FilterSpec.NO_FILTER for a filter that doesn't filter anything, or a filter that indicates what and what not to send to the server.

includeTags	back to summary
private boolean includeTags

lockMessage	back to summary
private String lockMessage

MAX_HAVES back to summary

MAX_HAVES	back to summary
private static final int MAX_HAVES Maximum number of 'have' lines to send before giving up. During `negotiate(ProgressMonitor, boolean, Set)` we send at most this many commits to the remote peer as 'have' lines without an ACK response before we give up.

private static final int MAX_HAVES

Maximum number of 'have' lines to send before giving up.

During negotiate(ProgressMonitor, boolean, Set) we send at most this many commits to the remote peer as 'have' lines without an ACK response before we give up.

maxHaves	back to summary
private int maxHaves

MIN_CLIENT_BUFFER	back to summary
protected static final int MIN_CLIENT_BUFFER Amount of data the client sends before starting to read. Any output stream given to the client must be able to buffer this many bytes before the client will stop writing and start reading from the input stream. If the output stream blocks before this many bytes are in the send queue, the system will deadlock.

MIN_CLIENT_BUFFER

back to summary

protected static final int MIN_CLIENT_BUFFER

Amount of data the client sends before starting to read.

Any output stream given to the client must be able to buffer this many bytes before the client will stop writing and start reading from the input stream. If the output stream blocks before this many bytes are in the send queue, the system will deadlock.

multiAck	back to summary
private GitProtocolConstants.MultiAck multiAck

noDone	back to summary
private boolean noDone

noProgress	back to summary
private boolean noProgress

OPTION_ALLOW_REACHABLE_SHA1_IN_WANT	back to summary
public static final String OPTION_ALLOW_REACHABLE_SHA1_IN_WANT The client supports fetching objects that are reachable from a tip of a ref that is allowed to fetch. Since 4.1

OPTION_ALLOW_REACHABLE_SHA1_IN_WANT

back to summary

public static final String OPTION_ALLOW_REACHABLE_SHA1_IN_WANT

The client supports fetching objects that are reachable from a tip of a ref that is allowed to fetch.

Since: 4.1

OPTION_ALLOW_TIP_SHA1_IN_WANT	back to summary
public static final String OPTION_ALLOW_TIP_SHA1_IN_WANT The client supports fetching objects at the tip of any ref, even if not advertised. Since 3.1

OPTION_ALLOW_TIP_SHA1_IN_WANT

back to summary

public static final String OPTION_ALLOW_TIP_SHA1_IN_WANT

The client supports fetching objects at the tip of any ref, even if not advertised.

Since: 3.1

OPTION_FILTER	back to summary
public static final String OPTION_FILTER The client specified a filter expression. Since 5.0

OPTION_FILTER

back to summary

public static final String OPTION_FILTER

The client specified a filter expression.

Since: 5.0

OPTION_INCLUDE_TAG	back to summary
public static final String OPTION_INCLUDE_TAG Include tags if we are also including the referenced objects. Since 2.0

OPTION_INCLUDE_TAG

back to summary

public static final String OPTION_INCLUDE_TAG

Include tags if we are also including the referenced objects.

Since: 2.0

OPTION_MULTI_ACK	back to summary
public static final String OPTION_MULTI_ACK Multi-ACK support for improved negotiation. Since 2.0

OPTION_MULTI_ACK

back to summary

public static final String OPTION_MULTI_ACK

Multi-ACK support for improved negotiation.

Since: 2.0

OPTION_MULTI_ACK_DETAILED	back to summary
public static final String OPTION_MULTI_ACK_DETAILED Multi-ACK detailed support for improved negotiation. Since 2.0

OPTION_MULTI_ACK_DETAILED

back to summary

public static final String OPTION_MULTI_ACK_DETAILED

Multi-ACK detailed support for improved negotiation.

Since: 2.0

OPTION_NO_DONE	back to summary
public static final String OPTION_NO_DONE The client supports receiving a pack before it has sent "done". Since 2.0

OPTION_NO_DONE

back to summary

public static final String OPTION_NO_DONE

The client supports receiving a pack before it has sent "done".

Since: 2.0

OPTION_NO_PROGRESS	back to summary
public static final String OPTION_NO_PROGRESS The client does not want progress messages and will ignore them. Since 2.0

OPTION_NO_PROGRESS

back to summary

public static final String OPTION_NO_PROGRESS

The client does not want progress messages and will ignore them.

Since: 2.0

OPTION_OFS_DELTA	back to summary
public static final String OPTION_OFS_DELTA The client supports packs with OFS deltas. Since 2.0

OPTION_OFS_DELTA

back to summary

public static final String OPTION_OFS_DELTA

The client supports packs with OFS deltas.

Since: 2.0

OPTION_SHALLOW	back to summary
public static final String OPTION_SHALLOW The client supports shallow fetches. Since 2.0

OPTION_SHALLOW

back to summary

public static final String OPTION_SHALLOW

The client supports shallow fetches.

Since: 2.0

OPTION_SIDE_BAND	back to summary
public static final String OPTION_SIDE_BAND The client supports using the side-band for progress messages. Since 2.0

OPTION_SIDE_BAND

back to summary

public static final String OPTION_SIDE_BAND

The client supports using the side-band for progress messages.

Since: 2.0

OPTION_SIDE_BAND_64K	back to summary
public static final String OPTION_SIDE_BAND_64K The client supports using the 64K side-band for progress messages. Since 2.0

OPTION_SIDE_BAND_64K

back to summary

public static final String OPTION_SIDE_BAND_64K

The client supports using the 64K side-band for progress messages.

Since: 2.0

OPTION_THIN_PACK	back to summary
public static final String OPTION_THIN_PACK The client supports packs with deltas but not their bases. Since 2.0

OPTION_THIN_PACK

back to summary

public static final String OPTION_THIN_PACK

The client supports packs with deltas but not their bases.

Since: 2.0

packLock	back to summary
private PackLock packLock

pckState	back to summary
private PacketLineOut pckState

REACHABLE	back to summary
pack-priv final RevFlag REACHABLE Marks an object as having all its dependencies.

reachableCommits	back to summary
private RevCommitList<RevCommit> reachableCommits All commits that are immediately reachable by a local ref.

sideband	back to summary
private boolean sideband

STATE	back to summary
private final RevFlag STATE Like `COMMON` but means its also in `pckState`.

state	back to summary
private TemporaryBuffer.Heap state RPC state, if `BasePackConnection#statelessRPC` is true or protocol V2 is used.

thinPack	back to summary
private boolean thinPack

useNegotiationTip	back to summary
private boolean useNegotiationTip

walk	back to summary
private final RevWalk walk

Constructor Detail

BasePackFetchConnection	back to summary
public BasePackFetchConnection(PackTransport packTransport) Create a new connection to fetch using the native git transport. Parameters packTransport:PackTransport the transport.

BasePackFetchConnection

back to summary

public BasePackFetchConnection(PackTransport packTransport)

Create a new connection to fetch using the native git transport.

Parameters

packTransport:PackTransport: the transport.

Method Detail

clearState	back to summary
private void clearState()

close back to summary

close	back to summary
public void close() Overrides org.eclipse.jgit.transport.BasePackConnection.close. Implements org.eclipse.jgit.transport.Connection.close. Doc from org.eclipse.jgit.transport.Connection.close. Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the `try`-with-resources statement. Close any resources used by this connection. If the remote repository is contacted by a network socket this method must close that network socket, disconnecting the two peers. If the remote repository is actually local (same system) this method must close any open file handles used to read the "remote" repository. If additional messages were produced by the remote peer, these should still be retained in the connection instance for `getMessages()`. `AutoClosable.close()` declares that it throws `Exception`. Implementers shouldn't throw checked exceptions. This override narrows the signature to prevent them from doing so. Annotations @Override

public void close()

Overrides org.eclipse.jgit.transport.BasePackConnection.close.

Implements org.eclipse.jgit.transport.Connection.close.

Doc from org.eclipse.jgit.transport.Connection.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Close any resources used by this connection.

If the remote repository is contacted by a network socket this method must close that network socket, disconnecting the two peers. If the remote repository is actually local (same system) this method must close any open file handles used to read the "remote" repository.

If additional messages were produced by the remote peer, these should still be retained in the connection instance for getMessages().

AutoClosable.close() declares that it throws Exception. Implementers shouldn't throw checked exceptions. This override narrows the signature to prevent them from doing so.

Annotations

@Override

didFetchIncludeTags back to summary

didFetchIncludeTags	back to summary
public boolean didFetchIncludeTags() Implements org.eclipse.jgit.transport.FetchConnection.didFetchIncludeTags. Doc from org.eclipse.jgit.transport.FetchConnection.didFetchIncludeTags. Did the last `fetch(ProgressMonitor, Collection, Set)` get tags? Some Git aware transports are able to implicitly grab an annotated tag if `org.eclipse.jgit.transport.TagOpt#AUTO_FOLLOW` or `org.eclipse.jgit.transport.TagOpt#FETCH_TAGS` was selected and the object the tag peels to (references) was transferred as part of the last `fetch(ProgressMonitor, Collection, Set)` call. If it is possible for such tags to have been included in the transfer this method returns true, allowing the caller to attempt tag discovery. By returning only true/false (and not the actual list of tags obtained) the transport itself does not need to be aware of whether or not tags were included in the transfer. Returns:boolean true if the last fetch call implicitly included tag objects; false if tags were not implicitly obtained. Annotations @Override

public boolean didFetchIncludeTags()

Implements org.eclipse.jgit.transport.FetchConnection.didFetchIncludeTags.

Doc from org.eclipse.jgit.transport.FetchConnection.didFetchIncludeTags.

Did the last fetch(ProgressMonitor, Collection, Set) get tags?

Some Git aware transports are able to implicitly grab an annotated tag if org.eclipse.jgit.transport.TagOpt#AUTO_FOLLOW or org.eclipse.jgit.transport.TagOpt#FETCH_TAGS was selected and the object the tag peels to (references) was transferred as part of the last fetch(ProgressMonitor, Collection, Set) call. If it is possible for such tags to have been included in the transfer this method returns true, allowing the caller to attempt tag discovery.

By returning only true/false (and not the actual list of tags obtained) the transport itself does not need to be aware of whether or not tags were included in the transfer.

Returns:boolean

true if the last fetch call implicitly included tag objects; false if tags were not implicitly obtained.

Annotations

@Override

didFetchTestConnectivity back to summary

didFetchTestConnectivity	back to summary
public boolean didFetchTestConnectivity() Implements org.eclipse.jgit.transport.FetchConnection.didFetchTestConnectivity. Doc from org.eclipse.jgit.transport.FetchConnection.didFetchTestConnectivity. Did the last `fetch(ProgressMonitor, Collection, Set)` validate graph? Some transports walk the object graph on the client side, with the client looking for what objects it is missing and requesting them individually from the remote peer. By virtue of completing the fetch call the client implicitly tested the object connectivity, as every object in the graph was either already local or was requested successfully from the peer. In such transports this method returns true. Some transports assume the remote peer knows the Git object graph and is able to supply a fully connected graph to the client (although it may only be transferring the parts the client does not yet have). Its faster to assume such remote peers are well behaved and send the correct response to the client. In such transports this method returns false. Returns:boolean true if the last fetch had to perform a connectivity check on the client side in order to succeed; false if the last fetch assumed the remote peer supplied a complete graph. Annotations @Override

public boolean didFetchTestConnectivity()

Implements org.eclipse.jgit.transport.FetchConnection.didFetchTestConnectivity.

Doc from org.eclipse.jgit.transport.FetchConnection.didFetchTestConnectivity.

Did the last fetch(ProgressMonitor, Collection, Set) validate graph?

Some transports walk the object graph on the client side, with the client looking for what objects it is missing and requesting them individually from the remote peer. By virtue of completing the fetch call the client implicitly tested the object connectivity, as every object in the graph was either already local or was requested successfully from the peer. In such transports this method returns true.

Some transports assume the remote peer knows the Git object graph and is able to supply a fully connected graph to the client (although it may only be transferring the parts the client does not yet have). Its faster to assume such remote peers are well behaved and send the correct response to the client. In such transports this method returns false.

Returns:boolean

true if the last fetch had to perform a connectivity check on the client side in order to succeed; false if the last fetch assumed the remote peer supplied a complete graph.

Annotations

@Override

doFetch back to summary

doFetch	back to summary
protected void doFetch(final ProgressMonitor monitor, final Collection<Ref> want, final Set<ObjectId> have, OutputStream outputStream) throws TransportException Execute common ancestor negotiation and fetch the objects. Parameters monitor:ProgressMonitor progress monitor to receive status updates. If the monitor is the `org.eclipse.jgit.lib.NullProgressMonitor#INSTANCE`, then the no-progress option enabled. want:Collection<Ref> the advertised remote references the caller wants to fetch. have:Set<ObjectId> additional objects to assume that already exist locally. This will be added to the set of objects reachable from the destination repository's references. outputStream:OutputStream ouputStream to write sideband messages to Exceptions TransportException: if any exception occurs. Since 3.0

protected void doFetch(final ProgressMonitor monitor, final Collection<Ref> want, final Set<ObjectId> have, OutputStream outputStream) throws TransportException

Execute common ancestor negotiation and fetch the objects.

Parameters

monitor:ProgressMonitor: progress monitor to receive status updates. If the monitor is the org.eclipse.jgit.lib.NullProgressMonitor#INSTANCE, then the no-progress option enabled.
want:Collection<Ref>: the advertised remote references the caller wants to fetch.
have:Set<ObjectId>: additional objects to assume that already exist locally. This will be added to the set of objects reachable from the destination repository's references.
outputStream:OutputStream: ouputStream to write sideband messages to

Exceptions

TransportException:: if any exception occurs.

Since

3.0

doFetchV2	back to summary
private void doFetchV2(ProgressMonitor monitor, Collection<Ref> want, OutputStream outputStream, boolean hasObjects) throws IOException, CancelledException

enableCapabilities	back to summary
private String enableCapabilities() throws TransportException

fetch back to summary

public final void fetch(final ProgressMonitor monitor, final Collection<Ref> want, final Set<ObjectId> have) throws TransportException

Implements org.eclipse.jgit.transport.FetchConnection.fetch.

Doc from org.eclipse.jgit.transport.FetchConnection.fetch.

Fetch objects we don't have but that are reachable from advertised refs.

Only one call per connection is allowed. Subsequent calls will result in org.eclipse.jgit.errors.TransportException.

Implementations are free to use network connections as necessary to efficiently (for both client and server) transfer objects from the remote repository into this repository. When possible implementations should avoid replacing/overwriting/duplicating an object already available in the local destination repository. Locally available objects and packs should always be preferred over remotely available objects and packs. org.eclipse.jgit.transport.Transport#isFetchThin() should be honored if applicable.

Parameters

monitor:ProgressMonitor: progress monitor to inform the end-user about the amount of work completed, or to indicate cancellation. Implementations should poll the monitor at regular intervals to look for cancellation requests from the user.
want:Collection<Ref>: one or more refs advertised by this connection that the caller wants to store locally.
have:Set<ObjectId>: additional objects known to exist in the destination repository, especially if they aren't yet reachable by the ref database. Connections should take this set as an addition to what is reachable through all Refs, not in replace of it.

Annotations

@Override

Exceptions

TransportException:: objects could not be copied due to a network failure, protocol error, or error on remote side, or connection was already used for fetch.

fetch back to summary

public final void fetch(final ProgressMonitor monitor, final Collection<Ref> want, final Set<ObjectId> have, OutputStream outputStream) throws TransportException

Implements org.eclipse.jgit.transport.FetchConnection.fetch.

Doc from org.eclipse.jgit.transport.FetchConnection.fetch.

Fetch objects we don't have but that are reachable from advertised refs.

Only one call per connection is allowed. Subsequent calls will result in org.eclipse.jgit.errors.TransportException.

Parameters

monitor:ProgressMonitor: progress monitor to inform the end-user about the amount of work completed, or to indicate cancellation. Implementations should poll the monitor at regular intervals to look for cancellation requests from the user.
want:Collection<Ref>: one or more refs advertised by this connection that the caller wants to store locally.
have:Set<ObjectId>: additional objects known to exist in the destination repository, especially if they aren't yet reachable by the ref database. Connections should take this set as an addition to what is reachable through all Refs, not in replace of it.
outputStream:OutputStream: OutputStream to write sideband messages to

Annotations

@Override

Exceptions

TransportException:: objects could not be copied due to a network failure, protocol error, or error on remote side, or connection was already used for fetch.

getCapabilitiesV2	back to summary
private Set<String> getCapabilitiesV2(Set<String> advertisedCapabilities) throws TransportException

getFetchConfig	back to summary
pack-priv BasePackFetchConnection.FetchConfig getFetchConfig()

getPackLocks back to summary

public Collection<PackLock> getPackLocks()

Implements org.eclipse.jgit.transport.FetchConnection.getPackLocks.

Doc from org.eclipse.jgit.transport.FetchConnection.getPackLocks.

All locks created by the last fetch(ProgressMonitor, Collection, Set) call.

Returns:Collection<PackLock>

collection (possibly empty) of locks created by the last call to fetch. The caller must release these after refs are updated in order to safely permit garbage collection.

Annotations

@Override

getRefObjectId	back to summary
private static ObjectId getRefObjectId(Ref ref)

handleShallowUnshallow	back to summary
private String handleShallowUnshallow(Set<ObjectId> advertisedShallowCommits, PacketLineIn input) throws IOException

markAdvertised	back to summary
private void markAdvertised(AnyObjectId id)

markCommon	back to summary
private void markCommon(RevObject obj, PacketLineIn.AckNackResult anr, boolean useState) throws IOException

markReachable	back to summary
private void markReachable(Collection<Ref> want, Set<ObjectId> have, int maxTime) throws IOException

markReachable	back to summary
private void markReachable(ObjectId id)

markReachableRefTips

back to summary

private void markReachableRefTips(Collection<Ref> refsToMark)

Marks commits reachable.

Parameters

refsToMark:Collection<Ref>: references that client is requesting to be marked.

markRefsAdvertised	back to summary
private void markRefsAdvertised()

maxTimeWanted	back to summary
private int maxTimeWanted(Collection<Ref> wants, boolean hasObjects)

negotiate	back to summary
private void negotiate(ProgressMonitor monitor, boolean mayHaveShallow, Set<ObjectId> shallowCommits) throws IOException, CancelledException

negotiateBegin	back to summary
private void negotiateBegin() throws IOException

onReceivePack back to summary

protected void onReceivePack()

Notification event delivered just before the pack is received from the network. This event can be used by RPC such as org.eclipse.jgit.transport.TransportHttp to disable its request magic and ensure the pack stream is read correctly.

Since: 2.0

readAcknowledgments back to summary

private boolean readAcknowledgments(BasePackFetchConnection.FetchStateV2 fetchState, PacketLineIn input, ProgressMonitor monitor) throws IOException, CancelledException

Reads and processes acknowledgments, adding ACKed objects as "have"s to the global state TemporaryBuffer.

Parameters

fetchState:BasePackFetchConnection.FetchStateV2: to update
input:PacketLineIn: to read from
monitor:ProgressMonitor: for progress reporting and cancellation

Returns:boolean

true if a "ready" was received and a packfile is expected next

Exceptions

IOException:: on errors
CancelledException:: on cancellation

receivePack	back to summary
private void receivePack(final ProgressMonitor monitor, OutputStream outputStream) throws IOException

sendNextHaveBatch back to summary

private boolean sendNextHaveBatch(BasePackFetchConnection.FetchStateV2 fetchState, PacketLineOut output, ProgressMonitor monitor) throws IOException, CancelledException

Sends the next batch of "have"s and terminates the output.

Parameters

fetchState:BasePackFetchConnection.FetchStateV2: is updated with information about the number of items written, and whether to expect a packfile next
output:PacketLineOut: to write to
monitor:ProgressMonitor: for progress reporting and cancellation

Returns:boolean

true if a "done" was written and we should thus expect a packfile next

Exceptions

IOException:: on errors
CancelledException:: on cancellation

sendShallow	back to summary
private void sendShallow(Set<ObjectId> shallowCommits, PacketLineOut output) throws IOException

sendWants	back to summary
private boolean sendWants(Collection<Ref> want, PacketLineOut p, boolean hasObjects) throws IOException

setPackLockMessage back to summary

public void setPackLockMessage(String message)

Implements org.eclipse.jgit.transport.FetchConnection.setPackLockMessage.

Doc from org.eclipse.jgit.transport.FetchConnection.setPackLockMessage.

Set the lock message used when holding a pack out of garbage collection.

Callers that set a lock message must ensure they call getPackLocks() after fetch(ProgressMonitor, Collection, Set), even if an exception was thrown, and release the locks that are held.

Parameters

message:String: message to use when holding a pack in place.

Annotations

@Override

translateToLocalTips	back to summary
private Collection<Ref> translateToLocalTips(Collection<Ref> want) throws IOException

Modifier and Type	Field and Description
pack-priv boolean	hadAcks
pack-priv long	havesToSend
pack-priv long	havesTotal
pack-priv long	havesWithoutAck

public abstract Class BasePackFetchConnection

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BasePackFetchConnection.CancelledException

Field Summary

Constructor Summary

Field Detail

Constructor Detail

pack-priv Class BasePackFetchConnection.FetchConfig

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class BasePackFetchConnection.FetchStateV2

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Modifier and Type	Field and Description
pack-priv final boolean	allowOfsDelta
pack-priv final int	maxHaves
pack-priv final boolean	useNegotiationTip

Access	Constructor and Description
pack-priv	FetchConfig(Config c)
pack-priv	FetchConfig(boolean allowOfsDelta, int maxHaves)
pack-priv	FetchConfig(boolean when true optimizes the pack size by deltafying base object allowOfsDelta, int max haves to be sent per negotiation maxHaves, boolean if true uses the wanted refs instead of all refs as source of the "have" list to send. useNegotiationTip)