Transport to access a local directory as though it were a remote peer.

This transport is suitable for use on the local system, where the caller has direct read or write access to the "remote" repository.

By default this transport works by spawning a helper thread within the same JVM, and processes the data transfer using a shared memory buffer between the calling thread and the helper thread. This is a pure-Java implementation which does not require forking an external process.

However, during openFetch(), if the Transport has configured Transport#getOptionUploadPack() to be anything other than "git-upload-pack" or "git upload-pack", this implementation will fork and execute the external process, using an operating system pipe to transfer data.

Similarly, during openPush(), if the Transport has configured Transport#getOptionReceivePack() to be anything other than "git-receive-pack" or "git receive-pack", this implementation will fork and execute the external process, using an operating system pipe to transfer data.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	TransportLocal.ForkLocalFetchConnection
pack-priv class	TransportLocal.ForkLocalPushConnection

Field Summary

Modifier and Type	Field and Description
pack-priv static final TransportProtocol	PROTO_LOCAL
private final File	remoteGitDir

Inherited from org.eclipse.jgit.transport.Transport:: DEFAULT_FETCH_THIN DEFAULT_PUSH_THIN DEFAULT_PUSH_USE_BITMAPS local protocol REFSPEC_PUSH_ALL REFSPEC_TAGS uri

Constructor Summary

Access	Constructor and Description
pack-priv	TransportLocal(Repository local, URIish uri, File gitDir)
pack-priv	TransportLocal(URIish uri, File gitDir)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements abstract org.eclipse.jgit.transport.Transport.close. Implements java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
pack-priv ReceivePack	createReceivePack(Repository dst)
pack-priv UploadPack	createUploadPack(Repository dst)
public FetchConnection	openFetch() Implements abstract org.eclipse.jgit.transport.Transport.openFetch. Begins a new connection for fetching from the remote repository.
public FetchConnection	openFetch(Collection<RefSpec> that will be fetched via `FetchConnection#fetch(ProgressMonitor, Collection, java.util.Set, OutputStream)` later refSpecs, String... that will be set as ref prefixes if the server supports git protocol V2; `null` values are ignored additionalPatterns) Overrides org.eclipse.jgit.transport.Transport.openFetch. Begins a new connection for fetching from the remote repository.
public PushConnection	openPush() Implements abstract org.eclipse.jgit.transport.Transport.openPush. Begins a new connection for pushing into the remote repository.
private Repository	openRepo()
protected Process	Returns: a `java.lang.Process` object. spawn(String command cmd) Spawn process
private Process	Returns: a `java.lang.Process` object. spawn(String command cmd, TransferConfig.ProtocolVersion to use protocolVersion) Spawn process

Inherited from org.eclipse.jgit.transport.Transport:: applyConfig fetch fetch findRemoteRefUpdatesFor findRemoteRefUpdatesFor findRemoteRefUpdatesFor findRemoteRefUpdatesFor findTrackingRefName getCredentialsProvider getDeepenNots getDeepenSince getDepth getFilterSpec getObjectChecker getOptionReceivePack getOptionUploadPack getPackConfig getPushOptions getTagOpt getTimeout getTransportProtocols getURI isCheckFetchedObjects isDryRun isFetchThin isPushAtomic isPushThin isPushUseBitmaps isRemoveDeletedRefs open open open open open open open openAll openAll openAll openAll push push register setCheckFetchedObjects setCredentialsProvider setDeepenNots setDeepenSince setDepth setDepth setDryRun setFetchThin setFilterSpec setHookErrorStream setHookOutputStream setObjectChecker setOptionReceivePack setOptionUploadPack setPackConfig setPushAtomic setPushOptions setPushThin setPushUseBitmaps setRemoveDeletedRefs setTagOpt setTimeout unregister

Field Detail

PROTO_LOCAL	back to summary
pack-priv static final TransportProtocol PROTO_LOCAL

remoteGitDir	back to summary
private final File remoteGitDir

Constructor Detail

TransportLocal	back to summary
pack-priv TransportLocal(Repository local, URIish uri, File gitDir)

TransportLocal	back to summary
pack-priv TransportLocal(URIish uri, File gitDir)

Method Detail

close back to summary

close	back to summary
public void close() Implements abstract org.eclipse.jgit.transport.Transport.close. Implements java.lang.AutoCloseable.close. Doc from org.eclipse.jgit.transport.Transport.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 transport. 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. `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.Transport.close.

Implements java.lang.AutoCloseable.close.

Doc from org.eclipse.jgit.transport.Transport.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 transport.

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.

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

createReceivePack	back to summary
pack-priv ReceivePack createReceivePack(Repository dst)

createUploadPack	back to summary
pack-priv UploadPack createUploadPack(Repository dst)

openFetch	back to summary
public FetchConnection openFetch() throws TransportException Implements abstract org.eclipse.jgit.transport.Transport.openFetch. Doc from org.eclipse.jgit.transport.Transport.openFetch. Begins a new connection for fetching from the remote repository. If the transport has no local repository, the fetch connection can only be used for reading remote refs. Returns:FetchConnection a fresh connection to fetch from the remote repository. Annotations @Override Exceptions TransportException: the remote connection could not be established.

openFetch

back to summary

public FetchConnection openFetch() throws TransportException

Implements abstract org.eclipse.jgit.transport.Transport.openFetch.

Doc from org.eclipse.jgit.transport.Transport.openFetch.

Begins a new connection for fetching from the remote repository.

If the transport has no local repository, the fetch connection can only be used for reading remote refs.

Returns:FetchConnection

a fresh connection to fetch from the remote repository.

Annotations

@Override

Exceptions

TransportException:: the remote connection could not be established.

openFetch back to summary

openFetch	back to summary
public FetchConnection openFetch(Collection<RefSpec> refSpecs, String... additionalPatterns) throws TransportException Overrides org.eclipse.jgit.transport.Transport.openFetch. Doc from org.eclipse.jgit.transport.Transport.openFetch. Begins a new connection for fetching from the remote repository. If the transport has no local repository, the fetch connection can only be used for reading remote refs. If the server supports git protocol V2, the `RefSpec`s and the additional patterns, if any, are used to restrict the server's ref advertisement to matching refs only. Transports that want to support git protocol V2 must override this; the default implementation ignores its arguments and calls `openFetch()`. Parameters refSpecs:Collection<RefSpec> that will be fetched via `FetchConnection#fetch(ProgressMonitor, Collection, java.util.Set, OutputStream)` later additionalPatterns:String[] that will be set as ref prefixes if the server supports git protocol V2; `null` values are ignored Returns:FetchConnection a fresh connection to fetch from the remote repository. Annotations @Override Exceptions TransportException: the remote connection could not be established.

public FetchConnection openFetch(Collection<RefSpec> refSpecs, String... additionalPatterns) throws TransportException

Overrides org.eclipse.jgit.transport.Transport.openFetch.

Doc from org.eclipse.jgit.transport.Transport.openFetch.

Begins a new connection for fetching from the remote repository.

If the transport has no local repository, the fetch connection can only be used for reading remote refs.

If the server supports git protocol V2, the RefSpecs and the additional patterns, if any, are used to restrict the server's ref advertisement to matching refs only.

Transports that want to support git protocol V2 must override this; the default implementation ignores its arguments and calls openFetch().

Parameters

refSpecs:Collection<RefSpec>: that will be fetched via FetchConnection#fetch(ProgressMonitor, Collection, java.util.Set, OutputStream) later
additionalPatterns:String[]: that will be set as ref prefixes if the server supports git protocol V2; null values are ignored

Returns:FetchConnection

a fresh connection to fetch from the remote repository.

Annotations

@Override

Exceptions

TransportException:: the remote connection could not be established.

openPush	back to summary
public PushConnection openPush() throws TransportException Implements abstract org.eclipse.jgit.transport.Transport.openPush. Doc from org.eclipse.jgit.transport.Transport.openPush. Begins a new connection for pushing into the remote repository. Returns:PushConnection a fresh connection to push into the remote repository. Annotations @Override Exceptions TransportException: the remote connection could not be established

openPush

back to summary

public PushConnection openPush() throws TransportException

Implements abstract org.eclipse.jgit.transport.Transport.openPush.

Doc from org.eclipse.jgit.transport.Transport.openPush.

Begins a new connection for pushing into the remote repository.

Returns:PushConnection

a fresh connection to push into the remote repository.

Annotations

@Override

Exceptions

TransportException:: the remote connection could not be established

openRepo	back to summary
private Repository openRepo() throws TransportException

spawn back to summary

spawn	back to summary
protected Process spawn(String cmd) throws TransportException Spawn process Parameters cmd:String command Returns:Process a `java.lang.Process` object. Exceptions TransportException: if any.

protected Process spawn(String cmd) throws TransportException

Spawn process

Parameters

cmd:String: command

Returns:Process

a java.lang.Process object.

Exceptions

TransportException:: if any.

spawn back to summary

spawn	back to summary
private Process spawn(String cmd, TransferConfig.ProtocolVersion protocolVersion) throws TransportException Spawn process Parameters cmd:String command protocolVersion:TransferConfig.ProtocolVersion to use Returns:Process a `java.lang.Process` object. Exceptions TransportException: if any.

private Process spawn(String cmd, TransferConfig.ProtocolVersion protocolVersion) throws TransportException

Spawn process

Parameters

cmd:String: command
protocolVersion:TransferConfig.ProtocolVersion: to use

Returns:Process

a java.lang.Process object.

Exceptions

TransportException:: if any.

org.eclipse.jgit.transport back to summary

pack-priv Class TransportLocal.ForkLocalFetchConnection

Class Inheritance

extends BasePackFetchConnection

java.lang.Object
org.eclipse.jgit.transport.BaseConnection
org.eclipse.jgit.transport.BasePackConnection
org.eclipse.jgit.transport.BasePackFetchConnection
org.eclipse.jgit.transport.TransportLocal.ForkLocalFetchConnection

Field Summary

Modifier and Type	Field and Description
private Thread	errorReaderThread
private Process	uploadPack

Inherited from org.eclipse.jgit.transport.BasePackFetchConnection:: ADVERTISED COMMON MIN_CLIENT_BUFFER OPTION_ALLOW_REACHABLE_SHA1_IN_WANT OPTION_ALLOW_TIP_SHA1_IN_WANT OPTION_FILTER OPTION_INCLUDE_TAG OPTION_MULTI_ACK OPTION_MULTI_ACK_DETAILED OPTION_NO_DONE OPTION_NO_PROGRESS OPTION_OFS_DELTA OPTION_SHALLOW OPTION_SIDE_BAND OPTION_SIDE_BAND_64K OPTION_THIN_PACK REACHABLE

Constructor Summary

Access	Constructor and Description
pack-priv	ForkLocalFetchConnection()
pack-priv	ForkLocalFetchConnection(Collection<RefSpec> refSpecs, String... additionalPatterns)

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides org.eclipse.jgit.transport.BasePackFetchConnection.close. Implements org.eclipse.jgit.transport.Connection.close. Closes this resource, relinquishing any underlying resources.

Inherited from org.eclipse.jgit.transport.BasePackFetchConnection:: didFetchIncludeTags didFetchTestConnectivity doFetch fetch fetch getFetchConfig getPackLocks onReceivePack setPackLockMessage

Field Detail

errorReaderThread	back to summary
private Thread errorReaderThread

uploadPack	back to summary
private Process uploadPack

Constructor Detail

ForkLocalFetchConnection	back to summary
pack-priv ForkLocalFetchConnection() throws TransportException

ForkLocalFetchConnection	back to summary
pack-priv ForkLocalFetchConnection(Collection<RefSpec> refSpecs, String... additionalPatterns) throws TransportException

Method Detail

close back to summary

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

org.eclipse.jgit.transport back to summary

pack-priv Class TransportLocal.ForkLocalPushConnection

Class Inheritance

extends BasePackPushConnection

java.lang.Object
org.eclipse.jgit.transport.BaseConnection
org.eclipse.jgit.transport.BasePackConnection
org.eclipse.jgit.transport.BasePackPushConnection
org.eclipse.jgit.transport.TransportLocal.ForkLocalPushConnection

Field Summary

Modifier and Type	Field and Description
private Thread	errorReaderThread
private Process	receivePack

Inherited from org.eclipse.jgit.transport.BasePackPushConnection:: CAPABILITY_DELETE_REFS CAPABILITY_OFS_DELTA CAPABILITY_PUSH_OPTIONS CAPABILITY_REPORT_STATUS CAPABILITY_SIDE_BAND_64K

Constructor Summary

Access	Constructor and Description
pack-priv	ForkLocalPushConnection()

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides org.eclipse.jgit.transport.BasePackConnection.close. Implements org.eclipse.jgit.transport.Connection.close. Closes this resource, relinquishing any underlying resources.

Inherited from org.eclipse.jgit.transport.BasePackPushConnection:: doPush getPushOptions isUseBitmaps noRepository push push

Field Detail

errorReaderThread	back to summary
private Thread errorReaderThread

receivePack	back to summary
private Process receivePack

Constructor Detail

ForkLocalPushConnection	back to summary
pack-priv ForkLocalPushConnection() throws TransportException

Method Detail

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 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