ServletRegistration Type — spring-boot Architecture

Source Code

core/spring-boot/src/main/java/org/springframework/boot/web/servlet/ServletRegistration.java lines 42–105

@Target({ ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Order
public @interface ServletRegistration {

	/**
	 * Whether this registration is enabled.
	 * @return whether this registration is enabled
	 */
	boolean enabled() default true;

	/**
	 * Order of the registration bean.
	 * @return the order of the registration bean
	 */
	@AliasFor(annotation = Order.class, attribute = "value")
	int order() default Ordered.LOWEST_PRECEDENCE;

	/**
	 * Name of this registration. If not specified the bean name will be used.
	 * @return the name
	 */
	String name() default "";

	/**
	 * Whether asynchronous operations are supported for this registration.
	 * @return whether asynchronous operations are supported
	 */
	boolean asyncSupported() default true;

	/**
	 * Whether registration failures should be ignored. If set to true, a failure will be
	 * logged. If set to false, an {@link IllegalStateException} will be thrown.
	 * @return whether registration failures should be ignored
	 */
	boolean ignoreRegistrationFailure() default false;

	/**
	 * URL mappings for the servlet. If not specified the mapping will default to '/'.
	 * @return the url mappings
	 */
	String[] urlMappings() default {};

	/**
	 * The {@code loadOnStartup} priority. See
	 * {@link jakarta.servlet.ServletRegistration.Dynamic#setLoadOnStartup} for details.
	 * @return the {@code loadOnStartup} priority
	 */
	int loadOnStartup() default -1;

	/**
	 * Init parameters to be used with the servlet.
	 * @return the init parameters
	 */
	WebInitParam[] initParameters() default {};

	/**
	 * The multipart configuration.
	 * @return the multipart configuration
	 */
	MultipartConfig multipartConfig() default @MultipartConfig;

}