1 /*
2 * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
3 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
4 * and other copyright owners as documented in the project's IP log.
5 *
6 * This program and the accompanying materials are made available
7 * under the terms of the Eclipse Distribution License v1.0 which
8 * accompanies this distribution, is reproduced below, and is
9 * available at http://www.eclipse.org/org/documents/edl-v10.php
10 *
11 * All rights reserved.
12 *
13 * Redistribution and use in source and binary forms, with or
14 * without modification, are permitted provided that the following
15 * conditions are met:
16 *
17 * - Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * - Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials provided
23 * with the distribution.
24 *
25 * - Neither the name of the Eclipse Foundation, Inc. nor the
26 * names of its contributors may be used to endorse or promote
27 * products derived from this software without specific prior
28 * written permission.
29 *
30 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
31 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
32 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
33 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
35 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
36 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
41 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
42 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 */
44
45 package org.eclipse.jgit.transport;
46
47 import java.io.OutputStream;
48 import java.util.Map;
49
50 import org.eclipse.jgit.errors.TransportException;
51 import org.eclipse.jgit.lib.ProgressMonitor;
52 import org.eclipse.jgit.transport.RemoteRefUpdate.Status;
53
54 /**
55 * Lists known refs from the remote and sends objects to the remote.
56 * <p>
57 * A push connection typically connects to the <code>git-receive-pack</code>
58 * service running where the remote repository is stored. This provides a
59 * one-way object transfer service to copy objects from the local repository
60 * into the remote repository, as well as a way to modify the refs stored by the
61 * remote repository.
62 * <p>
63 * Instances of a PushConnection must be created by a {@link Transport} that
64 * implements a specific object transfer protocol that both sides of the
65 * connection understand.
66 * <p>
67 * PushConnection instances are not thread safe and may be accessed by only one
68 * thread at a time.
69 *
70 * @see Transport
71 */
72 public interface PushConnection extends Connection {
73
74 /**
75 * Pushes to the remote repository basing on provided specification. This
76 * possibly result in update/creation/deletion of refs on remote repository
77 * and sending objects that remote repository need to have a consistent
78 * objects graph from new refs.
79 * <p>
80 * <p>
81 * Only one call per connection is allowed. Subsequent calls will result in
82 * {@link TransportException}.
83 * </p>
84 * <p>
85 * Implementation may use local repository to send a minimum set of objects
86 * needed by remote repository in efficient way.
87 * {@link Transport#isPushThin()} should be honored if applicable.
88 * refUpdates should be filled with information about status of each update.
89 * </p>
90 *
91 * @param monitor
92 * progress monitor to update the end-user about the amount of
93 * work completed, or to indicate cancellation. Implementors
94 * should poll the monitor at regular intervals to look for
95 * cancellation requests from the user.
96 * @param refUpdates
97 * map of remote refnames to remote refs update
98 * specifications/statuses. Can't be empty. This indicate what
99 * refs caller want to update on remote side. Only refs updates
100 * with {@link Status#NOT_ATTEMPTED} should passed.
101 * Implementation must ensure that and appropriate status with
102 * optional message should be set during call. No refUpdate with
103 * {@link Status#AWAITING_REPORT} or {@link Status#NOT_ATTEMPTED}
104 * can be leaved by implementation after return from this call.
105 * @throws TransportException
106 * objects could not be copied due to a network failure,
107 * critical protocol error, or error on remote side, or
108 * connection was already used for push - new connection must be
109 * created. Non-critical errors concerning only isolated refs
110 * should be placed in refUpdates.
111 */
112 public void push(final ProgressMonitor monitor,
113 final Map<String, RemoteRefUpdate> refUpdates)
114 throws TransportException;
115
116 /**
117 * Pushes to the remote repository basing on provided specification. This
118 * possibly result in update/creation/deletion of refs on remote repository
119 * and sending objects that remote repository need to have a consistent
120 * objects graph from new refs.
121 * <p>
122 * <p>
123 * Only one call per connection is allowed. Subsequent calls will result in
124 * {@link TransportException}.
125 * </p>
126 * <p>
127 * Implementation may use local repository to send a minimum set of objects
128 * needed by remote repository in efficient way.
129 * {@link Transport#isPushThin()} should be honored if applicable.
130 * refUpdates should be filled with information about status of each update.
131 * </p>
132 *
133 * @param monitor
134 * progress monitor to update the end-user about the amount of
135 * work completed, or to indicate cancellation. Implementors
136 * should poll the monitor at regular intervals to look for
137 * cancellation requests from the user.
138 * @param refUpdates
139 * map of remote refnames to remote refs update
140 * specifications/statuses. Can't be empty. This indicate what
141 * refs caller want to update on remote side. Only refs updates
142 * with {@link Status#NOT_ATTEMPTED} should passed.
143 * Implementation must ensure that and appropriate status with
144 * optional message should be set during call. No refUpdate with
145 * {@link Status#AWAITING_REPORT} or {@link Status#NOT_ATTEMPTED}
146 * can be leaved by implementation after return from this call.
147 * @param out
148 * output stream to write sideband messages to
149 * @throws TransportException
150 * objects could not be copied due to a network failure,
151 * critical protocol error, or error on remote side, or
152 * connection was already used for push - new connection must be
153 * created. Non-critical errors concerning only isolated refs
154 * should be placed in refUpdates.
155 * @since 3.0
156 */
157 public void push(final ProgressMonitor monitor,
158 final Map<String, RemoteRefUpdate> refUpdates, OutputStream out)
159 throws TransportException;
160
161 }