View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.fileupload2.core;
18  
19  /**
20   * Signals that a requests permitted size is exceeded.
21   */
22  public class FileUploadSizeException extends FileUploadException {
23  
24      /**
25       * Serial version UID, being used, if serialized.
26       */
27      private static final long serialVersionUID = 2;
28  
29      /**
30       * The actual size of the request.
31       */
32      private final long actual;
33  
34      /**
35       * The maximum permitted size of the request.
36       */
37      private final long permitted;
38  
39      /**
40       * Constructs an instance.
41       *
42       * @param message   The detail message (which is saved for later retrieval by the {@link #getMessage()} method)
43       * @param permitted The requests size limit.
44       * @param actual    The actual values for the request.
45       */
46      public FileUploadSizeException(final String message, final long permitted, final long actual) {
47          super(message);
48          this.permitted = permitted;
49          this.actual = actual;
50      }
51  
52      /**
53       * Gets the actual size of the request.
54       *
55       * @return The actual size of the request.
56       */
57      public long getActualSize() {
58          return actual;
59      }
60  
61      /**
62       * Gets the limit size of the request.
63       *
64       * @return The limit size of the request.
65       */
66      public long getPermitted() {
67          return permitted;
68      }
69  
70  }