org.eclipse.jgit.transport
Interface Connection

All Known Subinterfaces:
FetchConnection, PushConnection

public interface Connection

Represent connection for operation on a remote repository.

Currently all operations on remote repository (fetch and push) provide information about remote refs. Every connection is able to be closed and should be closed - this is a connection client responsibility.

See Also:
Transport

Method Summary
 void close()
          Close any resources used by this connection.
 Ref getRef(java.lang.String name)
          Get a single advertised ref by name.
 java.util.Collection<Ref> getRefs()
          Get the complete list of refs advertised as available for fetching or pushing.
 java.util.Map<java.lang.String,Ref> getRefsMap()
          Get the complete map of refs advertised as available for fetching or pushing.
 

Method Detail

getRefsMap

java.util.Map<java.lang.String,Ref> getRefsMap()
Get the complete map of refs advertised as available for fetching or pushing.

Returns:
available/advertised refs: map of refname to ref. Never null. Not modifiable. The collection can be empty if the remote side has no refs (it is an empty/newly created repository).

getRefs

java.util.Collection<Ref> getRefs()
Get the complete list of refs advertised as available for fetching or pushing.

The returned refs may appear in any order. If the caller needs these to be sorted, they should be copied into a new array or List and then sorted by the caller as necessary.

Returns:
available/advertised refs. Never null. Not modifiable. The collection can be empty if the remote side has no refs (it is an empty/newly created repository).

getRef

Ref getRef(java.lang.String name)
Get a single advertised ref by name.

The name supplied should be valid ref name. To get a peeled value for a ref (aka refs/tags/v1.0^{}) use the base name (without the ^{} suffix) and look at the peeled object id.

Parameters:
name - name of the ref to obtain.
Returns:
the requested ref; null if the remote did not advertise this ref.

close

void close()
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.