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

Modifier and Type	Class and Description
private class	WalkFetchConnection.RemotePack

Field Summary

Modifier and Type	Field and Description
private final RevFlag	COMPLETE Objects whose direct dependents we know we have (or will have).
private final HashMap<ObjectId, List<Throwable>>	fetchErrors Errors received while trying to obtain an object.
private final MutableObjectId	idBuffer
private final RevFlag	IN_WORK_QUEUE Objects that have already entered `workQueue`.
pack-priv final ObjectInserter	inserter Inserter to write objects onto `local`.
private int	lastRemoteIdx Most recently used item in `remotes`.
pack-priv final Repository	local The repository this transport fetches into, or pushes out of.
private final DateRevQueue	localCommitQueue Commits already reachable from all local refs.
private final RevFlag	LOCALLY_SEEN Commits that have already entered `localCommitQueue`.
pack-priv String	lockMessage
private final Deque<WalkRemoteObjectDatabase>	noAlternatesYet Databases we have not yet obtained the alternates from.
private final Deque<WalkRemoteObjectDatabase>	noPacksYet Databases we have not yet obtained the list of packs from.
pack-priv final ObjectChecker	objCheck If not null the validator for received objects.
pack-priv final List<PackLock>	packLocks
private final Set<String>	packsConsidered Packs whose indexes we have looked at in `unfetchedPacks`.
private final ObjectReader	reader Inserter to read objects from `local`.
private final List<WalkRemoteObjectDatabase>	remotes List of all remote repositories we may need to get objects out of.
private final RevWalk	revWalk
private final TreeWalk	treeWalk
private final Map<String, WalkFetchConnection.RemotePack>	unfetchedPacks Packs we have discovered, but have not yet fetched locally.
private Deque<ObjectId>	workQueue Objects we need to copy from the remote repository.

Access	Constructor and Description
pack-priv	WalkFetchConnection(WalkTransport t, WalkRemoteObjectDatabase w)

Method Summary

Modifier and Type	Method and Description
private boolean	alreadyHave(AnyObjectId id)
public void	close() Implements abstract org.eclipse.jgit.transport.BaseConnection.close. Implements org.eclipse.jgit.transport.Connection.close. Closes this resource, relinquishing any underlying resources.
public boolean	didFetchTestConnectivity() Implements org.eclipse.jgit.transport.FetchConnection.didFetchTestConnectivity. Did the last `fetch(ProgressMonitor, Collection, Set)` validate graph?
protected void	doFetch(final ProgressMonitor as in `fetch(ProgressMonitor, Collection, Set)` monitor, final Collection<Ref> as in `fetch(ProgressMonitor, Collection, Set)` want, final Set<ObjectId> as in `fetch(ProgressMonitor, Collection, Set)` have) Implements abstract org.eclipse.jgit.transport.BaseFetchConnection.doFetch. Implementation of `fetch(ProgressMonitor, Collection, Set)` without checking for multiple fetch.
private boolean	downloadLooseObject(final AnyObjectId id, final String looseName, final WalkRemoteObjectDatabase remote)
private void	downloadObject(ProgressMonitor pm, AnyObjectId id)
private boolean	downloadPackedObject(ProgressMonitor monitor, AnyObjectId id)
private boolean	downloadPackedObject(final ProgressMonitor monitor, final AnyObjectId id, Set<String> brokenPacks)
private Collection<WalkRemoteObjectDatabase>	expandOneAlternate(final AnyObjectId id, final ProgressMonitor pm)
public Collection<PackLock>	getPackLocks() Implements org.eclipse.jgit.transport.FetchConnection.getPackLocks. All locks created by the last `fetch(ProgressMonitor, Collection, Set)` call.
private void	markLocalCommitsComplete(int until)
private void	markLocalObjComplete(RevObject obj)
private void	markLocalRefsComplete(Set<ObjectId> have)
private void	markTreeComplete(RevTree tree)
private void	needs(RevObject obj)
private void	process(ObjectId id)
private void	processBlob(RevObject obj)
private void	processCommit(RevObject obj)
private void	processTag(RevObject obj)
private void	processTree(RevObject obj)
private void	pushLocalCommit(RevCommit p)
private void	queueWants(Collection<Ref> want)
private void	recordError(AnyObjectId id, Throwable what)
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 Deque<ObjectId>	swapFetchQueue()
private void	verifyAndInsertLooseObject(final AnyObjectId id, final byte[] compressed)

Inherited from org.eclipse.jgit.transport.BaseFetchConnection:: didFetchIncludeTags fetch fetch

Field Detail

COMPLETE	back to summary
private final RevFlag COMPLETE Objects whose direct dependents we know we have (or will have).

fetchErrors	back to summary
private final HashMap<ObjectId, List<Throwable>> fetchErrors Errors received while trying to obtain an object. If the fetch winds up failing because we cannot locate a specific object then we need to report all errors related to that object back to the caller as there may be cascading failures.

fetchErrors

back to summary

private final HashMap<ObjectId, List<Throwable>> fetchErrors

Errors received while trying to obtain an object.

If the fetch winds up failing because we cannot locate a specific object then we need to report all errors related to that object back to the caller as there may be cascading failures.

idBuffer	back to summary
private final MutableObjectId idBuffer

IN_WORK_QUEUE	back to summary
private final RevFlag IN_WORK_QUEUE Objects that have already entered `workQueue`.

inserter	back to summary
pack-priv final ObjectInserter inserter Inserter to write objects onto `local`.

lastRemoteIdx	back to summary
private int lastRemoteIdx Most recently used item in `remotes`.

local	back to summary
pack-priv final Repository local The repository this transport fetches into, or pushes out of.

localCommitQueue	back to summary
private final DateRevQueue localCommitQueue Commits already reachable from all local refs.

LOCALLY_SEEN	back to summary
private final RevFlag LOCALLY_SEEN Commits that have already entered `localCommitQueue`.

lockMessage	back to summary
pack-priv String lockMessage

noAlternatesYet	back to summary
private final Deque<WalkRemoteObjectDatabase> noAlternatesYet Databases we have not yet obtained the alternates from.

noPacksYet	back to summary
private final Deque<WalkRemoteObjectDatabase> noPacksYet Databases we have not yet obtained the list of packs from.

objCheck	back to summary
pack-priv final ObjectChecker objCheck If not null the validator for received objects.

packLocks	back to summary
pack-priv final List<PackLock> packLocks

packsConsidered back to summary

packsConsidered	back to summary
private final Set<String> packsConsidered Packs whose indexes we have looked at in `unfetchedPacks`. We try to avoid getting duplicate copies of the same pack through multiple alternates by only looking at packs whose names are not yet in this collection.

private final Set<String> packsConsidered

Packs whose indexes we have looked at in unfetchedPacks.

We try to avoid getting duplicate copies of the same pack through multiple alternates by only looking at packs whose names are not yet in this collection.

reader	back to summary
private final ObjectReader reader Inserter to read objects from `local`.

remotes	back to summary
private final List<WalkRemoteObjectDatabase> remotes List of all remote repositories we may need to get objects out of. The first repository in the list is the one we were asked to fetch from; the remaining repositories point to the alternate locations we can fetch objects through.

remotes

back to summary

private final List<WalkRemoteObjectDatabase> remotes

List of all remote repositories we may need to get objects out of.

The first repository in the list is the one we were asked to fetch from; the remaining repositories point to the alternate locations we can fetch objects through.

revWalk	back to summary
private final RevWalk revWalk

treeWalk	back to summary
private final TreeWalk treeWalk

unfetchedPacks	back to summary
private final Map<String, WalkFetchConnection.RemotePack> unfetchedPacks Packs we have discovered, but have not yet fetched locally.

workQueue	back to summary
private Deque<ObjectId> workQueue Objects we need to copy from the remote repository.

Constructor Detail

WalkFetchConnection	back to summary
pack-priv WalkFetchConnection(WalkTransport t, WalkRemoteObjectDatabase w)

Method Detail

alreadyHave	back to summary
private boolean alreadyHave(AnyObjectId id) throws TransportException

close back to summary

close	back to summary
public void close() Implements abstract org.eclipse.jgit.transport.BaseConnection.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()

Implements abstract org.eclipse.jgit.transport.BaseConnection.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

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) throws TransportException Implements abstract org.eclipse.jgit.transport.BaseFetchConnection.doFetch. Doc from org.eclipse.jgit.transport.BaseFetchConnection.doFetch. Implementation of `fetch(ProgressMonitor, Collection, Set)` without checking for multiple fetch. Parameters monitor:ProgressMonitor as in `fetch(ProgressMonitor, Collection, Set)` want:Collection<Ref> as in `fetch(ProgressMonitor, Collection, Set)` have:Set<ObjectId> as in `fetch(ProgressMonitor, Collection, Set)` Annotations @Override Exceptions TransportException: as in `fetch(ProgressMonitor, Collection, Set)`, but implementation doesn't have to care about multiple `fetch(ProgressMonitor, Collection, Set)` calls, as it is checked in this class.

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

Implements abstract org.eclipse.jgit.transport.BaseFetchConnection.doFetch.

Doc from org.eclipse.jgit.transport.BaseFetchConnection.doFetch.

Implementation of fetch(ProgressMonitor, Collection, Set) without checking for multiple fetch.

Parameters

monitor:ProgressMonitor: as in fetch(ProgressMonitor, Collection, Set)
want:Collection<Ref>: as in fetch(ProgressMonitor, Collection, Set)
have:Set<ObjectId>: as in fetch(ProgressMonitor, Collection, Set)

Annotations

@Override

Exceptions

TransportException:: as in fetch(ProgressMonitor, Collection, Set), but implementation doesn't have to care about multiple fetch(ProgressMonitor, Collection, Set) calls, as it is checked in this class.

downloadLooseObject	back to summary
private boolean downloadLooseObject(final AnyObjectId id, final String looseName, final WalkRemoteObjectDatabase remote) throws TransportException

downloadObject	back to summary
private void downloadObject(ProgressMonitor pm, AnyObjectId id) throws TransportException

downloadPackedObject	back to summary
private boolean downloadPackedObject(ProgressMonitor monitor, AnyObjectId id) throws TransportException

downloadPackedObject	back to summary
private boolean downloadPackedObject(final ProgressMonitor monitor, final AnyObjectId id, Set<String> brokenPacks) throws TransportException Annotations @SuppressWarnings:Finally

expandOneAlternate	back to summary
private Collection<WalkRemoteObjectDatabase> expandOneAlternate(final AnyObjectId id, final ProgressMonitor pm)

getPackLocks back to summary

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

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

markLocalCommitsComplete	back to summary
private void markLocalCommitsComplete(int until) throws TransportException

markLocalObjComplete	back to summary
private void markLocalObjComplete(RevObject obj) throws IOException

markLocalRefsComplete	back to summary
private void markLocalRefsComplete(Set<ObjectId> have) throws TransportException

markTreeComplete	back to summary
private void markTreeComplete(RevTree tree) throws IOException

needs	back to summary
private void needs(RevObject obj)

process	back to summary
private void process(ObjectId id) throws TransportException

processBlob	back to summary
private void processBlob(RevObject obj) throws TransportException

processCommit	back to summary
private void processCommit(RevObject obj) throws TransportException

processTag	back to summary
private void processTag(RevObject obj)

processTree	back to summary
private void processTree(RevObject obj) throws TransportException

pushLocalCommit	back to summary
private void pushLocalCommit(RevCommit p) throws MissingObjectException, IOException

queueWants	back to summary
private void queueWants(Collection<Ref> want) throws TransportException

recordError	back to summary
private void recordError(AnyObjectId id, Throwable what)

setPackLockMessage back to summary

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

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

swapFetchQueue	back to summary
private Deque<ObjectId> swapFetchQueue()

verifyAndInsertLooseObject	back to summary
private void verifyAndInsertLooseObject(final AnyObjectId id, final byte[] compressed) throws IOException

Modifier and Type	Field and Description
pack-priv final WalkRemoteObjectDatabase	connection
pack-priv final String	idxName
pack-priv PackIndex	index
pack-priv final String	packName
pack-priv File	tmpIdx

Modifier and Type	Method and Description
pack-priv void	downloadPack(ProgressMonitor monitor)
pack-priv void	openIndex(ProgressMonitor pm)

pack-priv Class WalkFetchConnection

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class WalkFetchConnection.RemotePack

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail