1 /*
2 * Copyright (C) 2009, Constantine Plotnikov <constantine.plotnikov@gmail.com>
3 * Copyright (C) 2008, Google Inc.
4 * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
5 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
6 * and other copyright owners as documented in the project's IP log.
7 *
8 * This program and the accompanying materials are made available
9 * under the terms of the Eclipse Distribution License v1.0 which
10 * accompanies this distribution, is reproduced below, and is
11 * available at http://www.eclipse.org/org/documents/edl-v10.php
12 *
13 * All rights reserved.
14 *
15 * Redistribution and use in source and binary forms, with or
16 * without modification, are permitted provided that the following
17 * conditions are met:
18 *
19 * - Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 *
22 * - Redistributions in binary form must reproduce the above
23 * copyright notice, this list of conditions and the following
24 * disclaimer in the documentation and/or other materials provided
25 * with the distribution.
26 *
27 * - Neither the name of the Eclipse Foundation, Inc. nor the
28 * names of its contributors may be used to endorse or promote
29 * products derived from this software without specific prior
30 * written permission.
31 *
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
33 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
34 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
36 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
37 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
39 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
40 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
41 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
42 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
43 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
44 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45 */
46
47 package org.eclipse.jgit.transport;
48
49 import java.io.IOException;
50 import java.io.InputStream;
51
52 import org.eclipse.jgit.errors.NotSupportedException;
53 import org.eclipse.jgit.errors.TransportException;
54 import org.eclipse.jgit.internal.JGitText;
55 import org.eclipse.jgit.lib.Repository;
56
57 /**
58 * Single shot fetch from a streamed Git bundle.
59 * <p>
60 * The bundle is read from an unbuffered input stream, which limits the
61 * transport to opening at most one FetchConnection before needing to recreate
62 * the transport instance.
63 */
64 public class TransportBundleStream extends Transport implements TransportBundle {
65 private InputStream src;
66
67 /**
68 * Create a new transport to fetch objects from a streamed bundle.
69 * <p>
70 * The stream can be unbuffered (buffering is automatically provided
71 * internally to smooth out short reads) and unpositionable (the stream is
72 * read from only once, sequentially).
73 * <p>
74 * When the FetchConnection or the this instance is closed the supplied
75 * input stream is also automatically closed. This frees callers from
76 * needing to keep track of the supplied stream.
77 *
78 * @param db
79 * repository the fetched objects will be loaded into.
80 * @param uri
81 * symbolic name of the source of the stream. The URI can
82 * reference a non-existent resource. It is used only for
83 * exception reporting.
84 * @param in
85 * the stream to read the bundle from.
86 */
87 public TransportBundleStream(final Repository db, final URIish uri,
88 final InputStream in) {
89 super(db, uri);
90 src = in;
91 }
92
93 /** {@inheritDoc} */
94 @Override
95 public FetchConnection openFetch() throws TransportException {
96 if (src == null)
97 throw new TransportException(uri, JGitText.get().onlyOneFetchSupported);
98 try {
99 return new BundleFetchConnection(this, src);
100 } finally {
101 src = null;
102 }
103 }
104
105 /** {@inheritDoc} */
106 @Override
107 public PushConnection openPush() throws NotSupportedException {
108 throw new NotSupportedException(
109 JGitText.get().pushIsNotSupportedForBundleTransport);
110 }
111
112 /** {@inheritDoc} */
113 @Override
114 public void close() {
115 if (src != null) {
116 try {
117 src.close();
118 } catch (IOException err) {
119 // Ignore a close error.
120 } finally {
121 src = null;
122 }
123 }
124 }
125 }