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 static java.util.Objects.requireNonNull;
46
47 import java.util.Collection;
48 import java.util.Collections;
49 import java.util.HashSet;
50 import java.util.Set;
51
52 import org.eclipse.jgit.annotations.NonNull;
53 import org.eclipse.jgit.annotations.Nullable;
54 import org.eclipse.jgit.lib.ObjectId;
55
56 /**
57 * Fetch request in the V0/V1 protocol.
58 */
59 final class FetchV0Request extends FetchRequest {
60
61 FetchV0Request(@NonNull Set<ObjectId> wantIds, int depth,
62 @NonNull Set<ObjectId> clientShallowCommits,
63 @NonNull FilterSpec filterSpec,
64 @NonNull Set<String> clientCapabilities, @Nullable String agent) {
65 super(wantIds, depth, clientShallowCommits, filterSpec,
66 clientCapabilities, 0, Collections.emptyList(), agent);
67 }
68
69 static final class Builder {
70
71 int depth;
72
73 final Set<ObjectId> wantIds = new HashSet<>();
74
75 final Set<ObjectId> clientShallowCommits = new HashSet<>();
76
77 FilterSpec filterSpec = FilterSpec.NO_FILTER;
78
79 final Set<String> clientCaps = new HashSet<>();
80
81 String agent;
82
83 /**
84 * @param objectId
85 * object id received in a "want" line
86 * @return this builder
87 */
88 Builder addWantId(ObjectId objectId) {
89 wantIds.add(objectId);
90 return this;
91 }
92
93 /**
94 * @param d
95 * depth set in a "deepen" line
96 * @return this builder
97 */
98 Builder setDepth(int d) {
99 depth = d;
100 return this;
101 }
102
103 /**
104 * @param shallowOid
105 * object id received in a "shallow" line
106 * @return this builder
107 */
108 Builder addClientShallowCommit(ObjectId shallowOid) {
109 clientShallowCommits.add(shallowOid);
110 return this;
111 }
112
113 /**
114 * @param clientCapabilities
115 * client capabilities sent by the client in the first want
116 * line of the request
117 * @return this builder
118 */
119 Builder addClientCapabilities(Collection<String> clientCapabilities) {
120 clientCaps.addAll(clientCapabilities);
121 return this;
122 }
123
124 /**
125 * @param clientAgent
126 * agent line sent by the client in the request body
127 * @return this builder
128 */
129 Builder setAgent(String clientAgent) {
130 agent = clientAgent;
131 return this;
132 }
133
134 /**
135 * @param filter
136 * the filter set in a filter line
137 * @return this builder
138 */
139 Builder setFilterSpec(@NonNull FilterSpec filter) {
140 filterSpec = requireNonNull(filter);
141 return this;
142 }
143
144 FetchV0Request build() {
145 return new FetchV0Request(wantIds, depth, clientShallowCommits,
146 filterSpec, clientCaps, agent);
147 }
148
149 }
150 }