123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330 |
- /*
- * Copyright (C) 2018, Google LLC.
- * and other copyright owners as documented in the project's IP log.
- *
- * This program and the accompanying materials are made available
- * under the terms of the Eclipse Distribution License v1.0 which
- * accompanies this distribution, is reproduced below, and is
- * available at http://www.eclipse.org/org/documents/edl-v10.php
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or
- * without modification, are permitted provided that the following
- * conditions are met:
- *
- * - Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * - Redistributions in binary form must reproduce the above
- * copyright notice, this list of conditions and the following
- * disclaimer in the documentation and/or other materials provided
- * with the distribution.
- *
- * - Neither the name of the Eclipse Foundation, Inc. nor the
- * names of its contributors may be used to endorse or promote
- * products derived from this software without specific prior
- * written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
- package org.eclipse.jgit.transport;
-
- import static java.util.Objects.requireNonNull;
-
- import java.util.ArrayList;
- import java.util.Collections;
- import java.util.HashSet;
- import java.util.List;
- import java.util.Set;
-
- import org.eclipse.jgit.annotations.NonNull;
- import org.eclipse.jgit.annotations.Nullable;
- import org.eclipse.jgit.lib.ObjectId;
-
- /**
- * Fetch request from git protocol v2.
- *
- * <p>
- * This is used as an input to {@link ProtocolV2Hook}.
- *
- * @since 5.1
- */
- public final class FetchV2Request extends FetchRequest {
- private final List<ObjectId> peerHas;
-
- private final List<String> wantedRefs;
-
- private final boolean doneReceived;
-
- @NonNull
- private final List<String> serverOptions;
-
- FetchV2Request(@NonNull List<ObjectId> peerHas,
- @NonNull List<String> wantedRefs,
- @NonNull Set<ObjectId> wantIds,
- @NonNull Set<ObjectId> clientShallowCommits, int deepenSince,
- @NonNull List<String> deepenNotRefs, int depth,
- @NonNull FilterSpec filterSpec,
- boolean doneReceived, @NonNull Set<String> clientCapabilities,
- @Nullable String agent, @NonNull List<String> serverOptions) {
- super(wantIds, depth, clientShallowCommits, filterSpec,
- clientCapabilities, deepenSince,
- deepenNotRefs, agent);
- this.peerHas = requireNonNull(peerHas);
- this.wantedRefs = requireNonNull(wantedRefs);
- this.doneReceived = doneReceived;
- this.serverOptions = requireNonNull(serverOptions);
- }
-
- /**
- * @return object ids received in the "have" lines
- */
- @NonNull
- List<ObjectId> getPeerHas() {
- return peerHas;
- }
-
- /**
- * @return list of references received in "want-ref" lines
- *
- * @since 5.4
- */
- @NonNull
- public List<String> getWantedRefs() {
- return wantedRefs;
- }
-
- /**
- * @return true if the request had a "done" line
- */
- boolean wasDoneReceived() {
- return doneReceived;
- }
-
- /**
- * Options received in server-option lines. The caller can choose to act on
- * these in an application-specific way
- *
- * @return Immutable list of server options received in the request
- *
- * @since 5.2
- */
- @NonNull
- public List<String> getServerOptions() {
- return serverOptions;
- }
-
- /** @return A builder of {@link FetchV2Request}. */
- static Builder builder() {
- return new Builder();
- }
-
- /** A builder for {@link FetchV2Request}. */
- static final class Builder {
- final List<ObjectId> peerHas = new ArrayList<>();
-
- final List<String> wantedRefs = new ArrayList<>();
-
- final Set<ObjectId> wantIds = new HashSet<>();
-
- final Set<ObjectId> clientShallowCommits = new HashSet<>();
-
- final List<String> deepenNotRefs = new ArrayList<>();
-
- final Set<String> clientCapabilities = new HashSet<>();
-
- int depth;
-
- int deepenSince;
-
- FilterSpec filterSpec = FilterSpec.NO_FILTER;
-
- boolean doneReceived;
-
- @Nullable
- String agent;
-
- final List<String> serverOptions = new ArrayList<>();
-
- private Builder() {
- }
-
- /**
- * @param objectId
- * object id received in a "have" line
- * @return this builder
- */
- Builder addPeerHas(ObjectId objectId) {
- peerHas.add(objectId);
- return this;
- }
-
- /**
- * Ref received in "want-ref" line and the object-id it refers to
- *
- * @param refName
- * reference name
- * @return this builder
- */
- Builder addWantedRef(String refName) {
- wantedRefs.add(refName);
- return this;
- }
-
- /**
- * @param clientCapability
- * capability line sent by the client
- * @return this builder
- */
- Builder addClientCapability(String clientCapability) {
- clientCapabilities.add(clientCapability);
- return this;
- }
-
- /**
- * @param wantId
- * object id received in a "want" line
- * @return this builder
- */
- Builder addWantId(ObjectId wantId) {
- wantIds.add(wantId);
- return this;
- }
-
- /**
- * @param shallowOid
- * object id received in a "shallow" line
- * @return this builder
- */
- Builder addClientShallowCommit(ObjectId shallowOid) {
- clientShallowCommits.add(shallowOid);
- return this;
- }
-
- /**
- * @param d
- * Depth received in a "deepen" line
- * @return this builder
- */
- Builder setDepth(int d) {
- depth = d;
- return this;
- }
-
- /**
- * @return depth set in the request (via a "deepen" line). Defaulting to
- * 0 if not set.
- */
- int getDepth() {
- return depth;
- }
-
- /**
- * @return true if there has been at least one "deepen not" line in the
- * request so far
- */
- boolean hasDeepenNotRefs() {
- return !deepenNotRefs.isEmpty();
- }
-
- /**
- * @param deepenNotRef
- * reference received in a "deepen not" line
- * @return this builder
- */
- Builder addDeepenNotRef(String deepenNotRef) {
- deepenNotRefs.add(deepenNotRef);
- return this;
- }
-
- /**
- * @param value
- * Unix timestamp received in a "deepen since" line
- * @return this builder
- */
- Builder setDeepenSince(int value) {
- deepenSince = value;
- return this;
- }
-
- /**
- * @return shallow since value, sent before in a "deepen since" line. 0
- * by default.
- */
- int getDeepenSince() {
- return deepenSince;
- }
-
- /**
- * @param filter
- * spec set in a "filter" line
- * @return this builder
- */
- Builder setFilterSpec(@NonNull FilterSpec filter) {
- filterSpec = requireNonNull(filter);
- return this;
- }
-
- /**
- * Mark that the "done" line has been received.
- *
- * @return this builder
- */
- Builder setDoneReceived() {
- doneReceived = true;
- 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 agentValue
- * the client-supplied agent capability, without the leading
- * "agent="
- * @return this builder
- */
- Builder setAgent(@Nullable String agentValue) {
- agent = agentValue;
- return this;
- }
-
- /**
- * Records an application-specific option supplied in a server-option
- * line, for later retrieval with
- * {@link FetchV2Request#getServerOptions}.
- *
- * @param value
- * the client-supplied server-option capability, without
- * leading "server-option=".
- * @return this builder
- */
- Builder addServerOption(@NonNull String value) {
- serverOptions.add(value);
- return this;
- }
-
- /**
- * @return Initialized fetch request
- */
- FetchV2Request build() {
- return new FetchV2Request(peerHas, wantedRefs, wantIds,
- clientShallowCommits, deepenSince, deepenNotRefs,
- depth, filterSpec, doneReceived, clientCapabilities,
- agent, Collections.unmodifiableList(serverOptions));
- }
- }
- }
|