spring-boot/org.springframework.boot.web.servlet/ServletComponentScan

ServletComponentScan

@Target(value = ElementType.TYPE)
@Retention(value = RetentionPolicy.RUNTIME)
@Documented
@Import(value = ServletComponentScanRegistrar::class)
annotation class ServletComponentScan

Enables scanning for Servlet components (filters, servlets, and listeners). Scanning is only performed when using an embedded web server.

Typically, one of value, basePackages, or basePackageClasses should be specified to control the packages to be scanned for components. In their absence, scanning will be performed from the package of the class with the annotation.

Author

Andy Wilkinson

Since

1.3.0

See also

WebServlet
WebFilter
WebListener

Functions

Link copied to clipboard
abstract fun annotationType(): Class<out Annotation>
Link copied to clipboard
abstract fun basePackageClasses(): Array<Class<out Any>>
Type-safe alternative to basePackages for specifying the packages to scan for annotated servlet components.
Link copied to clipboard
@AliasFor(value = "value")
abstract fun basePackages(): Array<String>
Base packages to scan for annotated servlet components.
Link copied to clipboard
abstract fun equals(p: Any): Boolean
Link copied to clipboard
abstract fun hashCode(): Int
Link copied to clipboard
abstract fun toString(): String
Link copied to clipboard
@AliasFor(value = "basePackages")
abstract fun value(): Array<String>
Alias for the basePackages attribute.