1 /*
2 * Copyright (C) 2010, Google Inc.
3 * Copyright (C) 2008, Marek Zawirski <marek.zawirski@gmail.com>
4 * Copyright (C) 2008, Robin Rosenberg <robin.rosenberg@dewire.com>
5 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
6 * and other copyright owners as documented in the project's IP log.
7 *
8 * This program and the accompanying materials are made available
9 * under the terms of the Eclipse Distribution License v1.0 which
10 * accompanies this distribution, is reproduced below, and is
11 * available at http://www.eclipse.org/org/documents/edl-v10.php
12 *
13 * All rights reserved.
14 *
15 * Redistribution and use in source and binary forms, with or
16 * without modification, are permitted provided that the following
17 * conditions are met:
18 *
19 * - Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 *
22 * - Redistributions in binary form must reproduce the above
23 * copyright notice, this list of conditions and the following
24 * disclaimer in the documentation and/or other materials provided
25 * with the distribution.
26 *
27 * - Neither the name of the Eclipse Foundation, Inc. nor the
28 * names of its contributors may be used to endorse or promote
29 * products derived from this software without specific prior
30 * written permission.
31 *
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
33 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
34 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
36 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
37 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
39 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
40 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
41 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
42 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
43 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
44 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45 */
46
47 package org.eclipse.jgit.transport;
48
49 import java.io.StringWriter;
50 import java.io.Writer;
51 import java.util.Collection;
52 import java.util.Collections;
53 import java.util.Map;
54
55 import org.eclipse.jgit.errors.TransportException;
56 import org.eclipse.jgit.internal.JGitText;
57 import org.eclipse.jgit.lib.Ref;
58
59 /**
60 * Base helper class for implementing operations connections.
61 *
62 * @see BasePackConnection
63 * @see BaseFetchConnection
64 */
65 public abstract class BaseConnection implements Connection {
66 private Map<String, Ref> advertisedRefs = Collections.emptyMap();
67
68 private String peerUserAgent;
69
70 private boolean startedOperation;
71
72 private Writer messageWriter;
73
74 /** {@inheritDoc} */
75 @Override
76 public Map<String, Ref> getRefsMap() {
77 return advertisedRefs;
78 }
79
80 /** {@inheritDoc} */
81 @Override
82 public final Collection<Ref> getRefs() {
83 return advertisedRefs.values();
84 }
85
86 /** {@inheritDoc} */
87 @Override
88 public final Ref getRef(String name) {
89 return advertisedRefs.get(name);
90 }
91
92 /** {@inheritDoc} */
93 @Override
94 public String getMessages() {
95 return messageWriter != null ? messageWriter.toString() : ""; //$NON-NLS-1$
96 }
97
98 /**
99 * {@inheritDoc}
100 *
101 * User agent advertised by the remote server.
102 * @since 4.0
103 */
104 @Override
105 public String getPeerUserAgent() {
106 return peerUserAgent;
107 }
108
109 /**
110 * Remember the remote peer's agent.
111 *
112 * @param agent
113 * remote peer agent string.
114 * @since 4.0
115 */
116 protected void setPeerUserAgent(String agent) {
117 peerUserAgent = agent;
118 }
119
120 /** {@inheritDoc} */
121 @Override
122 public abstract void close();
123
124 /**
125 * Denote the list of refs available on the remote repository.
126 * <p>
127 * Implementors should invoke this method once they have obtained the refs
128 * that are available from the remote repository.
129 *
130 * @param all
131 * the complete list of refs the remote has to offer. This map
132 * will be wrapped in an unmodifiable way to protect it, but it
133 * does not get copied.
134 */
135 protected void available(Map<String, Ref> all) {
136 advertisedRefs = Collections.unmodifiableMap(all);
137 }
138
139 /**
140 * Helper method for ensuring one-operation per connection. Check whether
141 * operation was already marked as started, and mark it as started.
142 *
143 * @throws org.eclipse.jgit.errors.TransportException
144 * if operation was already marked as started.
145 */
146 protected void markStartedOperation() throws TransportException {
147 if (startedOperation)
148 throw new TransportException(
149 JGitText.get().onlyOneOperationCallPerConnectionIsSupported);
150 startedOperation = true;
151 }
152
153 /**
154 * Get the writer that buffers messages from the remote side.
155 *
156 * @return writer to store messages from the remote.
157 */
158 protected Writer getMessageWriter() {
159 if (messageWriter == null)
160 setMessageWriter(new StringWriter());
161 return messageWriter;
162 }
163
164 /**
165 * Set the writer that buffers messages from the remote side.
166 *
167 * @param writer
168 * the writer that messages will be delivered to. The writer's
169 * {@code toString()} method should be overridden to return the
170 * complete contents.
171 */
172 protected void setMessageWriter(Writer writer) {
173 if (messageWriter != null)
174 throw new IllegalStateException(JGitText.get().writerAlreadyInitialized);
175 messageWriter = writer;
176 }
177 }