Package com.vaadin.flow.server.startup

Class RouteRegistryInitializer

java.lang.Object

com.vaadin.flow.server.startup.AbstractRouteRegistryInitializer

com.vaadin.flow.server.startup.RouteRegistryInitializer

All Implemented Interfaces:

ClassLoaderAwareServletContainerInitializer, VaadinContextStartupInitializer, VaadinServletContextStartupInitializer, jakarta.servlet.ServletContainerInitializer, Serializable

public class RouteRegistryInitializer
extends AbstractRouteRegistryInitializer
implements VaadinServletContextStartupInitializer

Servlet initializer for collecting all available Routes on startup.

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

Since:

1.0

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
RouteRegistryInitializer()

Method Summary

Modifier and Type	Method	Description
void	initialize(Set<Class<?>> classSet, VaadinContext context)	Applies this initializer to the given context
static void	validateLayoutAnnotations(Set<Class<?>> routesSet)	Validate Layout annotations that they are not added on classes that do not extend RouterLayout as they can not work without the implementation.

Methods inherited from class com.vaadin.flow.server.startup.AbstractRouteRegistryInitializer

validatePwaClass, validateRouteClasses

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, requiresLookup

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

process

Constructor Details

RouteRegistryInitializer

public RouteRegistryInitializer()

Method Details

initialize

public void initialize(Set<Class<?>> classSet,
 VaadinContext context)
                throws VaadinInitializerException

Description copied from interface: VaadinContextStartupInitializer

Applies this initializer to the given context

Specified by:

initialize in interface VaadinContextStartupInitializer

Parameters:

classSet - the Set of application classes which this initializer needs to do its job

context - the VaadinContext to use with this initializer

Throws:

VaadinInitializerException - if an error has occurred

validateLayoutAnnotations

public static void validateLayoutAnnotations(Set<Class<?>> routesSet)
                                      throws InvalidRouteLayoutConfigurationException

Validate Layout annotations that they are not added on classes that do not extend RouterLayout as they can not work without the implementation.

Parameters:

routesSet - Routes to check

Throws:

InvalidRouteLayoutConfigurationException - Thrown if any Layout annotations are found on non RouterLayout classes