1 /*
2 * Copyright (C) 2018, Google LLC.
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43 package org.eclipse.jgit.transport;
44
45 import java.util.Collection;
46 import java.util.Collections;
47 import java.util.HashSet;
48 import java.util.Set;
49
50 import org.eclipse.jgit.annotations.NonNull;
51 import org.eclipse.jgit.annotations.Nullable;
52 import org.eclipse.jgit.lib.ObjectId;
53
54 /**
55 * Fetch request in the V0/V1 protocol.
56 */
57 final class FetchV0Request extends FetchRequest {
58
59 FetchV0Request(@NonNull Set<ObjectId> wantIds, int depth,
60 @NonNull Set<ObjectId> clientShallowCommits, long filterBlobLimit,
61 @NonNull Set<String> clientCapabilities, @Nullable String agent) {
62 super(wantIds, depth, clientShallowCommits, filterBlobLimit,
63 clientCapabilities, 0, Collections.emptyList(), agent);
64 }
65
66 static final class Builder {
67
68 int depth;
69
70 final Set<ObjectId> wantIds = new HashSet<>();
71
72 final Set<ObjectId> clientShallowCommits = new HashSet<>();
73
74 long filterBlobLimit = -1;
75
76 final Set<String> clientCaps = new HashSet<>();
77
78 String agent;
79
80 /**
81 * @param objectId
82 * object id received in a "want" line
83 * @return this builder
84 */
85 Builder addWantId(ObjectId objectId) {
86 wantIds.add(objectId);
87 return this;
88 }
89
90 /**
91 * @param d
92 * depth set in a "deepen" line
93 * @return this builder
94 */
95 Builder setDepth(int d) {
96 depth = d;
97 return this;
98 }
99
100 /**
101 * @param shallowOid
102 * object id received in a "shallow" line
103 * @return this builder
104 */
105 Builder addClientShallowCommit(ObjectId shallowOid) {
106 clientShallowCommits.add(shallowOid);
107 return this;
108 }
109
110 /**
111 * @param clientCapabilities
112 * client capabilities sent by the client in the first want
113 * line of the request
114 * @return this builder
115 */
116 Builder addClientCapabilities(Collection<String> clientCapabilities) {
117 clientCaps.addAll(clientCapabilities);
118 return this;
119 }
120
121 /**
122 * @param clientAgent
123 * agent line sent by the client in the request body
124 * @return this builder
125 */
126 Builder setAgent(String clientAgent) {
127 agent = clientAgent;
128 return this;
129 }
130
131 /**
132 * @param filterBlobLim
133 * blob limit set in a "filter" line
134 * @return this builder
135 */
136 Builder setFilterBlobLimit(long filterBlobLim) {
137 filterBlobLimit = filterBlobLim;
138 return this;
139 }
140
141 FetchV0Request build() {
142 return new FetchV0Request(wantIds, depth, clientShallowCommits,
143 filterBlobLimit, clientCaps, agent);
144 }
145
146 }
147 }