FilterRegistration Type — spring-boot Architecture

Source Code

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

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

	/**
	 * 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;

	/**
	 * Dispatcher types that should be used with the registration.
	 * @return the dispatcher types
	 */
	DispatcherType[] dispatcherTypes() default {};

	/**
	 * 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;

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

	/**
	 * Whether the filter mappings should be matched after any declared Filter mappings of
	 * the ServletContext.
	 * @return whether the filter mappings should be matched after any declared Filter
	 * mappings of the ServletContext
	 */
	boolean matchAfter() default false;

	/**
	 * Servlet names that the filter will be registered against.
	 * @return the servlet names
	 */
	String[] servletNames() default {};

	/**
	 * Servlet classes that the filter will be registered against.
	 * @return the servlet classes
	 */
	Class<?>[] servletClasses() default {};

	/**
	 * URL patterns, as defined in the Servlet specification, that the filter will be
	 * registered against.
	 * @return the url patterns
	 */
	String[] urlPatterns() default {};

}