com.vaadin.flow.server.startup.ClassLoaderAwareServletContainerInitializer API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.server.startup.

All Superinterfaces:

javax.servlet.ServletContainerInitializer

All Known Subinterfaces:

VaadinServletContextStartupInitializer

All Known Implementing Classes:

AnnotationValidator, DevModeStartupListener, ErrorNavigationTargetInitializer, LookupServletContainerInitializer, RouteRegistryInitializer, ServletVerifier, VaadinAppShellInitializer, WebComponentConfigurationRegistryInitializer, WebComponentExporterAwareValidator
```
public interface ClassLoaderAwareServletContainerInitializer
extends javax.servlet.ServletContainerInitializer
```
Allows to load the implementation class by one classloader but accepts classes in onStartup(Set, ServletContext) method loaded by another classloader.
Workaround for https://github.com/vaadin/flow/issues/7805.

Author:

Vaadin Ltd

Method Summary

All Methods
Modifier and Type	Method	Description
`default void`	`onStartup(Set<Class<?>> set, javax.servlet.ServletContext context)`	Overridden to use different classloaders if needed.
`void`	`process(Set<Class<?>> classSet, javax.servlet.ServletContext context)`	Implement this method instead of `onStartup(Set, ServletContext)` to handle classes accessible by different classloaders.
`default boolean`	`requiresLookup()`	Whether this initializer requires lookup or not.

- Method Detail
  - onStartup
```
default void onStartup(Set<Class<?>> set,
                       javax.servlet.ServletContext context)
                throws javax.servlet.ServletException
```
    Overridden to use different classloaders if needed.
    
    Specified by:
    
    onStartup in interface javax.servlet.ServletContainerInitializer
    
    Throws:
    
    javax.servlet.ServletException
  - requiresLookup
```
default boolean requiresLookup()
```
    Whether this initializer requires lookup or not.
    
    Returns:
    
    whether this initializer requires lookup
  - process
```
void process(Set<Class<?>> classSet,
             javax.servlet.ServletContext context)
      throws javax.servlet.ServletException
```
    Implement this method instead of onStartup(Set, ServletContext) to handle classes accessible by different classloaders.
    
    Parameters:
    
    classSet - the Set of application classes that extend, implement, or have been annotated with the class types specified by the HandlesTypes annotation, or null if there are no matches, or this ServletContainerInitializer has not been annotated with HandlesTypes
    
    context - the ServletContext of the web application that is being started and in which the classes contained in classSet were found
    
    Throws:
    
    javax.servlet.ServletException - if an error has occurred
    
    See Also:
    
    onStartup(Set, ServletContext)