public abstract class Transport extends Object
A transport can be used for either fetching (copying objects into the caller's repository from the remote repository) or pushing (copying objects into the remote repository from the caller's repository). Each transport implementation is responsible for the details associated with establishing the network connection(s) necessary for the copy, as well as actually shuffling data back and forth.
Transport instances and the connections they create are not thread-safe. Callers must ensure a transport is accessed by only one thread at a time.
Modifier and Type | Class and Description |
---|---|
static class |
Transport.Operation
Type of operation a Transport is being opened for.
|
Modifier and Type | Field and Description |
---|---|
static boolean |
DEFAULT_FETCH_THIN
Default setting for
fetchThin option. |
static boolean |
DEFAULT_PUSH_THIN
Default setting for
pushThin option. |
protected Repository |
local
The repository this transport fetches into, or pushes out of.
|
static RefSpec |
REFSPEC_PUSH_ALL
Specification for push operation, to push all refs under refs/heads.
|
static RefSpec |
REFSPEC_TAGS
Specification for fetch or push operations, to fetch or push all tags.
|
protected URIish |
uri
The URI used to create this transport.
|
Modifier | Constructor and Description |
---|---|
protected |
Transport(Repository local,
URIish uri)
Create a new transport instance.
|
protected |
Transport(URIish uri)
Create a minimal transport instance not tied to a single repository.
|
Modifier and Type | Method and Description |
---|---|
void |
applyConfig(RemoteConfig cfg)
Apply provided remote configuration on this transport.
|
abstract void |
close()
Close any resources used by this transport.
|
FetchResult |
fetch(ProgressMonitor monitor,
Collection<RefSpec> toFetch)
Fetch objects and refs from the remote repository to the local one.
|
Collection<RemoteRefUpdate> |
findRemoteRefUpdatesFor(Collection<RefSpec> specs)
Convert push remote refs update specification from
RefSpec form
to RemoteRefUpdate . |
static Collection<RemoteRefUpdate> |
findRemoteRefUpdatesFor(Repository db,
Collection<RefSpec> specs,
Collection<RefSpec> fetchSpecs)
Convert push remote refs update specification from
RefSpec form
to RemoteRefUpdate . |
CredentialsProvider |
getCredentialsProvider()
The configured credentials provider.
|
String |
getOptionReceivePack()
Default setting is:
RemoteConfig.DEFAULT_RECEIVE_PACK |
String |
getOptionUploadPack()
Get the name of the remote executable providing upload-pack service.
|
PackConfig |
getPackConfig()
Get the configuration used by the pack generator to make packs.
|
TagOpt |
getTagOpt()
Get the description of how annotated tags should be treated during fetch.
|
int |
getTimeout() |
static List<TransportProtocol> |
getTransportProtocols()
Obtain a copy of the registered protocols.
|
URIish |
getURI()
Get the URI this transport connects to.
|
boolean |
isCheckFetchedObjects() |
boolean |
isDryRun() |
boolean |
isFetchThin()
Default setting is:
DEFAULT_FETCH_THIN |
boolean |
isPushThin()
Default setting is: false
|
boolean |
isRemoveDeletedRefs() |
static Transport |
open(Repository local,
RemoteConfig cfg)
Open a new transport instance to connect two repositories.
|
static Transport |
open(Repository local,
RemoteConfig cfg,
Transport.Operation op)
Open a new transport instance to connect two repositories.
|
static Transport |
open(Repository local,
String remote)
Open a new transport instance to connect two repositories.
|
static Transport |
open(Repository local,
String remote,
Transport.Operation op)
Open a new transport instance to connect two repositories.
|
static Transport |
open(Repository local,
URIish uri)
Open a new transport instance to connect two repositories.
|
static Transport |
open(Repository local,
URIish uri,
String remoteName)
Open a new transport instance to connect two repositories.
|
static Transport |
open(URIish uri)
Open a new transport with no local repository.
|
static List<Transport> |
openAll(Repository local,
RemoteConfig cfg)
Open new transport instances to connect two repositories.
|
static List<Transport> |
openAll(Repository local,
RemoteConfig cfg,
Transport.Operation op)
Open new transport instances to connect two repositories.
|
static List<Transport> |
openAll(Repository local,
String remote)
Open new transport instances to connect two repositories.
|
static List<Transport> |
openAll(Repository local,
String remote,
Transport.Operation op)
Open new transport instances to connect two repositories.
|
abstract FetchConnection |
openFetch()
Begins a new connection for fetching from the remote repository.
|
abstract PushConnection |
openPush()
Begins a new connection for pushing into the remote repository.
|
PushResult |
push(ProgressMonitor monitor,
Collection<RemoteRefUpdate> toPush)
Push objects and refs from the local repository to the remote one.
|
PushResult |
push(ProgressMonitor monitor,
Collection<RemoteRefUpdate> toPush,
OutputStream out)
Push objects and refs from the local repository to the remote one.
|
static void |
register(TransportProtocol proto)
Register a TransportProtocol instance for use during open.
|
void |
setCheckFetchedObjects(boolean check) |
void |
setCredentialsProvider(CredentialsProvider credentialsProvider)
A credentials provider to assist with authentication connections..
|
void |
setDryRun(boolean dryRun)
Set dry run option for push operation.
|
void |
setFetchThin(boolean fetchThin)
Set the thin-pack preference for fetch operation.
|
void |
setOptionReceivePack(String optionReceivePack)
Set remote executable providing receive-pack service for pack transports.
|
void |
setOptionUploadPack(String where)
Set the name of the remote executable providing upload-pack services.
|
void |
setPackConfig(PackConfig pc)
Set the configuration used by the pack generator.
|
void |
setPushThin(boolean pushThin)
Set thin-pack preference for push operation.
|
void |
setRemoveDeletedRefs(boolean remove)
Set whether or not to remove refs which no longer exist in the source.
|
void |
setTagOpt(TagOpt option)
Set the description of how annotated tags should be treated on fetch.
|
void |
setTimeout(int seconds)
Set the timeout before willing to abort an IO call.
|
static void |
unregister(TransportProtocol proto)
Unregister a TransportProtocol instance.
|
public static final boolean DEFAULT_FETCH_THIN
fetchThin
option.public static final boolean DEFAULT_PUSH_THIN
pushThin
option.public static final RefSpec REFSPEC_TAGS
public static final RefSpec REFSPEC_PUSH_ALL
protected final Repository local
protected final URIish uri
protected Transport(Repository local, URIish uri)
local
- the repository this instance will fetch into, or push out of.
This must be the repository passed to
open(Repository, URIish)
.uri
- the URI used to access the remote repository. This must be the
URI passed to open(Repository, URIish)
.protected Transport(URIish uri)
uri
- public static void register(TransportProtocol proto)
Protocol definitions are held by WeakReference, allowing them to be
garbage collected when the calling application drops all strongly held
references to the TransportProtocol. Therefore applications should use a
singleton pattern as described in TransportProtocol
's class
documentation to ensure their protocol does not get disabled by garbage
collection earlier than expected.
The new protocol is registered in front of all earlier protocols, giving it higher priority than the built-in protocol definitions.
proto
- the protocol definition. Must not be null.public static void unregister(TransportProtocol proto)
Unregistering a protocol usually isn't necessary, as protocols are held
by weak references and will automatically clear when they are garbage
collected by the JVM. Matching is handled by reference equality, so the
exact reference given to register(TransportProtocol)
must be
used.
proto
- the exact object previously given to register.public static List<TransportProtocol> getTransportProtocols()
public static Transport open(Repository local, String remote) throws NotSupportedException, URISyntaxException, TransportException
This method assumes Transport.Operation.FETCH
.
local
- existing local repository.remote
- location of the remote repository - may be URI or remote
configuration name.URISyntaxException
- the location is not a remote defined in the configuration
file and is not a well-formed URL.NotSupportedException
- the protocol specified is not supported.TransportException
- the transport cannot open this URI.public static Transport open(Repository local, String remote, Transport.Operation op) throws NotSupportedException, URISyntaxException, TransportException
local
- existing local repository.remote
- location of the remote repository - may be URI or remote
configuration name.op
- planned use of the returned Transport; the URI may differ
based on the type of connection desired.URISyntaxException
- the location is not a remote defined in the configuration
file and is not a well-formed URL.NotSupportedException
- the protocol specified is not supported.TransportException
- the transport cannot open this URI.public static List<Transport> openAll(Repository local, String remote) throws NotSupportedException, URISyntaxException, TransportException
This method assumes Transport.Operation.FETCH
.
local
- existing local repository.remote
- location of the remote repository - may be URI or remote
configuration name.URISyntaxException
- the location is not a remote defined in the configuration
file and is not a well-formed URL.NotSupportedException
- the protocol specified is not supported.TransportException
- the transport cannot open this URI.public static List<Transport> openAll(Repository local, String remote, Transport.Operation op) throws NotSupportedException, URISyntaxException, TransportException
local
- existing local repository.remote
- location of the remote repository - may be URI or remote
configuration name.op
- planned use of the returned Transport; the URI may differ
based on the type of connection desired.URISyntaxException
- the location is not a remote defined in the configuration
file and is not a well-formed URL.NotSupportedException
- the protocol specified is not supported.TransportException
- the transport cannot open this URI.public static Transport open(Repository local, RemoteConfig cfg) throws NotSupportedException, TransportException
This method assumes Transport.Operation.FETCH
.
local
- existing local repository.cfg
- configuration describing how to connect to the remote
repository.NotSupportedException
- the protocol specified is not supported.TransportException
- the transport cannot open this URI.IllegalArgumentException
- if provided remote configuration doesn't have any URI
associated.public static Transport open(Repository local, RemoteConfig cfg, Transport.Operation op) throws NotSupportedException, TransportException
local
- existing local repository.cfg
- configuration describing how to connect to the remote
repository.op
- planned use of the returned Transport; the URI may differ
based on the type of connection desired.NotSupportedException
- the protocol specified is not supported.TransportException
- the transport cannot open this URI.IllegalArgumentException
- if provided remote configuration doesn't have any URI
associated.public static List<Transport> openAll(Repository local, RemoteConfig cfg) throws NotSupportedException, TransportException
This method assumes Transport.Operation.FETCH
.
local
- existing local repository.cfg
- configuration describing how to connect to the remote
repository.NotSupportedException
- the protocol specified is not supported.TransportException
- the transport cannot open this URI.public static List<Transport> openAll(Repository local, RemoteConfig cfg, Transport.Operation op) throws NotSupportedException, TransportException
local
- existing local repository.cfg
- configuration describing how to connect to the remote
repository.op
- planned use of the returned Transport; the URI may differ
based on the type of connection desired.NotSupportedException
- the protocol specified is not supported.TransportException
- the transport cannot open this URI.public static Transport open(Repository local, URIish uri) throws NotSupportedException, TransportException
local
- existing local repository.uri
- location of the remote repository.NotSupportedException
- the protocol specified is not supported.TransportException
- the transport cannot open this URI.public static Transport open(Repository local, URIish uri, String remoteName) throws NotSupportedException, TransportException
local
- existing local repository.uri
- location of the remote repository.remoteName
- name of the remote, if the remote as configured in
local
; otherwise null.NotSupportedException
- the protocol specified is not supported.TransportException
- the transport cannot open this URI.public static Transport open(URIish uri) throws NotSupportedException, TransportException
Note that the resulting transport instance can not be used for fetching or pushing, but only for reading remote refs.
uri
- NotSupportedException
TransportException
public static Collection<RemoteRefUpdate> findRemoteRefUpdatesFor(Repository db, Collection<RefSpec> specs, Collection<RefSpec> fetchSpecs) throws IOException
RefSpec
form
to RemoteRefUpdate
. Conversion expands wildcards by matching
source part to local refs. expectedOldObjectId in RemoteRefUpdate is
always set as null. Tracking branch is configured if RefSpec destination
matches source of any fetch ref spec for this transport remote
configuration.db
- local database.specs
- collection of RefSpec to convert.fetchSpecs
- fetch specifications used for finding localtracking refs. May
be null or empty collection.RemoteRefUpdate
.IOException
- when problem occurred during conversion or specification set
up: most probably, missing objects or refs.public URIish getURI()
Each transport instance connects to at most one URI at any point in time.
public String getOptionUploadPack()
public void setOptionUploadPack(String where)
where
- name of the executable.public TagOpt getTagOpt()
public void setTagOpt(TagOpt option)
option
- method to use when handling annotated tags.public boolean isFetchThin()
DEFAULT_FETCH_THIN
PackTransport
public void setFetchThin(boolean fetchThin)
DEFAULT_FETCH_THIN
fetchThin
- true when fetch should request thin-pack when possible; false
when it shouldn'tPackTransport
public boolean isCheckFetchedObjects()
public void setCheckFetchedObjects(boolean check)
check
- true to enable checking received objects; false to assume all
received objects are valid.public String getOptionReceivePack()
RemoteConfig.DEFAULT_RECEIVE_PACK
PackTransport
public void setOptionReceivePack(String optionReceivePack)
RemoteConfig.DEFAULT_RECEIVE_PACK
optionReceivePack
- remote executable, if null or empty default one is set;public boolean isPushThin()
PackTransport
public void setPushThin(boolean pushThin)
pushThin
- true when push should produce thin-pack in pack transports;
false when it shouldn'tPackTransport
public boolean isRemoveDeletedRefs()
public void setRemoveDeletedRefs(boolean remove)
If true, refs at the destination repository (local for fetch, remote for push) are deleted if they no longer exist on the source side (remote for fetch, local for push).
False by default, as this may cause data to become unreachable, and eventually be deleted on the next GC.
remove
- true to remove refs that no longer exist.public void applyConfig(RemoteConfig cfg)
cfg
- configuration to apply on this transport.public boolean isDryRun()
public void setDryRun(boolean dryRun)
dryRun
- true if push operation should just check for possible result
and not really update remote refs, false otherwise - when push
should act normally.public int getTimeout()
public void setTimeout(int seconds)
seconds
- number of seconds to wait (with no data transfer occurring)
before aborting an IO read or write operation with this
remote.public PackConfig getPackConfig()
setPackConfig(PackConfig)
was previously given null a new
PackConfig is created on demand by this method using the source
repository's settings.public void setPackConfig(PackConfig pc)
pc
- configuration controlling packing parameters. If null the
source repository's settings will be used.public void setCredentialsProvider(CredentialsProvider credentialsProvider)
credentialsProvider
- the credentials provider, or null if there is nonepublic CredentialsProvider getCredentialsProvider()
public FetchResult fetch(ProgressMonitor monitor, Collection<RefSpec> toFetch) throws NotSupportedException, TransportException
This is a utility function providing standard fetch behavior. Local
tracking refs associated with the remote repository are automatically
updated if this transport was created from a RemoteConfig
with
fetch RefSpecs defined.
monitor
- progress monitor to inform the user about our processing
activity. Must not be null. Use NullProgressMonitor
if
progress updates are not interesting or necessary.toFetch
- specification of refs to fetch locally. May be null or the
empty collection to use the specifications from the
RemoteConfig. Source for each RefSpec can't be null.NotSupportedException
- this transport implementation does not support fetching
objects.TransportException
- the remote connection could not be established or object
copying (if necessary) failed or update specification was
incorrect.public PushResult push(ProgressMonitor monitor, Collection<RemoteRefUpdate> toPush, OutputStream out) throws NotSupportedException, TransportException
This is a utility function providing standard push behavior. It updates remote refs and send there necessary objects according to remote ref update specification. After successful remote ref update, associated locally stored tracking branch is updated if set up accordingly. Detailed operation result is provided after execution.
For setting up remote ref update specification from ref spec, see helper
method findRemoteRefUpdatesFor(Collection)
, predefined refspecs
(REFSPEC_TAGS
, REFSPEC_PUSH_ALL
) or consider using
directly RemoteRefUpdate
for more possibilities.
When isDryRun()
is true, result of this operation is just
estimation of real operation result, no real action is performed.
monitor
- progress monitor to inform the user about our processing
activity. Must not be null. Use NullProgressMonitor
if
progress updates are not interesting or necessary.toPush
- specification of refs to push. May be null or the empty
collection to use the specifications from the RemoteConfig
converted by findRemoteRefUpdatesFor(Collection)
. No
more than 1 RemoteRefUpdate with the same remoteName is
allowed. These objects are modified during this call.out
- output stream to write messages toNotSupportedException
- this transport implementation does not support pushing
objects.TransportException
- the remote connection could not be established or object
copying (if necessary) failed at I/O or protocol level or
update specification was incorrect.RemoteRefUpdate
public PushResult push(ProgressMonitor monitor, Collection<RemoteRefUpdate> toPush) throws NotSupportedException, TransportException
This is a utility function providing standard push behavior. It updates remote refs and sends necessary objects according to remote ref update specification. After successful remote ref update, associated locally stored tracking branch is updated if set up accordingly. Detailed operation result is provided after execution.
For setting up remote ref update specification from ref spec, see helper
method findRemoteRefUpdatesFor(Collection)
, predefined refspecs
(REFSPEC_TAGS
, REFSPEC_PUSH_ALL
) or consider using
directly RemoteRefUpdate
for more possibilities.
When isDryRun()
is true, result of this operation is just
estimation of real operation result, no real action is performed.
monitor
- progress monitor to inform the user about our processing
activity. Must not be null. Use NullProgressMonitor
if
progress updates are not interesting or necessary.toPush
- specification of refs to push. May be null or the empty
collection to use the specifications from the RemoteConfig
converted by findRemoteRefUpdatesFor(Collection)
. No
more than 1 RemoteRefUpdate with the same remoteName is
allowed. These objects are modified during this call.NotSupportedException
- this transport implementation does not support pushing
objects.TransportException
- the remote connection could not be established or object
copying (if necessary) failed at I/O or protocol level or
update specification was incorrect.RemoteRefUpdate
public Collection<RemoteRefUpdate> findRemoteRefUpdatesFor(Collection<RefSpec> specs) throws IOException
RefSpec
form
to RemoteRefUpdate
. Conversion expands wildcards by matching
source part to local refs. expectedOldObjectId in RemoteRefUpdate is
always set as null. Tracking branch is configured if RefSpec destination
matches source of any fetch ref spec for this transport remote
configuration.
Conversion is performed for context of this transport (database, fetch specifications).
specs
- collection of RefSpec to convert.RemoteRefUpdate
.IOException
- when problem occurred during conversion or specification set
up: most probably, missing objects or refs.public abstract FetchConnection openFetch() throws NotSupportedException, TransportException
If the transport has no local repository, the fetch connection can only be used for reading remote refs.
NotSupportedException
- the implementation does not support fetching.TransportException
- the remote connection could not be established.public abstract PushConnection openPush() throws NotSupportedException, TransportException
NotSupportedException
- the implementation does not support pushing.TransportException
- the remote connection could not be establishedpublic abstract void close()
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.
Copyright © 2014. All rights reserved.