From edeab95cac16e5f17cfcd75a9969d8708bf360ab Mon Sep 17 00:00:00 2001
From: James Moger <james.moger@gitblit.com>
Date: Mon, 12 May 2014 09:22:04 -0400
Subject: [PATCH] Documentation
---
src/main/java/com/gitblit/Constants.java | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++---
1 files changed, 53 insertions(+), 3 deletions(-)
diff --git a/src/main/java/com/gitblit/Constants.java b/src/main/java/com/gitblit/Constants.java
index 2a98b53..95eb944 100644
--- a/src/main/java/com/gitblit/Constants.java
+++ b/src/main/java/com/gitblit/Constants.java
@@ -68,6 +68,8 @@
public static final String SPARKLESHARE_INVITE_PATH = "/sparkleshare/";
+ public static final String RAW_PATH = "/raw/";
+
public static final String BRANCH_GRAPH_PATH = "/graph/";
public static final String BORDER = "*****************************************************************";
@@ -348,9 +350,10 @@
* a client.
*/
public static enum RpcRequest {
- // Order is important here. anything above LIST_SETTINGS requires
+ // Order is important here. anything after LIST_SETTINGS requires
// administrator privileges and web.allowRpcManagement.
- CLEAR_REPOSITORY_CACHE, REINDEX_TICKETS, GET_PROTOCOL, LIST_REPOSITORIES, LIST_BRANCHES, GET_USER, LIST_SETTINGS,
+ CLEAR_REPOSITORY_CACHE, REINDEX_TICKETS, GET_PROTOCOL, LIST_REPOSITORIES, LIST_BRANCHES, GET_USER,
+ FORK_REPOSITORY, LIST_SETTINGS,
CREATE_REPOSITORY, EDIT_REPOSITORY, DELETE_REPOSITORY,
LIST_USERS, CREATE_USER, EDIT_USER, DELETE_USER,
LIST_TEAMS, CREATE_TEAM, EDIT_TEAM, DELETE_TEAM,
@@ -400,6 +403,27 @@
}
/**
+ * Enumeration of the feed content object types.
+ */
+ public static enum FeedObjectType {
+ COMMIT, TAG;
+
+ public static FeedObjectType forName(String name) {
+ for (FeedObjectType type : values()) {
+ if (type.name().equalsIgnoreCase(name)) {
+ return type;
+ }
+ }
+ return COMMIT;
+ }
+
+ @Override
+ public String toString() {
+ return name().toLowerCase();
+ }
+ }
+
+ /**
* The types of objects that can be indexed and queried.
*/
public static enum SearchObjectType {
@@ -422,6 +446,8 @@
NONE("N"), EXCLUDE("X"), VIEW("V"), CLONE("R"), PUSH("RW"), CREATE("RWC"), DELETE("RWD"), REWIND("RW+"), OWNER("RW+");
public static final AccessPermission [] NEWPERMISSIONS = { EXCLUDE, VIEW, CLONE, PUSH, CREATE, DELETE, REWIND };
+
+ public static final AccessPermission [] SSHPERMISSIONS = { VIEW, CLONE, PUSH };
public static AccessPermission LEGACY = REWIND;
@@ -501,7 +527,7 @@
}
public static enum AuthenticationType {
- CREDENTIALS, COOKIE, CERTIFICATE, CONTAINER;
+ PUBLIC_KEY, CREDENTIALS, COOKIE, CERTIFICATE, CONTAINER;
public boolean isStandard() {
return ordinal() <= COOKIE.ordinal();
@@ -538,6 +564,30 @@
}
}
+ public static enum Transport {
+ // ordered for url advertisements, assuming equal access permissions
+ SSH, HTTPS, HTTP, GIT;
+
+ public static Transport fromString(String value) {
+ for (Transport t : values()) {
+ if (t.name().equalsIgnoreCase(value)) {
+ return t;
+ }
+ }
+ return null;
+ }
+
+ public static Transport fromUrl(String url) {
+ int delim = url.indexOf("://");
+ if (delim == -1) {
+ // if no protocol is specified, SSH is assumed by git clients
+ return SSH;
+ }
+ String scheme = url.substring(0, delim);
+ return fromString(scheme);
+ }
+ }
+
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Unused {
--
Gitblit v1.9.1