James Moger
2011-10-21 b75734f0600c333d70a3659af82be54caf3cfd3e
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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
/*
 * Copyright 2011 gitblit.com.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.gitblit.utils;
 
import java.io.IOException;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
 
import com.gitblit.Constants;
import com.gitblit.Constants.RpcRequest;
import com.gitblit.models.FederationModel;
import com.gitblit.models.FederationProposal;
import com.gitblit.models.FederationSet;
import com.gitblit.models.RepositoryModel;
import com.gitblit.models.ServerStatus;
import com.gitblit.models.SettingModel;
import com.gitblit.models.UserModel;
import com.google.gson.reflect.TypeToken;
 
/**
 * Utility methods for rpc calls.
 * 
 * @author James Moger
 * 
 */
public class RpcUtils {
 
    public static final Type NAMES_TYPE = new TypeToken<Collection<String>>() {
    }.getType();
 
    private static final Type REPOSITORIES_TYPE = new TypeToken<Map<String, RepositoryModel>>() {
    }.getType();
 
    private static final Type USERS_TYPE = new TypeToken<Collection<UserModel>>() {
    }.getType();
 
    private static final Type REGISTRATIONS_TYPE = new TypeToken<Collection<FederationModel>>() {
    }.getType();
 
    private static final Type PROPOSALS_TYPE = new TypeToken<Collection<FederationProposal>>() {
    }.getType();
 
    private static final Type SETS_TYPE = new TypeToken<Collection<FederationSet>>() {
    }.getType();
 
    private static final Type SETTINGS_TYPE = new TypeToken<Map<String, SettingModel>>() {
    }.getType();
 
    /**
     * 
     * @param remoteURL
     *            the url of the remote gitblit instance
     * @param req
     *            the rpc request type
     * @return
     */
    public static String asLink(String remoteURL, RpcRequest req) {
        return asLink(remoteURL, req, null);
    }
 
    /**
     * 
     * @param remoteURL
     *            the url of the remote gitblit instance
     * @param req
     *            the rpc request type
     * @param name
     *            the name of the actionable object
     * @return
     */
    public static String asLink(String remoteURL, RpcRequest req, String name) {
        if (remoteURL.length() > 0 && remoteURL.charAt(remoteURL.length() - 1) == '/') {
            remoteURL = remoteURL.substring(0, remoteURL.length() - 1);
        }
        if (req == null) {
            req = RpcRequest.LIST_REPOSITORIES;
        }
        return remoteURL + Constants.RPC_PATH + "?req=" + req.name().toLowerCase()
                + (name == null ? "" : ("&name=" + name));
    }
 
    /**
     * Retrieves a map of the repositories at the remote gitblit instance keyed
     * by the repository clone url.
     * 
     * @param serverUrl
     * @param account
     * @param password
     * @return a map of cloneable repositories
     * @throws IOException
     */
    public static Map<String, RepositoryModel> getRepositories(String serverUrl, String account,
            char[] password) throws IOException {
        String url = asLink(serverUrl, RpcRequest.LIST_REPOSITORIES);
        Map<String, RepositoryModel> models = JsonUtils.retrieveJson(url, REPOSITORIES_TYPE,
                account, password);
        return models;
    }
 
    /**
     * Tries to pull the gitblit user accounts from the remote gitblit instance.
     * 
     * @param serverUrl
     * @param account
     * @param password
     * @return a collection of UserModel objects
     * @throws IOException
     */
    public static List<UserModel> getUsers(String serverUrl, String account, char[] password)
            throws IOException {
        String url = asLink(serverUrl, RpcRequest.LIST_USERS);
        Collection<UserModel> models = JsonUtils.retrieveJson(url, USERS_TYPE, account, password);
        List<UserModel> list = new ArrayList<UserModel>(models);
        return list;
    }
 
    /**
     * Create a repository on the Gitblit server.
     * 
     * @param repository
     * @param serverUrl
     * @param account
     * @param password
     * @return true if the action succeeded
     * @throws IOException
     */
    public static boolean createRepository(RepositoryModel repository, String serverUrl,
            String account, char[] password) throws IOException {
        return doAction(RpcRequest.CREATE_REPOSITORY, null, repository, serverUrl, account,
                password);
 
    }
 
    /**
     * Send a revised version of the repository model to the Gitblit server.
     * 
     * @param repository
     * @param serverUrl
     * @param account
     * @param password
     * @return true if the action succeeded
     * @throws IOException
     */
    public static boolean updateRepository(String repositoryName, RepositoryModel repository,
            String serverUrl, String account, char[] password) throws IOException {
        return doAction(RpcRequest.EDIT_REPOSITORY, repositoryName, repository, serverUrl, account,
                password);
    }
 
    /**
     * Delete a repository from the Gitblit server.
     * 
     * @param repository
     * @param serverUrl
     * @param account
     * @param password
     * @return true if the action succeeded
     * @throws IOException
     */
    public static boolean deleteRepository(RepositoryModel repository, String serverUrl,
            String account, char[] password) throws IOException {
        return doAction(RpcRequest.DELETE_REPOSITORY, null, repository, serverUrl, account,
                password);
 
    }
 
    /**
     * Create a user on the Gitblit server.
     * 
     * @param user
     * @param serverUrl
     * @param account
     * @param password
     * @return true if the action succeeded
     * @throws IOException
     */
    public static boolean createUser(UserModel user, String serverUrl, String account,
            char[] password) throws IOException {
        return doAction(RpcRequest.CREATE_USER, null, user, serverUrl, account, password);
 
    }
 
    /**
     * Send a revised version of the user model to the Gitblit server.
     * 
     * @param user
     * @param serverUrl
     * @param account
     * @param password
     * @return true if the action succeeded
     * @throws IOException
     */
    public static boolean updateUser(String username, UserModel user, String serverUrl,
            String account, char[] password) throws IOException {
        return doAction(RpcRequest.EDIT_USER, username, user, serverUrl, account, password);
 
    }
 
    /**
     * Deletes a user from the Gitblit server.
     * 
     * @param user
     * @param serverUrl
     * @param account
     * @param password
     * @return true if the action succeeded
     * @throws IOException
     */
    public static boolean deleteUser(UserModel user, String serverUrl, String account,
            char[] password) throws IOException {
        return doAction(RpcRequest.DELETE_USER, null, user, serverUrl, account, password);
    }
 
    /**
     * Retrieves the list of users that can access the specified repository.
     * 
     * @param repository
     * @param serverUrl
     * @param account
     * @param password
     * @return list of members
     * @throws IOException
     */
    public static List<String> getRepositoryMembers(RepositoryModel repository, String serverUrl,
            String account, char[] password) throws IOException {
        String url = asLink(serverUrl, RpcRequest.LIST_REPOSITORY_MEMBERS, repository.name);
        Collection<String> list = JsonUtils.retrieveJson(url, NAMES_TYPE, account, password);
        return new ArrayList<String>(list);
    }
 
    /**
     * Sets the repository membership list.
     * 
     * @param repository
     * @param memberships
     * @param serverUrl
     * @param account
     * @param password
     * @return true if the action succeeded
     * @throws IOException
     */
    public static boolean setRepositoryMembers(RepositoryModel repository,
            List<String> memberships, String serverUrl, String account, char[] password)
            throws IOException {
        return doAction(RpcRequest.SET_REPOSITORY_MEMBERS, repository.name, memberships, serverUrl,
                account, password);
    }
 
    /**
     * Retrieves the list of federation registrations. These are the list of
     * registrations that this Gitblit instance is pulling from.
     * 
     * @param serverUrl
     * @param account
     * @param password
     * @return a collection of FederationRegistration objects
     * @throws IOException
     */
    public static List<FederationModel> getFederationRegistrations(String serverUrl,
            String account, char[] password) throws IOException {
        String url = asLink(serverUrl, RpcRequest.LIST_FEDERATION_REGISTRATIONS);
        Collection<FederationModel> registrations = JsonUtils.retrieveJson(url, REGISTRATIONS_TYPE,
                account, password);
        List<FederationModel> list = new ArrayList<FederationModel>(registrations);
        return list;
    }
 
    /**
     * Retrieves the list of federation result registrations. These are the
     * results reported back to this Gitblit instance from a federation client.
     * 
     * @param serverUrl
     * @param account
     * @param password
     * @return a collection of FederationRegistration objects
     * @throws IOException
     */
    public static List<FederationModel> getFederationResultRegistrations(String serverUrl,
            String account, char[] password) throws IOException {
        String url = asLink(serverUrl, RpcRequest.LIST_FEDERATION_RESULTS);
        Collection<FederationModel> registrations = JsonUtils.retrieveJson(url, REGISTRATIONS_TYPE,
                account, password);
        List<FederationModel> list = new ArrayList<FederationModel>(registrations);
        return list;
    }
 
    /**
     * Retrieves the list of federation proposals.
     * 
     * @param serverUrl
     * @param account
     * @param password
     * @return a collection of FederationProposal objects
     * @throws IOException
     */
    public static List<FederationProposal> getFederationProposals(String serverUrl, String account,
            char[] password) throws IOException {
        String url = asLink(serverUrl, RpcRequest.LIST_FEDERATION_PROPOSALS);
        Collection<FederationProposal> proposals = JsonUtils.retrieveJson(url, PROPOSALS_TYPE,
                account, password);
        List<FederationProposal> list = new ArrayList<FederationProposal>(proposals);
        return list;
    }
 
    /**
     * Retrieves the list of federation repository sets.
     * 
     * @param serverUrl
     * @param account
     * @param password
     * @return a collection of FederationSet objects
     * @throws IOException
     */
    public static List<FederationSet> getFederationSets(String serverUrl, String account,
            char[] password) throws IOException {
        String url = asLink(serverUrl, RpcRequest.LIST_FEDERATION_SETS);
        Collection<FederationSet> sets = JsonUtils.retrieveJson(url, SETS_TYPE, account, password);
        List<FederationSet> list = new ArrayList<FederationSet>(sets);
        return list;
    }
 
    /**
     * Retrieves the settings of the Gitblit server.
     * 
     * @param serverUrl
     * @param account
     * @param password
     * @return an Map<String, SettingModel> object
     * @throws IOException
     */
    public static Map<String, SettingModel> getSettings(String serverUrl, String account,
            char[] password) throws IOException {
        String url = asLink(serverUrl, RpcRequest.LIST_SETTINGS);
        Map<String, SettingModel> settings = JsonUtils.retrieveJson(url, SETTINGS_TYPE, account,
                password);
        return settings;
    }
 
    /**
     * Retrieves the server status object.
     * 
     * @param serverUrl
     * @param account
     * @param password
     * @return an ServerStatus object
     * @throws IOException
     */
    public static ServerStatus getStatus(String serverUrl, String account, char[] password)
            throws IOException {
        String url = asLink(serverUrl, RpcRequest.LIST_SERVER_STATUS);
        ServerStatus status = JsonUtils.retrieveJson(url, ServerStatus.class, account, password);
        return status;
    }
 
    /**
     * Do the specified administrative action on the Gitblit server.
     * 
     * @param request
     * @param name
     *            the name of the object (may be null)
     * @param object
     * @param serverUrl
     * @param account
     * @param password
     * @return true if the action succeeded
     * @throws IOException
     */
    protected static boolean doAction(RpcRequest request, String name, Object object,
            String serverUrl, String account, char[] password) throws IOException {
        String url = asLink(serverUrl, request, name);
        String json = JsonUtils.toJsonString(object);
        int resultCode = JsonUtils.sendJsonString(url, json, account, password);
        return resultCode == 200;
    }
}