jakarta.servlet.annotation.MultipartConfig Maven / Gradle / Ivy
/*
* Copyright (c) 2017, 2023 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 jakarta.servlet.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotation that may be specified on a {@link jakarta.servlet.Servlet} class, indicating that instances of the
* Servlet expect requests that conform to the multipart/form-data MIME type.
*
*
* Servlets annotated with MultipartConfig may retrieve the {@link jakarta.servlet.http.Part} components of a
* given multipart/form-data request by calling {@link jakarta.servlet.http.HttpServletRequest#getPart getPart}
* or {@link jakarta.servlet.http.HttpServletRequest#getParts getParts}.
*/
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MultipartConfig {
/**
* The directory location where files will be stored
*
* @return the directory location where files will be stored
*/
String location() default "";
/**
* The maximum size allowed for uploaded files.
*
*
* The default is -1L, which means unlimited.
*
* @return the maximum size allowed for uploaded files
*/
long maxFileSize() default -1L;
/**
* The maximum size allowed for multipart/form-data requests
*
*
* The default is -1L, which means unlimited.
*
* @return the maximum size allowed for multipart/form-data requests
*/
long maxRequestSize() default -1L;
/**
* The size threshold after which the file will be written to disk
*
* @return the size threshold after which the file will be written to disk
*/
int fileSizeThreshold() default 0;
}