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
|
/*
* Copyright (C) 2010, Google Inc.
* Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
* Copyright (C) 2007-2009, Robin Rosenberg <robin.rosenberg@dewire.com>
* Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
* 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 java.util.Collection;
import java.util.Collections;
import java.util.Map;
import java.util.SortedMap;
import java.util.TreeMap;
import org.eclipse.jgit.lib.Ref;
/**
* Class holding result of operation on remote repository. This includes refs
* advertised by remote repo and local tracking refs updates.
*/
public abstract class OperationResult {
Map<String, Ref> advertisedRefs = Collections.emptyMap();
URIish uri;
final SortedMap<String, TrackingRefUpdate> updates = new TreeMap<>();
StringBuilder messageBuffer;
String peerUserAgent;
/**
* Get the URI this result came from.
* <p>
* Each transport instance connects to at most one URI at any point in time.
*
* @return the URI describing the location of the remote repository.
*/
public URIish getURI() {
return uri;
}
/**
* Get the complete list of refs advertised by the remote.
* <p>
* The returned refs may appear in any order. If the caller needs these to
* be sorted, they should be copied into a new array or List and then sorted
* by the caller as necessary.
*
* @return available/advertised refs. Never null. Not modifiable. The
* collection can be empty if the remote side has no refs (it is an
* empty/newly created repository).
*/
public Collection<Ref> getAdvertisedRefs() {
return Collections.unmodifiableCollection(advertisedRefs.values());
}
/**
* Get a single advertised ref by name.
* <p>
* The name supplied should be valid ref name. To get a peeled value for a
* ref (aka <code>refs/tags/v1.0^{}</code>) use the base name (without
* the <code>^{}</code> suffix) and look at the peeled object id.
*
* @param name
* name of the ref to obtain.
* @return the requested ref; null if the remote did not advertise this ref.
*/
public final Ref getAdvertisedRef(final String name) {
return advertisedRefs.get(name);
}
/**
* Get the status of all local tracking refs that were updated.
*
* @return unmodifiable collection of local updates. Never null. Empty if
* there were no local tracking refs updated.
*/
public Collection<TrackingRefUpdate> getTrackingRefUpdates() {
return Collections.unmodifiableCollection(updates.values());
}
/**
* Get the status for a specific local tracking ref update.
*
* @param localName
* name of the local ref (e.g. "refs/remotes/origin/master").
* @return status of the local ref; null if this local ref was not touched
* during this operation.
*/
public TrackingRefUpdate getTrackingRefUpdate(final String localName) {
return updates.get(localName);
}
void setAdvertisedRefs(final URIish u, final Map<String, Ref> ar) {
uri = u;
advertisedRefs = ar;
}
void add(final TrackingRefUpdate u) {
updates.put(u.getLocalName(), u);
}
/**
* Get the additional messages, if any, returned by the remote process.
* <p>
* These messages are most likely informational or error messages, sent by
* the remote peer, to help the end-user correct any problems that may have
* prevented the operation from completing successfully. Application UIs
* should try to show these in an appropriate context.
*
* @return the messages returned by the remote, most likely terminated by a
* newline (LF) character. The empty string is returned if the
* remote produced no additional messages.
*/
public String getMessages() {
return messageBuffer != null ? messageBuffer.toString() : ""; //$NON-NLS-1$
}
void addMessages(final String msg) {
if (msg != null && msg.length() > 0) {
if (messageBuffer == null)
messageBuffer = new StringBuilder();
messageBuffer.append(msg);
if (!msg.endsWith("\n")) //$NON-NLS-1$
messageBuffer.append('\n');
}
}
/**
* Get the user agent advertised by the peer server, if available.
*
* @return advertised user agent, e.g. {@code "JGit/4.0"}. Null if the peer
* did not advertise version information.
* @since 4.0
*/
public String getPeerUserAgent() {
return peerUserAgent;
}
}
|
