/*
 * Copyright (c) 2017, 2018 Oracle and/or its affiliates and others.
 * All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package javax.servlet;

import javax.servlet.annotation.MultipartConfig;

Java Class represntation of an MultipartConfig annotation value.
Since:Servlet 3.0
/** * Java Class represntation of an {@link MultipartConfig} annotation value. * * @since Servlet 3.0 */
public class MultipartConfigElement { private String location; private long maxFileSize; private long maxRequestSize; private int fileSizeThreshold;
Constructs an instance with defaults for all but location.
Params:
  • location – defualts to "" if values is null.
/** * Constructs an instance with defaults for all but location. * * @param location defualts to "" if values is null. */
public MultipartConfigElement(String location) { if (location == null) { this.location = ""; } else { this.location = location; } this.maxFileSize = -1L; this.maxRequestSize = -1L; this.fileSizeThreshold = 0; }
Constructs an instance with all values specified.
Params:
  • location – the directory location where files will be stored
  • maxFileSize – the maximum size allowed for uploaded files
  • maxRequestSize – the maximum size allowed for multipart/form-data requests
  • fileSizeThreshold – the size threshold after which files will be written to disk
/** * Constructs an instance with all values specified. * * @param location the directory location where files will be stored * @param maxFileSize the maximum size allowed for uploaded files * @param maxRequestSize the maximum size allowed for multipart/form-data requests * @param fileSizeThreshold the size threshold after which files will be written to disk */
public MultipartConfigElement(String location, long maxFileSize, long maxRequestSize, int fileSizeThreshold) { if (location == null) { this.location = ""; } else { this.location = location; } this.maxFileSize = maxFileSize; this.maxRequestSize = maxRequestSize; this.fileSizeThreshold = fileSizeThreshold; }
Constructs an instance from a MultipartConfig annotation value.
Params:
  • annotation – the annotation value
/** * Constructs an instance from a {@link MultipartConfig} annotation value. * * @param annotation the annotation value */
public MultipartConfigElement(MultipartConfig annotation) { this.location = annotation.location(); this.fileSizeThreshold = annotation.fileSizeThreshold(); this.maxFileSize = annotation.maxFileSize(); this.maxRequestSize = annotation.maxRequestSize(); }
Gets the directory location where files will be stored.
Returns:the directory location where files will be stored
/** * Gets the directory location where files will be stored. * * @return the directory location where files will be stored */
public String getLocation() { return this.location; }
Gets the maximum size allowed for uploaded files.
Returns:the maximum size allowed for uploaded files
/** * Gets the maximum size allowed for uploaded files. * * @return the maximum size allowed for uploaded files */
public long getMaxFileSize() { return this.maxFileSize; }
Gets the maximum size allowed for multipart/form-data requests.
Returns:the maximum size allowed for multipart/form-data requests
/** * Gets the maximum size allowed for multipart/form-data requests. * * @return the maximum size allowed for multipart/form-data requests */
public long getMaxRequestSize() { return this.maxRequestSize; }
Gets the size threshold after which files will be written to disk.
Returns:the size threshold after which files will be written to disk
/** * Gets the size threshold after which files will be written to disk. * * @return the size threshold after which files will be written to disk */
public int getFileSizeThreshold() { return this.fileSizeThreshold; } }