org.spearce.jgit/src/org/spearce/jgit/transport/Connection.java

   1 /*
   2  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
   3  * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
   4  *
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or
   8  * without modification, are permitted provided that the following
   9  * conditions are met:
  10  *
  11  * - Redistributions of source code must retain the above copyright
  12  *   notice, this list of conditions and the following disclaimer.
  13  *
  14  * - Redistributions in binary form must reproduce the above
  15  *   copyright notice, this list of conditions and the following
  16  *   disclaimer in the documentation and/or other materials provided
  17  *   with the distribution.
  18  *
  19  * - Neither the name of the Git Development Community nor the
  20  *   names of its contributors may be used to endorse or promote
  21  *   products derived from this software without specific prior
  22  *   written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  25  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  26  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  34  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  36  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37  */
  38
  39 package org.spearce.jgit.transport;
  40
  41 import java.util.Collection;
  42 import java.util.Map;
  43
  44 import org.spearce.jgit.lib.Ref;
  45
  46 /**
  47  * Represent connection for operation on a remote repository.
  48  * <p>
  49  * Currently all operations on remote repository (fetch and push) provide
  50  * information about remote refs. Every connection is able to be closed and
  51  * should be closed - this is a connection client responsibility.
  52  *
  53  * @see Transport
  54  */
  55 public interface Connection {
  56
  57         /**
  58          * Get the complete map of refs advertised as available for fetching or
  59          * pushing.
  60          *
  61          * @return available/advertised refs: map of refname to ref. Never null. Not
  62          *         modifiable. The collection can be empty if the remote side has no
  63          *         refs (it is an empty/newly created repository).
  64          */
  65         public Map<String, Ref> getRefsMap();
  66
  67         /**
  68          * Get the complete list of refs advertised as available for fetching or
  69          * pushing.
  70          * <p>
  71          * The returned refs may appear in any order. If the caller needs these to
  72          * be sorted, they should be copied into a new array or List and then sorted
  73          * by the caller as necessary.
  74          *
  75          * @return available/advertised refs. Never null. Not modifiable. The
  76          *         collection can be empty if the remote side has no refs (it is an
  77          *         empty/newly created repository).
  78          */
  79         public Collection<Ref> getRefs();
  80
  81         /**
  82          * Get a single advertised ref by name.
  83          * <p>
  84          * The name supplied should be valid ref name. To get a peeled value for a
  85          * ref (aka <code>refs/tags/v1.0^{}</code>) use the base name (without
  86          * the <code>^{}</code> suffix) and look at the peeled object id.
  87          *
  88          * @param name
  89          *            name of the ref to obtain.
  90          * @return the requested ref; null if the remote did not advertise this ref.
  91          */
  92         public Ref getRef(final String name);
  93
  94         /**
  95          * Close any resources used by this connection.
  96          * <p>
  97          * If the remote repository is contacted by a network socket this method
  98          * must close that network socket, disconnecting the two peers. If the
  99          * remote repository is actually local (same system) this method must close
 100          * any open file handles used to read the "remote" repository.
 101          */
 102         public void close();
 103
 104 }