com.vaadin.flow.server.startup

Class VaadinAppShellInitializer

java.lang.Object

com.vaadin.flow.server.startup.VaadinAppShellInitializer

All Implemented Interfaces:

ClassLoaderAwareServletContainerInitializer, Serializable, EventListener, javax.servlet.ServletContainerInitializer, javax.servlet.ServletContextListener

@WebListener
public class VaadinAppShellInitializer
extends Object
implements ClassLoaderAwareServletContainerInitializer, javax.servlet.ServletContextListener, Serializable

Servlet initializer visiting AppShellConfigurator configuration.

Since:

3.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
VaadinAppShellInitializer()

Method Summary

Modifier and Type	Method and Description
void	contextDestroyed(javax.servlet.ServletContextEvent sce)
void	contextInitialized(javax.servlet.ServletContextEvent sce)
static List<Class<? extends Annotation>>	getValidAnnotations() Return the list of annotations handled by this class.
static List<Class<?>>	getValidSupers() Return the list of super classes handled by this class.
static void	init(Set<Class<?>> classes, javax.servlet.ServletContext context, DeploymentConfiguration config) Initializes the AppShellRegistry for the application.
void	process(Set<Class<?>> classes, javax.servlet.ServletContext context) Implement this method instead of ClassLoaderAwareServletContainerInitializer.onStartup(Set, ServletContext) to handle classes accessible by different classloaders.

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 Detail

VaadinAppShellInitializer

public VaadinAppShellInitializer()

Method Detail

process

public void process(Set<Class<?>> classes,
                    javax.servlet.ServletContext context)
             throws javax.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:

classes - 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 c were found

Throws:

javax.servlet.ServletException - if an error has occurred

See Also:

ClassLoaderAwareServletContainerInitializer.onStartup(Set, ServletContext)

init

public static void init(Set<Class<?>> classes,
                        javax.servlet.ServletContext context,
                        DeploymentConfiguration config)

Initializes the AppShellRegistry for the application.

Parameters:

classes - a set of classes that matches the HandlesTypes set in this class.

context - the servlet context.

config - the vaadin configuration for the application.

getValidAnnotations

public static List<Class<? extends Annotation>> getValidAnnotations()

Return the list of annotations handled by this class. This method is thought to be called from external plugins (e.g. Vaadin Spring) that would need to override the @HandlesTypes-based classpath scanning.

Returns:

list of annotations handled by init(Set, ServletContext, DeploymentConfiguration)

getValidSupers

public static List<Class<?>> getValidSupers()

Return the list of super classes handled by this class. This method is thought to be called from external plugins (e.g. Vaadin Spring) that would need to override the @HandlesTypes-based classpath scanning.

Returns:

list of super classes handled by init(Set, ServletContext, DeploymentConfiguration)

contextInitialized

public void contextInitialized(javax.servlet.ServletContextEvent sce)

Specified by:

contextInitialized in interface javax.servlet.ServletContextListener

contextDestroyed

public void contextDestroyed(javax.servlet.ServletContextEvent sce)

Specified by:

contextDestroyed in interface javax.servlet.ServletContextListener