Package com.vaadin.flow.server.startup

Class LookupServletContainerInitializer

java.lang.Object

com.vaadin.flow.server.startup.LookupServletContainerInitializer

All Implemented Interfaces:

ClassLoaderAwareServletContainerInitializer, jakarta.servlet.ServletContainerInitializer

public class LookupServletContainerInitializer
extends Object
implements ClassLoaderAwareServletContainerInitializer

Standard servlet initializer for collecting all SPI implementations.

For internal use only. May be renamed or removed in a future release.

Author:

Vaadin Ltd

Constructor Summary

Constructors

Constructor	Description
LookupServletContainerInitializer()

Method Summary

Modifier and Type	Method	Description
protected Collection<Class<?>>	getServiceTypes()	Gets the service types that are used to set services into the Lookup based on found subtypes by the ServletContainerInitializer.
void	process(Set<Class<?>> classSet, jakarta.servlet.ServletContext servletContext)	Implement this method instead of ClassLoaderAwareServletContainerInitializer.onStartup(Set, ServletContext) to handle classes accessible by different classloaders.
boolean	requiresLookup()	Whether this initializer requires lookup or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.server.startup.ClassLoaderAwareServletContainerInitializer

onStartup

Constructor Details

LookupServletContainerInitializer

public LookupServletContainerInitializer()

Method Details

process

public void process(Set<Class<?>> classSet,
 jakarta.servlet.ServletContext servletContext)
             throws jakarta.servlet.ServletException

Description copied from interface: ClassLoaderAwareServletContainerInitializer

Implement this method instead of ClassLoaderAwareServletContainerInitializer.onStartup(Set, ServletContext) to handle classes accessible by different classloaders.

Specified by:

process in interface ClassLoaderAwareServletContainerInitializer

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

servletContext - the ServletContext of the web application that is being started and in which the classes contained in classSet were found

Throws:

jakarta.servlet.ServletException - if an error has occurred

See Also:

• ClassLoaderAwareServletContainerInitializer.onStartup(Set, ServletContext)

requiresLookup

public boolean requiresLookup()

Description copied from interface: ClassLoaderAwareServletContainerInitializer

Whether this initializer requires lookup or not.

Specified by:

requiresLookup in interface ClassLoaderAwareServletContainerInitializer

Returns:

whether this initializer requires lookup

getServiceTypes

protected Collection<Class<?>> getServiceTypes()

Gets the service types that are used to set services into the Lookup based on found subtypes by the ServletContainerInitializer.

LookupServletContainerInitializer uses ServletContainerInitializer classes discovering mechanism based on HandlesTypes annotation. The method may be overridden to return the service types which should be put into the Lookup instance if another mechanism of class searching is used (e.g. Spring boot case).

The set of classes (passed into the process(Set, ServletContext) method) will be filtered via checking whether they are assignable to the service types and the resulting classes will be instantiated via reflection.

Returns:

a collection of service types which should be available via Lookup

See Also:

• LookupInitializer.initialize(VaadinContext, Map, VaadinApplicationInitializationBootstrap)