Mods to support requestUrl and requestQuesyString properties (#238).

gmessner · gmessner · commit 97b50e81e119 · 2018-08-18T22:16:16.000-07:00
diff --git a/src/main/java/org/gitlab4j/api/systemhooks/AbstractSystemHookEvent.java b/src/main/java/org/gitlab4j/api/systemhooks/AbstractSystemHookEvent.java
@@ -0,0 +1,31 @@
+package org.gitlab4j.api.systemhooks;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+
+public abstract class AbstractSystemHookEvent implements SystemHookEvent {
+
+    private String requestUrl;
+    private String requestQuesryString;
+
+    @Override
+    public void setRequestUrl(String requestUrl) {
+        this.requestUrl = requestUrl;
+    }
+
+    @Override
+    @JsonIgnore
+    public String getRequestUrl() {
+        return (requestUrl);
+    }
+
+    @Override
+    public void setRequestQueryString(String requestQuesryString) {
+        this.requestQuesryString = requestQuesryString;
+    }
+
+    @Override
+    @JsonIgnore
+    public String getRequestQueryString() {
+        return (requestQuesryString);
+    }
+}
diff --git a/src/main/java/org/gitlab4j/api/systemhooks/GroupMemberSystemHookEvent.java b/src/main/java/org/gitlab4j/api/systemhooks/GroupMemberSystemHookEvent.java
@@ -8,11 +8,11 @@
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
-public class GroupMemberSystemHookEvent implements SystemHookEvent {
-    
+public class GroupMemberSystemHookEvent extends AbstractSystemHookEvent {
+
     public static final String NEW_GROUP_MEMBER_EVENT = "user_add_to_group";
     public static final String GROUP_MEMBER_REMOVED_EVENT = "user_remove_from_group";
-    
+
     private Date createdAt;
     private Date updatedAt;
     private String eventName;
diff --git a/src/main/java/org/gitlab4j/api/systemhooks/GroupSystemHookEvent.java b/src/main/java/org/gitlab4j/api/systemhooks/GroupSystemHookEvent.java
@@ -8,7 +8,7 @@
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
-public class GroupSystemHookEvent implements SystemHookEvent {
+public class GroupSystemHookEvent extends AbstractSystemHookEvent {
     
     public static final String GROUP_CREATE_EVENT = "group_create";
     public static final String GROUP_DESTROY_EVENT = "group_destroy";
@@ -26,7 +26,6 @@ public class GroupSystemHookEvent implements SystemHookEvent {
     private String oldPath;
     private String oldFullPath;
 
-
     public Date getCreatedAt() {
         return createdAt;
     }
diff --git a/src/main/java/org/gitlab4j/api/systemhooks/KeySystemHookEvent.java b/src/main/java/org/gitlab4j/api/systemhooks/KeySystemHookEvent.java
@@ -8,7 +8,7 @@
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
-public class KeySystemHookEvent implements SystemHookEvent {
+public class KeySystemHookEvent extends AbstractSystemHookEvent {
     
     public static final String KEY_CREATE_EVENT = "key_create";
     public static final String KEY_DESTROY_EVENT = "key_destroy";
diff --git a/src/main/java/org/gitlab4j/api/systemhooks/ProjectSystemHookEvent.java b/src/main/java/org/gitlab4j/api/systemhooks/ProjectSystemHookEvent.java
@@ -10,7 +10,7 @@
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
-public class ProjectSystemHookEvent implements SystemHookEvent {
+public class ProjectSystemHookEvent extends AbstractSystemHookEvent {
     
     public static final String PROJECT_CREATE_EVENT = "project_create";
     public static final String PROJECT_DESTROY_EVENT = "project_destroy";
diff --git a/src/main/java/org/gitlab4j/api/systemhooks/RepositorySystemHookEvent.java b/src/main/java/org/gitlab4j/api/systemhooks/RepositorySystemHookEvent.java
@@ -10,7 +10,7 @@
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
-public class RepositorySystemHookEvent implements SystemHookEvent {
+public class RepositorySystemHookEvent extends AbstractSystemHookEvent {
 
     public static final String REPOSITORY_UPDATE_EVENT = "repository_update";
 
@@ -26,7 +26,6 @@ public class RepositorySystemHookEvent implements SystemHookEvent {
     private List<RepositoryChange> changes;
     private List<String> refs;
 
-
     public String getEventName() {
         return (eventName);
     }
diff --git a/src/main/java/org/gitlab4j/api/systemhooks/SystemHookEvent.java b/src/main/java/org/gitlab4j/api/systemhooks/SystemHookEvent.java
@@ -1,5 +1,6 @@
 package org.gitlab4j.api.systemhooks;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonSubTypes;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 
@@ -28,7 +29,14 @@
     @JsonSubTypes.Type(value = RepositorySystemHookEvent.class, name = RepositorySystemHookEvent.REPOSITORY_UPDATE_EVENT)
 })
 public interface SystemHookEvent {
-    public String getEventName();
+
+    String getEventName();
+
+    void setRequestUrl(String requestUrl);
+    @JsonIgnore String getRequestUrl();
+
+    void setRequestQueryString(String requestQuesryString);
+    @JsonIgnore String getRequestQueryString();
 }
 
 // All of the following class definitions are needed to make the above work.
diff --git a/src/main/java/org/gitlab4j/api/systemhooks/SystemHookManager.java b/src/main/java/org/gitlab4j/api/systemhooks/SystemHookManager.java
@@ -82,6 +82,8 @@ public void handleEvent(HttpServletRequest request) throws GitLabApiException {
                 event = jacksonJson.unmarshal(SystemHookEvent.class, reader);
             }
 
+            event.setRequestUrl(request.getRequestURL().toString());
+            event.setRequestQueryString(request.getQueryString());
             fireEvent(event);
 
         } catch (Exception e) {
diff --git a/src/main/java/org/gitlab4j/api/systemhooks/TeamMemberSystemHookEvent.java b/src/main/java/org/gitlab4j/api/systemhooks/TeamMemberSystemHookEvent.java
@@ -10,7 +10,7 @@
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
-public class TeamMemberSystemHookEvent implements SystemHookEvent {
+public class TeamMemberSystemHookEvent extends AbstractSystemHookEvent {
     
     public static final String NEW_TEAM_MEMBER_EVENT = "user_add_to_team";
     public static final String TEAM_MEMBER_REMOVED_EVENT = "user_remove_from_team";
diff --git a/src/main/java/org/gitlab4j/api/systemhooks/UserSystemHookEvent.java b/src/main/java/org/gitlab4j/api/systemhooks/UserSystemHookEvent.java
@@ -8,7 +8,7 @@
 
 @XmlRootElement
 @XmlAccessorType(XmlAccessType.FIELD)
-public class UserSystemHookEvent implements SystemHookEvent {
+public class UserSystemHookEvent extends AbstractSystemHookEvent {
     
     public static final String USER_CREATE_EVENT = "user_create";
     public static final String USER_DESTROY_EVENT = "user_destroy";
diff --git a/src/main/java/org/gitlab4j/api/webhook/AbstractEvent.java b/src/main/java/org/gitlab4j/api/webhook/AbstractEvent.java
@@ -0,0 +1,31 @@
+package org.gitlab4j.api.webhook;
+
+import com.fasterxml.jackson.annotation.JsonIgnore;
+
+public abstract class AbstractEvent implements Event {
+
+    private String requestUrl;
+    private String requestQuesryString;
+
+    @Override
+    public void setRequestUrl(String requestUrl) {
+        this.requestUrl = requestUrl;
+    }
+
+    @Override
+    @JsonIgnore
+    public String getRequestUrl() {
+        return (requestUrl);
+    }
+
+    @Override
+    public void setRequestQueryString(String requestQuesryString) {
+        this.requestQuesryString = requestQuesryString;
+    }
+
+    @Override
+    @JsonIgnore
+    public String getRequestQueryString() {
+        return (requestQuesryString);
+    }
+}
diff --git a/src/main/java/org/gitlab4j/api/webhook/AbstractPushEvent.java b/src/main/java/org/gitlab4j/api/webhook/AbstractPushEvent.java
@@ -28,6 +28,9 @@ public abstract class AbstractPushEvent {
     private List<EventCommit> commits;
     private Integer totalCommitsCount;
 
+    private String requestUrl;
+    private String requestQuesryString;
+
     public String getEventName() {
         return (eventName);
     }
@@ -140,6 +143,24 @@ public void setTotalCommitsCount(Integer totalCommitsCount) {
         this.totalCommitsCount = totalCommitsCount;
     }
 
+    public void setRequestUrl(String requestUrl) {
+        this.requestUrl = requestUrl;
+    }
+
+    @JsonIgnore
+    public String getRequestUrl() {
+        return (requestUrl);
+    }
+
+    public void setRequestQueryString(String requestQuesryString) {
+        this.requestQuesryString = requestQuesryString;
+    }
+
+    @JsonIgnore
+    public String getRequestQueryString() {
+        return (requestQuesryString);
+    }
+
     /**
      * Gets the branch name from the ref. Will return null if the ref does not start with "refs/heads/".
      * 
diff --git a/src/main/java/org/gitlab4j/api/webhook/BuildEvent.java b/src/main/java/org/gitlab4j/api/webhook/BuildEvent.java
@@ -8,7 +8,7 @@
 import org.gitlab4j.api.models.User;
 
 @XmlAccessorType(XmlAccessType.FIELD)
-public class BuildEvent implements Event {
+public class BuildEvent extends AbstractEvent {
 
     /** X-Gitlab-Event header value pre GitLab v9.3.0 */
     public static final String BUILD_HOOK_X_GITLAB_EVENT = "Build Hook";
diff --git a/src/main/java/org/gitlab4j/api/webhook/Event.java b/src/main/java/org/gitlab4j/api/webhook/Event.java
@@ -1,5 +1,6 @@
 package org.gitlab4j.api.webhook;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonSubTypes;
 import com.fasterxml.jackson.annotation.JsonTypeInfo;
 
@@ -17,5 +18,15 @@
     @JsonSubTypes.Type(value = WikiPageEvent.class, name = WikiPageEvent.OBJECT_KIND)
 })
 public interface Event {     
-    public String getObjectKind();
+    String getObjectKind();
+
+    void setRequestUrl(String url);
+
+    @JsonIgnore
+    String getRequestUrl();
+
+    void setRequestQueryString(String queryString);
+
+    @JsonIgnore
+    String getRequestQueryString();
 }
diff --git a/src/main/java/org/gitlab4j/api/webhook/IssueEvent.java b/src/main/java/org/gitlab4j/api/webhook/IssueEvent.java
@@ -7,7 +7,7 @@
 import org.gitlab4j.api.models.User;
 
 @XmlAccessorType(XmlAccessType.FIELD)
-public class IssueEvent implements Event {
+public class IssueEvent extends AbstractEvent {
 
     public static final String X_GITLAB_EVENT = "Issue Hook";
     public static final String OBJECT_KIND = "issue";
diff --git a/src/main/java/org/gitlab4j/api/webhook/MergeRequestEvent.java b/src/main/java/org/gitlab4j/api/webhook/MergeRequestEvent.java
@@ -6,7 +6,7 @@
 import org.gitlab4j.api.models.User;
 
 @XmlAccessorType(XmlAccessType.FIELD)
-public class MergeRequestEvent implements Event {
+public class MergeRequestEvent extends AbstractEvent {
 
     public static final String X_GITLAB_EVENT = "Merge Request Hook";
     public static final String OBJECT_KIND = "merge_request";
diff --git a/src/main/java/org/gitlab4j/api/webhook/NoteEvent.java b/src/main/java/org/gitlab4j/api/webhook/NoteEvent.java
@@ -13,7 +13,7 @@
 import com.fasterxml.jackson.annotation.JsonValue;
 
 @XmlAccessorType(XmlAccessType.FIELD)
-public class NoteEvent implements Event {
+public class NoteEvent extends AbstractEvent {
 
     public static final String X_GITLAB_EVENT = "Note Hook";
     public static final String OBJECT_KIND = "note";
diff --git a/src/main/java/org/gitlab4j/api/webhook/PipelineEvent.java b/src/main/java/org/gitlab4j/api/webhook/PipelineEvent.java
@@ -10,7 +10,7 @@
 import org.gitlab4j.api.models.User;
 
 @XmlAccessorType(XmlAccessType.FIELD)
-public class PipelineEvent implements Event {
+public class PipelineEvent extends AbstractEvent {
 
     public static final String X_GITLAB_EVENT = "Pipeline Hook";
     public static final String OBJECT_KIND = "pipeline";
diff --git a/src/main/java/org/gitlab4j/api/webhook/PushEvent.java b/src/main/java/org/gitlab4j/api/webhook/PushEvent.java
@@ -16,7 +16,8 @@ public String getObjectKind() {
     }
 
     public void setObjectKind(String objectKind) {
-        if (!OBJECT_KIND.equals(objectKind))
+        if (!OBJECT_KIND.equals(objectKind)) {
             throw new RuntimeException("Invalid object_kind (" + objectKind + "), must be '" + OBJECT_KIND + "'");
+        }
     }
 }
diff --git a/src/main/java/org/gitlab4j/api/webhook/WebHookManager.java b/src/main/java/org/gitlab4j/api/webhook/WebHookManager.java
@@ -8,6 +8,7 @@
 import java.util.logging.Logger;
 
 import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpUtils;
 
 import org.gitlab4j.api.GitLabApi;
 import org.gitlab4j.api.GitLabApiException;
@@ -93,6 +94,8 @@ public void handleEvent(HttpServletRequest request) throws GitLabApiException {
                 event = jacksonJson.unmarshal(Event.class, reader);
             }
 
+            event.setRequestUrl(request.getRequestURL().toString());
+            event.setRequestQueryString(request.getQueryString());
             fireEvent(event);
 
         } catch (Exception e) {
diff --git a/src/main/java/org/gitlab4j/api/webhook/WikiPageEvent.java b/src/main/java/org/gitlab4j/api/webhook/WikiPageEvent.java
@@ -6,7 +6,7 @@
 import org.gitlab4j.api.models.User;
 
 @XmlAccessorType(XmlAccessType.FIELD)
-public class WikiPageEvent implements Event {
+public class WikiPageEvent extends AbstractEvent {
 
     public static final String X_GITLAB_EVENT = "Wiki Page Hook";
     public static final String OBJECT_KIND = "wiki_page";

Original file line number	Diff line number	Diff line change
`@@ -82,6 +82,8 @@ public void handleEvent(HttpServletRequest request) throws GitLabApiException {`
`82`	`82`	`event = jacksonJson.unmarshal(SystemHookEvent.class, reader);`
`83`	`83`	`}`
`84`	`84`
	`85`	`+ event.setRequestUrl(request.getRequestURL().toString());`
	`86`	`+ event.setRequestQueryString(request.getQueryString());`
`85`	`87`	`fireEvent(event);`
`86`	`88`
`87`	`89`	`} catch (Exception e) {`