1 /*
2 * Copyright (C) 2011, GitHub Inc.
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.api;
44
45 import org.eclipse.jgit.lib.Repository;
46 import org.eclipse.jgit.transport.CredentialsProvider;
47 import org.eclipse.jgit.transport.Transport;
48
49 /**
50 * Base class for commands that use a
51 * {@link org.eclipse.jgit.transport.Transport} during execution.
52 * <p>
53 * This class provides standard configuration of a transport for options such as
54 * a {@link org.eclipse.jgit.transport.CredentialsProvider}, a timeout, and a
55 * {@link org.eclipse.jgit.api.TransportConfigCallback}.
56 *
57 * @param <C>
58 * @param <T>
59 */
60 public abstract class TransportCommand<C extends GitCommand, T> extends
61 GitCommand<T> {
62
63 /**
64 * Configured credentials provider
65 */
66 protected CredentialsProvider credentialsProvider;
67
68 /**
69 * Configured transport timeout
70 */
71 protected int timeout;
72
73 /**
74 * Configured callback for transport configuration
75 */
76 protected TransportConfigCallback transportConfigCallback;
77
78 /**
79 * <p>Constructor for TransportCommand.</p>
80 *
81 * @param repo a {@link org.eclipse.jgit.lib.Repository} object.
82 */
83 protected TransportCommand(Repository repo) {
84 super(repo);
85 setCredentialsProvider(CredentialsProvider.getDefault());
86 }
87
88 /**
89 * Set the <code>credentialsProvider</code>.
90 *
91 * @param credentialsProvider
92 * the {@link org.eclipse.jgit.transport.CredentialsProvider} to
93 * use
94 * @return {@code this}
95 */
96 public C setCredentialsProvider(
97 final CredentialsProvider credentialsProvider) {
98 this.credentialsProvider = credentialsProvider;
99 return self();
100 }
101
102 /**
103 * Set <code>timeout</code>.
104 *
105 * @param timeout
106 * the timeout (in seconds) used for the transport step
107 * @return {@code this}
108 */
109 public C setTimeout(int timeout) {
110 this.timeout = timeout;
111 return self();
112 }
113
114 /**
115 * Set the <code>TransportConfigCallback</code>.
116 *
117 * @param transportConfigCallback
118 * if set, the callback will be invoked after the
119 * {@link org.eclipse.jgit.transport.Transport} has created, but
120 * before the {@link org.eclipse.jgit.transport.Transport} is
121 * used. The callback can use this opportunity to set additional
122 * type-specific configuration on the
123 * {@link org.eclipse.jgit.transport.Transport} instance.
124 * @return {@code this}
125 */
126 public C setTransportConfigCallback(
127 final TransportConfigCallback transportConfigCallback) {
128 this.transportConfigCallback = transportConfigCallback;
129 return self();
130 }
131
132 /**
133 * Return this command cast to {@code C}
134 *
135 * @return {@code this} cast to {@code C}
136 */
137 @SuppressWarnings("unchecked")
138 protected final C self() {
139 return (C) this;
140 }
141
142 /**
143 * Configure transport with credentials provider, timeout, and config
144 * callback
145 *
146 * @param transport
147 * a {@link org.eclipse.jgit.transport.Transport} object.
148 * @return {@code this}
149 */
150 protected C configure(Transport transport) {
151 if (credentialsProvider != null)
152 transport.setCredentialsProvider(credentialsProvider);
153 transport.setTimeout(timeout);
154 if (transportConfigCallback != null)
155 transportConfigCallback.configure(transport);
156 return self();
157 }
158
159 /**
160 * Configure a child command with the current configuration set in
161 * {@code this} command
162 *
163 * @param childCommand
164 * a {@link org.eclipse.jgit.api.TransportCommand} object.
165 * @return {@code this}
166 */
167 protected C configure(TransportCommand childCommand) {
168 childCommand.setCredentialsProvider(credentialsProvider);
169 childCommand.setTimeout(timeout);
170 childCommand.setTransportConfigCallback(transportConfigCallback);
171 return self();
172 }
173 }