1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
|
/*
* Copyright (C) 2018, Google LLC. and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0 which is available at
* https://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.transport;
import static java.util.Objects.requireNonNull;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import org.eclipse.jgit.annotations.NonNull;
import org.eclipse.jgit.annotations.Nullable;
/**
* ls-refs protocol v2 request.
*
* <p>
* This is used as an input to {@link ProtocolV2Hook}.
*
* @since 5.1
*/
public final class LsRefsV2Request {
private final List<String> refPrefixes;
private final boolean symrefs;
private final boolean peel;
@Nullable
private final String agent;
private final String clientSID;
@NonNull
private final List<String> serverOptions;
private LsRefsV2Request(List<String> refPrefixes, boolean symrefs,
boolean peel, @Nullable String agent,
@NonNull List<String> serverOptions,
@Nullable String clientSID) {
this.refPrefixes = refPrefixes;
this.symrefs = symrefs;
this.peel = peel;
this.agent = agent;
this.serverOptions = requireNonNull(serverOptions);
this.clientSID = clientSID;
}
/**
* Get ref prefixes
*
* @return ref prefixes that the client requested.
*/
public List<String> getRefPrefixes() {
return refPrefixes;
}
/**
* Whether the client requests symbolic references
*
* @return true if the client requests symbolic references.
*/
public boolean getSymrefs() {
return symrefs;
}
/**
* Whether the client requests tags to be peeled
*
* @return true if the client requests tags to be peeled.
*/
public boolean getPeel() {
return peel;
}
/**
* Get agent reported by the client
*
* @return agent as reported by the client
*
* @since 5.2
*/
@Nullable
public String getAgent() {
return agent;
}
/**
* Get session-id reported by the client
*
* @return session-id as reported by the client
*
* @since 6.4
*/
@Nullable
public String getClientSID() {
return clientSID;
}
/**
* Get application-specific options provided by the client using
* --server-option.
* <p>
* It returns just the content, without the "server-option=" prefix. E.g. a
* request with server-option=A and server-option=B lines returns the list
* [A, B].
*
* @return application-specific options from the client as an unmodifiable
* list
*
* @since 5.2
*/
@NonNull
public List<String> getServerOptions() {
return serverOptions;
}
/**
* Create builder
*
* @return A builder of {@link LsRefsV2Request}.
*/
public static Builder builder() {
return new Builder();
}
/** A builder for {@link LsRefsV2Request}. */
public static final class Builder {
private List<String> refPrefixes = Collections.emptyList();
private boolean symrefs;
private boolean peel;
private final List<String> serverOptions = new ArrayList<>();
private String agent;
private String clientSID;
private Builder() {
}
/**
* Set ref prefixes
*
* @param value
* ref prefix values
* @return the Builder
*/
public Builder setRefPrefixes(List<String> value) {
refPrefixes = value;
return this;
}
/**
* Set symrefs
*
* @param value
* of symrefs
* @return the Builder
*/
public Builder setSymrefs(boolean value) {
symrefs = value;
return this;
}
/**
* Set whether to peel tags
*
* @param value
* of peel
* @return the Builder
*/
public Builder setPeel(boolean value) {
peel = value;
return this;
}
/**
* Records an application-specific option supplied in a server-option
* line, for later retrieval with
* {@link LsRefsV2Request#getServerOptions}.
*
* @param value
* the client-supplied server-option capability, without
* leading "server-option=".
* @return this builder
* @since 5.2
*/
public Builder addServerOption(@NonNull String value) {
serverOptions.add(value);
return this;
}
/**
* Value of an agent line received after the command and before the
* arguments. E.g. "agent=a.b.c/1.0" should set "a.b.c/1.0".
*
* @param value
* the client-supplied agent capability, without leading
* "agent="
* @return this builder
*
* @since 5.2
*/
public Builder setAgent(@Nullable String value) {
agent = value;
return this;
}
/**
* Value of a session-id line received after the command and before the
* arguments. E.g. "session-id=a.b.c" should set "a.b.c".
*
* @param value
* the client-supplied session-id capability, without leading
* "session-id="
* @return this builder
*
* @since 6.4
*/
public Builder setClientSID(@Nullable String value) {
clientSID = value;
return this;
}
/**
* Builds the request
*
* @return LsRefsV2Request the request
*/
public LsRefsV2Request build() {
return new LsRefsV2Request(
Collections.unmodifiableList(refPrefixes), symrefs, peel,
agent, Collections.unmodifiableList(serverOptions),
clientSID);
}
}
}
|
