Class TransportBundleStream

  • All Implemented Interfaces:
    AutoCloseable, PackTransport, TransportBundle

    public class TransportBundleStream
    extends Transport
    implements TransportBundle
    Single shot fetch from a streamed Git bundle.

    The bundle is read from an unbuffered input stream, which limits the transport to opening at most one FetchConnection before needing to recreate the transport instance.

    • Constructor Detail

      • TransportBundleStream

        public TransportBundleStream​(Repository db,
                                     URIish uri,
                                     InputStream in)
        Create a new transport to fetch objects from a streamed bundle.

        The stream can be unbuffered (buffering is automatically provided internally to smooth out short reads) and unpositionable (the stream is read from only once, sequentially).

        When the FetchConnection or the this instance is closed the supplied input stream is also automatically closed. This frees callers from needing to keep track of the supplied stream.

        db - repository the fetched objects will be loaded into.
        uri - symbolic name of the source of the stream. The URI can reference a non-existent resource. It is used only for exception reporting.
        in - the stream to read the bundle from.
    • Method Detail

      • openFetch

        public FetchConnection openFetch()
                                  throws TransportException
        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.

        Specified by:
        openFetch in class Transport
        a fresh connection to fetch from the remote repository.
        TransportException - the remote connection could not be established.
      • close

        public void close()

        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.

        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in class Transport