opendev/gerrit
Code Issues Proposed changes

Accept POST on supported REST collections

Browse Source 
POST on /groups/ should create a new resource whose id is
determined from the input body. The AcceptsCreate interface
does not work here as there was no id in the path remaining.
Build a new interface AcceptsPost that handles POST calls on
a collection using the collection itself to construct the view.
This is primarily meant for TopLevelResource collections.

Change-Id: I0086ffc69cf42905db8c98198a809bfa755b52dd
This commit is contained in:
Shawn Pearce
2013-01-26 10:00:37 -08:00
parent 38aa5485ad
commit d159863833
2 changed files with 55 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
gerrit-extension-api/src/main/java/com/google/gerrit/extensions/restapi/AcceptsPost.java Normal file
View File

@@ -0,0 +1,36 @@
// Copyright (C) 2012 The Android Open Source Project
//
// 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.google.gerrit.extensions.restapi;
/**
* Optional interface for {@link RestCollection}.
* <p>
* Collections that implement this interface can accept a {@code POST} directly
* on the collection itself when no id was given in the path. This interface is
* intended to be used with TopLevelResource collections. Nested collections
* often bind POST on the parent collection to the view implementation handling
* the insertion of a new member.
*/
public interface AcceptsPost<P extends RestResource> {
/**
* Handle creation of a child resource by POST on the collection.
*
* @param parent parent collection handle.
* @return a view to perform the creation. The id of the newly created
* resource should be determined from the input body.
* @throws RestApiException the view cannot be constructed.
*/
<I> RestModifyView<P, I> post(P parent) throws RestApiException;
}

21
gerrit-httpd/src/main/java/com/google/gerrit/httpd/restapi/RestApiServlet.java
View File

@@ -40,6 +40,7 @@ import com.google.common.net.HttpHeaders;
import com.google.gerrit.extensions.annotations.RequiresCapability;
import com.google.gerrit.extensions.registration.DynamicMap;
import com.google.gerrit.extensions.restapi.AcceptsCreate;
import com.google.gerrit.extensions.restapi.AcceptsPost;
import com.google.gerrit.extensions.restapi.AuthException;
import com.google.gerrit.extensions.restapi.BadRequestException;
import com.google.gerrit.extensions.restapi.BinaryResult;
@@ -179,7 +180,15 @@ public class RestApiServlet extends HttpServlet {
RestResource rsrc = TopLevelResource.INSTANCE;
RestView<RestResource> view = null;
if (path.isEmpty()) {
view = rc.list();
if ("GET".equals(req.getMethod())) {
view = rc.list();
} else if (rc instanceof AcceptsPost && "POST".equals(req.getMethod())) {
@SuppressWarnings("unchecked")
AcceptsPost<RestResource> ac = (AcceptsPost<RestResource>) rc;
view = ac.post(rsrc);
} else {
throw new MethodNotAllowedException();
}
} else {
String id = path.remove(0);
try {
@@ -208,7 +217,15 @@ public class RestApiServlet extends HttpServlet {
(RestCollection<RestResource, RestResource>) view;
if (path.isEmpty()) {
view = c.list();
if ("GET".equals(req.getMethod())) {
view = c.list();
} else if (c instanceof AcceptsPost && "POST".equals(req.getMethod())) {
@SuppressWarnings("unchecked")
AcceptsPost<RestResource> ac = (AcceptsPost<RestResource>) c;
view = ac.post(rsrc);
} else {
throw new MethodNotAllowedException();
}
break;
} else {
String id = path.remove(0);