View Javadoc
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 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  	 * Mutli-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  	 * Mutli-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 does not want progress messages and will ignore them.
112 	 *
113 	 * @since 3.2
114 	 */
115 	public static final String OPTION_NO_PROGRESS = "no-progress"; //$NON-NLS-1$
116 
117 	/**
118 	 * The client supports receiving a pack before it has sent "done".
119 	 *
120 	 * @since 3.2
121 	 */
122 	public static final String OPTION_NO_DONE = "no-done"; //$NON-NLS-1$
123 
124 	/**
125 	 * The client supports fetching objects at the tip of any ref, even if not
126 	 * advertised.
127 	 *
128 	 * @since 3.2
129 	 */
130 	public static final String OPTION_ALLOW_TIP_SHA1_IN_WANT = "allow-tip-sha1-in-want"; //$NON-NLS-1$
131 
132 	/**
133 	 * The client supports fetching objects that are reachable from a tip of a
134 	 * ref that is allowed to fetch.
135 	 *
136 	 * @since 4.1
137 	 */
138 	public static final String OPTION_ALLOW_REACHABLE_SHA1_IN_WANT = "allow-reachable-sha1-in-want"; //$NON-NLS-1$
139 
140 	/**
141 	 * Symbolic reference support for better negotiation.
142 	 *
143 	 * @since 3.6
144 	 */
145 	public static final String OPTION_SYMREF = "symref"; //$NON-NLS-1$
146 
147 	/**
148 	 * The client will send a push certificate.
149 	 *
150 	 * @since 4.0
151 	 */
152 	public static final String OPTION_PUSH_CERT = "push-cert"; //$NON-NLS-1$
153 
154 	/**
155 	 * The client supports atomic pushes. If this option is used, the server
156 	 * will update all refs within one atomic transaction.
157 	 *
158 	 * @since 3.6
159 	 */
160 	public static final String CAPABILITY_ATOMIC = "atomic"; //$NON-NLS-1$
161 
162 	/**
163 	 * The client expects less noise, e.g. no progress.
164 	 *
165 	 * @since 4.0
166 	 */
167 	public static final String CAPABILITY_QUIET = "quiet"; //$NON-NLS-1$
168 
169 	/**
170 	 * The client expects a status report after the server processes the pack.
171 	 *
172 	 * @since 3.2
173 	 */
174 	public static final String CAPABILITY_REPORT_STATUS = "report-status"; //$NON-NLS-1$
175 
176 	/**
177 	 * The server supports deleting refs.
178 	 *
179 	 * @since 3.2
180 	 */
181 	public static final String CAPABILITY_DELETE_REFS = "delete-refs"; //$NON-NLS-1$
182 
183 	/**
184 	 * The server supports packs with OFS deltas.
185 	 *
186 	 * @since 3.2
187 	 */
188 	public static final String CAPABILITY_OFS_DELTA = "ofs-delta"; //$NON-NLS-1$
189 
190 	/**
191 	 * The client supports using the 64K side-band for progress messages.
192 	 *
193 	 * @since 3.2
194 	 */
195 	public static final String CAPABILITY_SIDE_BAND_64K = "side-band-64k"; //$NON-NLS-1$
196 
197 	/**
198 	 * The server allows recording of push certificates.
199 	 *
200 	 * @since 4.0
201 	 */
202 	public static final String CAPABILITY_PUSH_CERT = "push-cert"; //$NON-NLS-1$
203 
204 	/**
205 	 * Implementation name and version of the client or server.
206 	 *
207 	 * @since 4.0
208 	 */
209 	public static final String OPTION_AGENT = "agent"; //$NON-NLS-1$
210 
211 	static enum MultiAck {
212 		OFF, CONTINUE, DETAILED;
213 	}
214 
215 	private GitProtocolConstants() {
216 	}
217 }