com.vaadin.hilla.route.RouteUtil API 24.7.0.alpha6 | Vaadin

com.vaadin.hilla.route.

java.lang.Object

com.vaadin.hilla.route.RouteUtil

All Implemented Interfaces:

FileRouterRequestUtil

@Component public class RouteUtil extends Object implements FileRouterRequestUtil

A container for utility methods related with Routes.

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

Constructor Summary

Constructors

Constructor

Description

RouteUtil()
Method Summary

Modifier and Type

Method

Description

protected AvailableViewInfo

getRouteByPath(Map<String,AvailableViewInfo> availableRoutes, String path)

Gets the client view configuration for the given route.

boolean

isRouteAllowed(jakarta.servlet.http.HttpServletRequest request)

Checks if the given request is allowed route to the user.

static void

removeChildren(Map<String,AvailableViewInfo> configurations, AvailableViewInfo viewInfo, String parentPath)

void

setRoutes(Map<String,AvailableViewInfo> registeredRoutes)

Initializes a new instance of the RouteUtil class with the given route map.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- RouteUtil
  
  public RouteUtil()
Method Details
- setRoutes
  
  public void setRoutes(Map<String,AvailableViewInfo> registeredRoutes)
  
  Initializes a new instance of the RouteUtil class with the given route map.
  
  Parameters:
  
  registeredRoutes - - the available unfiltered routes
- isRouteAllowed
  
  public boolean isRouteAllowed(jakarta.servlet.http.HttpServletRequest request)
  
  Checks if the given request is allowed route to the user.
  
  Specified by:
  
  isRouteAllowed in interface FileRouterRequestUtil
  
  Parameters:
  
  request - the HTTP request to check
  
  Returns:
  
  true if the request goes allowed route, false otherwise
- removeChildren
  
  public static void removeChildren(Map<String,AvailableViewInfo> configurations, AvailableViewInfo viewInfo, String parentPath)
- getRouteByPath
  
  protected AvailableViewInfo getRouteByPath(Map<String,AvailableViewInfo> availableRoutes, String path)
  
  Gets the client view configuration for the given route.
  
  Parameters:
  
  path - the URL path to get the client view configuration for
  
  Returns:
  
  - the client view configuration for the given route