/* * 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>() { }.getType(); private static final Type REPOSITORIES_TYPE = new TypeToken>() { }.getType(); private static final Type USERS_TYPE = new TypeToken>() { }.getType(); private static final Type REGISTRATIONS_TYPE = new TypeToken>() { }.getType(); private static final Type PROPOSALS_TYPE = new TypeToken>() { }.getType(); private static final Type SETS_TYPE = new TypeToken>() { }.getType(); private static final Type SETTINGS_TYPE = new TypeToken>() { }.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 getRepositories(String serverUrl, String account, char[] password) throws IOException { String url = asLink(serverUrl, RpcRequest.LIST_REPOSITORIES); Map 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 getUsers(String serverUrl, String account, char[] password) throws IOException { String url = asLink(serverUrl, RpcRequest.LIST_USERS); Collection models = JsonUtils.retrieveJson(url, USERS_TYPE, account, password); List list = new ArrayList(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 getRepositoryMembers(RepositoryModel repository, String serverUrl, String account, char[] password) throws IOException { String url = asLink(serverUrl, RpcRequest.LIST_REPOSITORY_MEMBERS, repository.name); Collection list = JsonUtils.retrieveJson(url, NAMES_TYPE, account, password); return new ArrayList(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 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 getFederationRegistrations(String serverUrl, String account, char[] password) throws IOException { String url = asLink(serverUrl, RpcRequest.LIST_FEDERATION_REGISTRATIONS); Collection registrations = JsonUtils.retrieveJson(url, REGISTRATIONS_TYPE, account, password); List list = new ArrayList(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 getFederationResultRegistrations(String serverUrl, String account, char[] password) throws IOException { String url = asLink(serverUrl, RpcRequest.LIST_FEDERATION_RESULTS); Collection registrations = JsonUtils.retrieveJson(url, REGISTRATIONS_TYPE, account, password); List list = new ArrayList(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 getFederationProposals(String serverUrl, String account, char[] password) throws IOException { String url = asLink(serverUrl, RpcRequest.LIST_FEDERATION_PROPOSALS); Collection proposals = JsonUtils.retrieveJson(url, PROPOSALS_TYPE, account, password); List list = new ArrayList(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 getFederationSets(String serverUrl, String account, char[] password) throws IOException { String url = asLink(serverUrl, RpcRequest.LIST_FEDERATION_SETS); Collection sets = JsonUtils.retrieveJson(url, SETS_TYPE, account, password); List list = new ArrayList(sets); return list; } /** * Retrieves the settings of the Gitblit server. * * @param serverUrl * @param account * @param password * @return an Map object * @throws IOException */ public static Map getSettings(String serverUrl, String account, char[] password) throws IOException { String url = asLink(serverUrl, RpcRequest.LIST_SETTINGS); Map 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; } }