Package com.vaadin.hilla.route

Class RouteUnifyingIndexHtmlRequestListener

java.lang.Object

com.vaadin.hilla.route.RouteUnifyingIndexHtmlRequestListener

All Implemented Interfaces:

com.vaadin.flow.server.communication.IndexHtmlRequestListener, Serializable, EventListener

public class RouteUnifyingIndexHtmlRequestListener
extends Object
implements com.vaadin.flow.server.communication.IndexHtmlRequestListener

Index HTML request listener for collecting the client side and the server side views and adding them to index.html response.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	SCRIPT_STRING

Constructor Summary

Constructors

Constructor	Description
RouteUnifyingIndexHtmlRequestListener(ClientRouteRegistry clientRouteRegistry, com.vaadin.flow.function.DeploymentConfiguration deploymentConfiguration, RouteUtil routeUtil, com.vaadin.flow.server.auth.NavigationAccessControl accessControl, com.vaadin.flow.server.auth.ViewAccessChecker viewAccessChecker, boolean exposeServerRoutesToClient)	Creates a new listener instance with the given route registry.

Method Summary

Modifier and Type	Method	Description
protected Map<String,AvailableViewInfo>	collectClientViews(Predicate<? super String> isUserInRole, boolean isUserAuthenticated)
protected Map<String,AvailableViewInfo>	collectServerViews(com.vaadin.flow.server.VaadinRequest vaadinRequest)
void	modifyIndexHtmlResponse(com.vaadin.flow.server.communication.IndexHtmlResponse response)

Methods inherited from class java.lang.Object

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

Field Details

SCRIPT_STRING

protected static final String SCRIPT_STRING

See Also:

• Constant Field Values

Constructor Details

RouteUnifyingIndexHtmlRequestListener

public RouteUnifyingIndexHtmlRequestListener(ClientRouteRegistry clientRouteRegistry,
 com.vaadin.flow.function.DeploymentConfiguration deploymentConfiguration,
 RouteUtil routeUtil,
 @Nullable
 com.vaadin.flow.server.auth.NavigationAccessControl accessControl,
 @Nullable
 com.vaadin.flow.server.auth.ViewAccessChecker viewAccessChecker,
 boolean exposeServerRoutesToClient)

Creates a new listener instance with the given route registry.

Parameters:

clientRouteRegistry - the client route registry for getting the client side views

deploymentConfiguration - the runtime deployment configuration

routeUtil - the ClientRouteRegistry aware utility for checking if user is allowed to access a route

exposeServerRoutesToClient - whether to expose server routes to the client

Method Details

modifyIndexHtmlResponse

public void modifyIndexHtmlResponse(com.vaadin.flow.server.communication.IndexHtmlResponse response)

Specified by:

modifyIndexHtmlResponse in interface com.vaadin.flow.server.communication.IndexHtmlRequestListener

collectClientViews

protected Map<String,AvailableViewInfo> collectClientViews(Predicate<? super String> isUserInRole,
 boolean isUserAuthenticated)

collectServerViews

protected Map<String,AvailableViewInfo> collectServerViews(com.vaadin.flow.server.VaadinRequest vaadinRequest)