1 /*
2 * Copyright (C) 2008-2013, Google Inc.
3 * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.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 /**
49 * Wire constants for the native Git protocol.
50 *
51 * @since 3.2
52 */
53 public final class GitProtocolConstants {
54 /**
55 * Include tags if we are also including the referenced objects.
56 *
57 * @since 3.2
58 */
59 public static final String OPTION_INCLUDE_TAG = "include-tag"; //$NON-NLS-1$
60
61 /**
62 * Multi-ACK support for improved negotiation.
63 *
64 * @since 3.2
65 */
66 public static final String OPTION_MULTI_ACK = "multi_ack"; //$NON-NLS-1$
67
68 /**
69 * Multi-ACK detailed support for improved negotiation.
70 *
71 * @since 3.2
72 */
73 public static final String OPTION_MULTI_ACK_DETAILED = "multi_ack_detailed"; //$NON-NLS-1$
74
75 /**
76 * The client supports packs with deltas but not their bases.
77 *
78 * @since 3.2
79 */
80 public static final String OPTION_THIN_PACK = "thin-pack"; //$NON-NLS-1$
81
82 /**
83 * The client supports using the side-band for progress messages.
84 *
85 * @since 3.2
86 */
87 public static final String OPTION_SIDE_BAND = "side-band"; //$NON-NLS-1$
88
89 /**
90 * The client supports using the 64K side-band for progress messages.
91 *
92 * @since 3.2
93 */
94 public static final String OPTION_SIDE_BAND_64K = "side-band-64k"; //$NON-NLS-1$
95
96 /**
97 * The client supports packs with OFS deltas.
98 *
99 * @since 3.2
100 */
101 public static final String OPTION_OFS_DELTA = "ofs-delta"; //$NON-NLS-1$
102
103 /**
104 * The client supports shallow fetches.
105 *
106 * @since 3.2
107 */
108 public static final String OPTION_SHALLOW = "shallow"; //$NON-NLS-1$
109
110 /**
111 * The client wants the "deepen" command to be interpreted as relative to
112 * the client's shallow commits.
113 *
114 * @since 5.0
115 */
116 public static final String OPTION_DEEPEN_RELATIVE = "deepen-relative"; //$NON-NLS-1$
117
118 /**
119 * The client does not want progress messages and will ignore them.
120 *
121 * @since 3.2
122 */
123 public static final String OPTION_NO_PROGRESS = "no-progress"; //$NON-NLS-1$
124
125 /**
126 * The client supports receiving a pack before it has sent "done".
127 *
128 * @since 3.2
129 */
130 public static final String OPTION_NO_DONE = "no-done"; //$NON-NLS-1$
131
132 /**
133 * The client supports fetching objects at the tip of any ref, even if not
134 * advertised.
135 *
136 * @since 3.2
137 */
138 public static final String OPTION_ALLOW_TIP_SHA1_IN_WANT = "allow-tip-sha1-in-want"; //$NON-NLS-1$
139
140 /**
141 * The client supports fetching objects that are reachable from a tip of a
142 * ref that is allowed to fetch.
143 *
144 * @since 4.1
145 */
146 public static final String OPTION_ALLOW_REACHABLE_SHA1_IN_WANT = "allow-reachable-sha1-in-want"; //$NON-NLS-1$
147
148 /**
149 * Symbolic reference support for better negotiation.
150 *
151 * @since 3.6
152 */
153 public static final String OPTION_SYMREF = "symref"; //$NON-NLS-1$
154
155 /**
156 * The client will send a push certificate.
157 *
158 * @since 4.0
159 */
160 public static final String OPTION_PUSH_CERT = "push-cert"; //$NON-NLS-1$
161
162 /**
163 * The client specified a filter expression.
164 *
165 * @since 5.0
166 */
167 public static final String OPTION_FILTER = "filter"; //$NON-NLS-1$
168
169 /**
170 * The client specified a want-ref expression.
171 *
172 * @since 5.1
173 */
174 public static final String OPTION_WANT_REF = "want-ref"; //$NON-NLS-1$
175
176 /**
177 * The client requested that the whole response be multiplexed, with
178 * each non-flush and non-delim pkt prefixed by a sideband designator.
179 *
180 * @since 5.5
181 */
182 public static final String OPTION_SIDEBAND_ALL = "sideband-all"; //$NON-NLS-1$
183
184 /**
185 * The client supports atomic pushes. If this option is used, the server
186 * will update all refs within one atomic transaction.
187 *
188 * @since 3.6
189 */
190 public static final String CAPABILITY_ATOMIC = "atomic"; //$NON-NLS-1$
191
192 /**
193 * The client expects less noise, e.g. no progress.
194 *
195 * @since 4.0
196 */
197 public static final String CAPABILITY_QUIET = "quiet"; //$NON-NLS-1$
198
199 /**
200 * The client expects a status report after the server processes the pack.
201 *
202 * @since 3.2
203 */
204 public static final String CAPABILITY_REPORT_STATUS = "report-status"; //$NON-NLS-1$
205
206 /**
207 * The server supports deleting refs.
208 *
209 * @since 3.2
210 */
211 public static final String CAPABILITY_DELETE_REFS = "delete-refs"; //$NON-NLS-1$
212
213 /**
214 * The server supports packs with OFS deltas.
215 *
216 * @since 3.2
217 */
218 public static final String CAPABILITY_OFS_DELTA = "ofs-delta"; //$NON-NLS-1$
219
220 /**
221 * The client supports using the 64K side-band for progress messages.
222 *
223 * @since 3.2
224 */
225 public static final String CAPABILITY_SIDE_BAND_64K = "side-band-64k"; //$NON-NLS-1$
226
227 /**
228 * The server allows recording of push certificates.
229 *
230 * @since 4.0
231 */
232 public static final String CAPABILITY_PUSH_CERT = "push-cert"; //$NON-NLS-1$
233
234 /**
235 * Implementation name and version of the client or server.
236 *
237 * @since 4.0
238 */
239 public static final String OPTION_AGENT = "agent"; //$NON-NLS-1$
240
241 /**
242 * The server supports the receiving of push options.
243 *
244 * @since 4.5
245 */
246 public static final String CAPABILITY_PUSH_OPTIONS = "push-options"; //$NON-NLS-1$
247
248 /**
249 * The server supports the client specifying ref names.
250 *
251 * @since 5.1
252 */
253 public static final String CAPABILITY_REF_IN_WANT = "ref-in-want"; //$NON-NLS-1$
254
255 /**
256 * The server supports arbitrary options
257 *
258 * @since 5.2
259 */
260 public static final String CAPABILITY_SERVER_OPTION = "server-option"; //$NON-NLS-1$
261
262 /**
263 * Option for passing application-specific options to the server.
264 *
265 * @since 5.2
266 */
267 public static final String OPTION_SERVER_OPTION = "server-option"; //$NON-NLS-1$
268
269 /**
270 * The server supports listing refs using protocol v2.
271 *
272 * @since 5.0
273 */
274 public static final String COMMAND_LS_REFS = "ls-refs"; //$NON-NLS-1$
275
276 /**
277 * The server supports fetch using protocol v2.
278 *
279 * @since 5.0
280 */
281 public static final String COMMAND_FETCH = "fetch"; //$NON-NLS-1$
282
283 static enum MultiAck {
284 OFF, CONTINUE, DETAILED;
285 }
286
287 private GitProtocolConstants() {
288 }
289 }