From fa5e6f97aab0faca8e11ab8a264b0190c145b07f Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Fri, 04 Nov 2011 17:25:00 -0400 Subject: [PATCH] Documentation. --- src/com/gitblit/utils/RpcUtils.java | 81 +++++++++++++++++++++++++++++++++++++--- 1 files changed, 74 insertions(+), 7 deletions(-) diff --git a/src/com/gitblit/utils/RpcUtils.java b/src/com/gitblit/utils/RpcUtils.java index 440dabd..387433a 100644 --- a/src/com/gitblit/utils/RpcUtils.java +++ b/src/com/gitblit/utils/RpcUtils.java @@ -27,9 +27,10 @@ import com.gitblit.models.FederationModel; import com.gitblit.models.FederationProposal; import com.gitblit.models.FederationSet; +import com.gitblit.models.FeedModel; import com.gitblit.models.RepositoryModel; +import com.gitblit.models.ServerSettings; import com.gitblit.models.ServerStatus; -import com.gitblit.models.SettingModel; import com.gitblit.models.UserModel; import com.google.gson.reflect.TypeToken; @@ -42,6 +43,9 @@ public class RpcUtils { public static final Type NAMES_TYPE = new TypeToken<Collection<String>>() { + }.getType(); + + public static final Type SETTINGS_TYPE = new TypeToken<Map<String, String>>() { }.getType(); private static final Type REPOSITORIES_TYPE = new TypeToken<Map<String, RepositoryModel>>() { @@ -59,7 +63,7 @@ private static final Type SETS_TYPE = new TypeToken<Collection<FederationSet>>() { }.getType(); - private static final Type SETTINGS_TYPE = new TypeToken<Map<String, SettingModel>>() { + private static final Type BRANCHES_TYPE = new TypeToken<Map<String, Collection<String>>>() { }.getType(); /** @@ -142,6 +146,10 @@ */ public static boolean createRepository(RepositoryModel repository, String serverUrl, String account, char[] password) throws IOException { + // ensure repository name ends with .git + if (!repository.name.endsWith(".git")) { + repository.name += ".git"; + } return doAction(RpcRequest.CREATE_REPOSITORY, null, repository, serverUrl, account, password); @@ -341,15 +349,32 @@ * @param serverUrl * @param account * @param password - * @return an Map<String, SettingModel> object + * @return an Settings object * @throws IOException */ - public static Map<String, SettingModel> getSettings(String serverUrl, String account, - char[] password) throws IOException { + public static ServerSettings 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, + ServerSettings settings = JsonUtils.retrieveJson(url, ServerSettings.class, account, password); return settings; + } + + /** + * Update the settings on the Gitblit server. + * + * @param settings + * the settings to update + * @param serverUrl + * @param account + * @param password + * @return true if the action succeeded + * @throws IOException + */ + public static boolean updateSettings(Map<String, String> settings, String serverUrl, + String account, char[] password) throws IOException { + return doAction(RpcRequest.EDIT_SETTINGS, null, settings, serverUrl, account, password); + } /** @@ -363,12 +388,54 @@ */ public static ServerStatus getStatus(String serverUrl, String account, char[] password) throws IOException { - String url = asLink(serverUrl, RpcRequest.LIST_SERVER_STATUS); + String url = asLink(serverUrl, RpcRequest.LIST_STATUS); ServerStatus status = JsonUtils.retrieveJson(url, ServerStatus.class, account, password); return status; } /** + * Retrieves a map of local branches in the Gitblit server keyed by + * repository. + * + * @param serverUrl + * @param account + * @param password + * @return + * @throws IOException + */ + public static Map<String, Collection<String>> getBranches(String serverUrl, String account, + char[] password) throws IOException { + String url = asLink(serverUrl, RpcRequest.LIST_BRANCHES); + Map<String, Collection<String>> branches = JsonUtils.retrieveJson(url, BRANCHES_TYPE, + account, password); + return branches; + } + + /** + * Retrieves a list of available branch feeds in the Gitblit server. + * + * @param serverUrl + * @param account + * @param password + * @return + * @throws IOException + */ + public static List<FeedModel> getBranchFeeds(String serverUrl, String account, char[] password) + throws IOException { + List<FeedModel> feeds = new ArrayList<FeedModel>(); + Map<String, Collection<String>> allBranches = getBranches(serverUrl, account, password); + for (Map.Entry<String, Collection<String>> entry : allBranches.entrySet()) { + for (String branch : entry.getValue()) { + FeedModel feed = new FeedModel(); + feed.repository = entry.getKey(); + feed.branch = branch; + feeds.add(feed); + } + } + return feeds; + } + + /** * Do the specified administrative action on the Gitblit server. * * @param request -- Gitblit v1.9.1