1 /* 2 * Copyright (C) 2008, Google Inc. 3 * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com> 4 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org> 5 * and other copyright owners as documented in the project's IP log. 6 * 7 * This program and the accompanying materials are made available 8 * under the terms of the Eclipse Distribution License v1.0 which 9 * accompanies this distribution, is reproduced below, and is 10 * available at http://www.eclipse.org/org/documents/edl-v10.php 11 * 12 * All rights reserved. 13 * 14 * Redistribution and use in source and binary forms, with or 15 * without modification, are permitted provided that the following 16 * conditions are met: 17 * 18 * - Redistributions of source code must retain the above copyright 19 * notice, this list of conditions and the following disclaimer. 20 * 21 * - Redistributions in binary form must reproduce the above 22 * copyright notice, this list of conditions and the following 23 * disclaimer in the documentation and/or other materials provided 24 * with the distribution. 25 * 26 * - Neither the name of the Eclipse Foundation, Inc. nor the 27 * names of its contributors may be used to endorse or promote 28 * products derived from this software without specific prior 29 * written permission. 30 * 31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 32 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 33 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 34 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 35 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 36 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 37 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 38 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 39 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 40 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 41 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 42 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 43 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 44 */ 45 46 package org.eclipse.jgit.transport; 47 48 import java.io.OutputStream; 49 import java.util.Collection; 50 import java.util.Set; 51 52 import org.eclipse.jgit.errors.TransportException; 53 import org.eclipse.jgit.lib.ObjectId; 54 import org.eclipse.jgit.lib.ProgressMonitor; 55 import org.eclipse.jgit.lib.Ref; 56 57 /** 58 * Base helper class for fetch connection implementations. Provides some common 59 * typical structures and methods used during fetch connection. 60 * <p> 61 * Implementors of fetch over pack-based protocols should consider using 62 * {@link BasePackFetchConnection} instead. 63 * </p> 64 */ 65 abstract class BaseFetchConnection extends BaseConnection implements 66 FetchConnection { 67 public final void fetch(final ProgressMonitor monitor, 68 final Collection<Ref> want, final Set<ObjectId> have) 69 throws TransportException { 70 fetch(monitor, want, have, null); 71 } 72 73 public final void fetch(final ProgressMonitor monitor, 74 final Collection<Ref> want, final Set<ObjectId> have, 75 OutputStream out) throws TransportException { 76 markStartedOperation(); 77 doFetch(monitor, want, have); 78 } 79 80 /** 81 * Default implementation of {@link FetchConnection#didFetchIncludeTags()} - 82 * returning false. 83 */ 84 public boolean didFetchIncludeTags() { 85 return false; 86 } 87 88 /** 89 * Implementation of {@link #fetch(ProgressMonitor, Collection, Set)} 90 * without checking for multiple fetch. 91 * 92 * @param monitor 93 * as in {@link #fetch(ProgressMonitor, Collection, Set)} 94 * @param want 95 * as in {@link #fetch(ProgressMonitor, Collection, Set)} 96 * @param have 97 * as in {@link #fetch(ProgressMonitor, Collection, Set)} 98 * @throws TransportException 99 * as in {@link #fetch(ProgressMonitor, Collection, Set)}, but 100 * implementation doesn't have to care about multiple 101 * {@link #fetch(ProgressMonitor, Collection, Set)} calls, as it 102 * is checked in this class. 103 */ 104 protected abstract void doFetch(final ProgressMonitor monitor, 105 final Collection<Ref> want, final Set<ObjectId> have) 106 throws TransportException; 107 }