Merge pull request #8091 from dCache/fix/11.2/7997

bulk: report 413 Entity Too Large is limits on bulk requests are exce…

Author: chubnastia

modules/dcache-bulk/src/main/java/org/dcache/services/bulk/BulkService.java

@@ -497,15 +497,15 @@ private <M extends Message> void relayToLeader(M message, MessageReply<M> reply)
     }
 
     private synchronized void checkDepthConstraints(BulkRequest request)
-          throws BulkPermissionDeniedException {
+          throws BulkContentTooLargeException {
         switch (request.getExpandDirectories()) {
             case ALL:
                 switch (allowedDepth) {
                     case ALL:
                         checkTargetCount(request);
                         return;
                     default:
-                        throw new BulkPermissionDeniedException(
+                        throw new BulkContentTooLargeException(
                               "full directory recursion not permitted.");
                 }
             case TARGETS:
@@ -515,7 +515,7 @@ private synchronized void checkDepthConstraints(BulkRequest request)
                         checkTargetCount(request);
                         return;
                     default:
-                        throw new BulkPermissionDeniedException(
+                        throw new BulkContentTooLargeException(
                               "processing children of a directory not permitted.");
                 }
             default:
@@ -548,27 +548,27 @@ private void checkRestrictions(Restriction restriction, String uuid)
     }
 
     private synchronized void checkTargetCount(BulkRequest request)
-          throws BulkPermissionDeniedException {
+          throws BulkContentTooLargeException {
         List<String> targets = request.getTarget();
         int listSize = targets == null ? 0 : targets.size();
         switch (request.getExpandDirectories()) {
             case NONE:
                 if (listSize > maxFlatTargets) {
-                    throw new BulkPermissionDeniedException(
+                    throw new BulkContentTooLargeException(
                           String.format(TARGET_COUNT_ERROR_FORMAT, listSize, maxFlatTargets,
                                 Depth.NONE.name()));
                 }
                 break;
             case TARGETS:
                 if (listSize > maxShallowTargets) {
-                    throw new BulkPermissionDeniedException(
+                    throw new BulkContentTooLargeException(
                           String.format(TARGET_COUNT_ERROR_FORMAT, listSize, maxShallowTargets,
                                 Depth.TARGETS.name()));
                 }
                 break;
             case ALL:
                 if (listSize > maxRecursiveTargets) {
-                    throw new BulkPermissionDeniedException(
+                    throw new BulkContentTooLargeException(
                           String.format(TARGET_COUNT_ERROR_FORMAT, listSize, maxRecursiveTargets,
                                 Depth.ALL.name()));
                 }
@@ -700,4 +700,4 @@ private void validateTargets(String uuid, Subject subject, List<String> paths)
             }
         }
     }
-}
+}

modules/dcache-frontend/src/main/java/org/dcache/restful/resources/tape/StageResources.java

@@ -210,6 +210,7 @@ public StageRequestInfo getStageInfo(@ApiParam("The unique id of the request.")
           @ApiResponse(code = 401, message = "Unauthorized"),
           @ApiResponse(code = 403, message = "Forbidden"),
           @ApiResponse(code = 404, message = "Not Found"),
+          @ApiResponse(code = 413, message = "Content Too Large"),
           @ApiResponse(code = 429, message = "Too many requests"),
           @ApiResponse(code = 500, message = "Internal Server Error")
     })
@@ -275,6 +276,7 @@ public Response cancel(
           @ApiResponse(code = 400, message = "Bad request"),
           @ApiResponse(code = 401, message = "Unauthorized"),
           @ApiResponse(code = 403, message = "Forbidden"),
+          @ApiResponse(code = 413, message = "Content Too Large"),
           @ApiResponse(code = 429, message = "Too many requests"),
           @ApiResponse(code = 500, message = "Internal Server Error")
     })

modules/dcache-frontend/src/main/java/org/dcache/restful/util/bulk/BulkServiceCommunicator.java

@@ -60,6 +60,7 @@ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 package org.dcache.restful.util.bulk;
 
 import static javax.ws.rs.core.Response.Status.TOO_MANY_REQUESTS;
+import static javax.ws.rs.core.Response.Status.REQUEST_ENTITY_TOO_LARGE;
 
 import com.google.common.base.Throwables;
 import dmg.util.Exceptions;
@@ -71,6 +72,7 @@ LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 import javax.ws.rs.InternalServerErrorException;
 import javax.ws.rs.NotFoundException;
 import org.dcache.cells.CellStub;
+import org.dcache.services.bulk.BulkContentTooLargeException;
 import org.dcache.services.bulk.BulkPermissionDeniedException;
 import org.dcache.services.bulk.BulkQuotaExceededException;
 import org.dcache.services.bulk.BulkRequestNotFoundException;
@@ -124,6 +126,8 @@ private void checkError(BulkServiceMessage message) {
 
         if (error instanceof BulkPermissionDeniedException) {
             throw new ForbiddenException(error);
+        } else if (error instanceof BulkContentTooLargeException) {
+            throw new ClientErrorException(REQUEST_ENTITY_TOO_LARGE, error);
         } else if (error instanceof BulkQuotaExceededException) {
             throw new ClientErrorException(TOO_MANY_REQUESTS, error);
         } else if (error instanceof BulkRequestNotFoundException) {

modules/dcache-vehicles/src/main/java/org/dcache/services/bulk/BulkContentTooLargeException.java

@@ -0,0 +1,73 @@
+/*
+COPYRIGHT STATUS:
+Dec 1st 2001, Fermi National Accelerator Laboratory (FNAL) documents and
+software are sponsored by the U.S. Department of Energy under Contract No.
+DE-AC02-76CH03000. Therefore, the U.S. Government retains a  world-wide
+non-exclusive, royalty-free license to publish or reproduce these documents
+and software for U.S. Government purposes.  All documents and software
+available from this server are protected under the U.S. and Foreign
+Copyright Laws, and FNAL reserves all rights.
+
+Distribution of the software available from this server is free of
+charge subject to the user following the terms of the Fermitools
+Software Legal Information.
+
+Redistribution and/or modification of the software shall be accompanied
+by the Fermitools Software Legal Information  (including the copyright
+notice).
+
+The user is asked to feed back problems, benefits, and/or suggestions
+about the software to the Fermilab Software Providers.
+
+Neither the name of Fermilab, the  URA, nor the names of the contributors
+may be used to endorse or promote products derived from this software
+without specific prior written permission.
+
+DISCLAIMER OF LIABILITY (BSD):
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED  WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED  WARRANTIES OF MERCHANTABILITY AND FITNESS
+FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL FERMILAB,
+OR THE URA, OR THE U.S. DEPARTMENT of ENERGY, OR CONTRIBUTORS BE LIABLE
+FOR  ANY  DIRECT, INDIRECT,  INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE  GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY  OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT  OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE  POSSIBILITY OF SUCH DAMAGE.
+
+Liabilities of the Government:
+
+This software is provided by URA, independent from its Prime Contract
+with the U.S. Department of Energy. URA is acting independently from
+the Government and in its own private capacity and is not acting on
+behalf of the U.S. Government, nor as its contractor nor its agent.
+Correspondingly, it is understood and agreed that the U.S. Government
+has no connection to this software and in no manner whatsoever shall
+be liable for nor assume any responsibility or obligation for any claim,
+cost, or damages arising out of or resulting from the use of the software
+available from this server.
+
+Export Control:
+
+All documents and software available from this server are subject to U.S.
+export control laws.  Anyone downloading information from this server is
+obligated to secure any necessary Government licenses before exporting
+documents or software obtained from this server.
+ */
+package org.dcache.services.bulk;
+
+public class BulkContentTooLargeException extends BulkServiceException {
+
+    private static final long serialVersionUID = 1L;
+
+    public BulkContentTooLargeException(String message) {
+        super(message);
+    }
+
+    public BulkContentTooLargeException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}