blob: 30f1bc9cc6915d8d3374d77493dddc6fd7a00f33 (
plain)
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
|
/*
* Copyright (C) 2011, GitHub Inc. 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.api;
import org.eclipse.jgit.lib.Repository;
import org.eclipse.jgit.transport.CredentialsProvider;
import org.eclipse.jgit.transport.Transport;
/**
* Base class for commands that use a
* {@link org.eclipse.jgit.transport.Transport} during execution.
* <p>
* This class provides standard configuration of a transport for options such as
* a {@link org.eclipse.jgit.transport.CredentialsProvider}, a timeout, and a
* {@link org.eclipse.jgit.api.TransportConfigCallback}.
*
* @param <C>
* concrete type of this {@code GitCommand}
* @param <T>
* the return type of the {@code GitCommand}'s {@code call()} method
*/
public abstract class TransportCommand<C extends GitCommand, T> extends
GitCommand<T> {
/**
* Configured credentials provider
*/
protected CredentialsProvider credentialsProvider;
/**
* Configured transport timeout
*/
protected int timeout;
/**
* Configured callback for transport configuration
*/
protected TransportConfigCallback transportConfigCallback;
/**
* <p>Constructor for TransportCommand.</p>
*
* @param repo a {@link org.eclipse.jgit.lib.Repository} object.
*/
protected TransportCommand(Repository repo) {
super(repo);
setCredentialsProvider(CredentialsProvider.getDefault());
}
/**
* Set the <code>credentialsProvider</code>.
*
* @param credentialsProvider
* the {@link org.eclipse.jgit.transport.CredentialsProvider} to
* use
* @return {@code this}
*/
public C setCredentialsProvider(
final CredentialsProvider credentialsProvider) {
this.credentialsProvider = credentialsProvider;
return self();
}
/**
* Set <code>timeout</code>.
*
* @param timeout
* the timeout (in seconds) used for the transport step
* @return {@code this}
*/
public C setTimeout(int timeout) {
this.timeout = timeout;
return self();
}
/**
* Set the <code>TransportConfigCallback</code>.
*
* @param transportConfigCallback
* if set, the callback will be invoked after the
* {@link org.eclipse.jgit.transport.Transport} has created, but
* before the {@link org.eclipse.jgit.transport.Transport} is
* used. The callback can use this opportunity to set additional
* type-specific configuration on the
* {@link org.eclipse.jgit.transport.Transport} instance.
* @return {@code this}
*/
public C setTransportConfigCallback(
final TransportConfigCallback transportConfigCallback) {
this.transportConfigCallback = transportConfigCallback;
return self();
}
/**
* Return this command cast to {@code C}
*
* @return {@code this} cast to {@code C}
*/
@SuppressWarnings("unchecked")
protected final C self() {
return (C) this;
}
/**
* Configure transport with credentials provider, timeout, and config
* callback
*
* @param transport
* a {@link org.eclipse.jgit.transport.Transport} object.
* @return {@code this}
*/
protected C configure(Transport transport) {
if (credentialsProvider != null)
transport.setCredentialsProvider(credentialsProvider);
transport.setTimeout(timeout);
if (transportConfigCallback != null)
transportConfigCallback.configure(transport);
return self();
}
/**
* Configure a child command with the current configuration set in
* {@code this} command
*
* @param childCommand
* a {@link org.eclipse.jgit.api.TransportCommand} object.
* @return {@code this}
*/
protected C configure(TransportCommand childCommand) {
childCommand.setCredentialsProvider(credentialsProvider);
childCommand.setTimeout(timeout);
childCommand.setTransportConfigCallback(transportConfigCallback);
return self();
}
}
|
