Package com.vaadin.flow.router

Class Router

java.lang.Object

com.vaadin.flow.router.Router

All Implemented Interfaces:

Serializable

public class Router
extends Object
implements Serializable

The router takes care of serving content when the user navigates within a site or an application.

Since:

1.0.

Author:

Vaadin Ltd

See Also:

• Route
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Router(RouteRegistry registry)	Constructs a new router with the given route registry and a DefaultRouteResolver.

Method Summary

Modifier and Type	Method	Description
int	executeNavigation(UI ui, Location location, NavigationEvent navigationEvent, NavigationHandler handler, IntConsumer onSuccess)	Execute navigation with a pre-resolved handler and optional success callback.
Optional<ErrorTargetEntry>	getErrorNavigationTarget(Exception exception)	Get a registered navigation target for given exception.
RouteRegistry	getRegistry()
int	handleExceptionNavigation(UI ui, Location location, Exception exception, NavigationTrigger trigger, com.fasterxml.jackson.databind.node.BaseJsonNode state)	Render error view for exception.
void	initializeUI(UI ui, Location location)	Enables navigation for a new UI instance.
int	navigate(UI ui, Location location, NavigationTrigger trigger)	Navigates the given UI to the given location.
int	navigate(UI ui, Location location, NavigationTrigger trigger, com.fasterxml.jackson.databind.node.BaseJsonNode state)	Navigates the given UI to the given location.
int	navigate(UI ui, Location location, NavigationTrigger trigger, com.fasterxml.jackson.databind.node.BaseJsonNode state, boolean forceInstantiation, boolean recreateLayoutChain)	Navigates the given UI to the given location.
int	navigate(UI ui, Location location, NavigationTrigger trigger, elemental.json.JsonValue state)	Deprecated.
int	navigate(UI ui, Location location, NavigationTrigger trigger, elemental.json.JsonValue state, boolean forceInstantiation, boolean recreateLayoutChain)	Deprecated.
Optional<NavigationState>	resolveNavigationTarget(Location location)	Resolve the navigation target for given Location using the router routeResolver.
Optional<NavigationState>	resolveNavigationTarget(String pathInfo, Map<String,String[]> parameterMap)	Resolve the navigation target for given path and parameter map using the router routeResolver.
Optional<NavigationState>	resolveRouteNotFoundNavigationTarget()	Resolve a navigation target with an empty NotFoundException.

Methods inherited from class java.lang.Object

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

Constructor Details

Router

public Router(RouteRegistry registry)

Constructs a new router with the given route registry and a DefaultRouteResolver.

Parameters:

registry - the route registry to use, not null

Method Details

initializeUI

public void initializeUI(UI ui,
 Location location)

Enables navigation for a new UI instance. This initializes the UI content based on the location used for loading the UI and sets up the UI to be updated when the user navigates to some other location.

Parameters:

ui - the UI that navigation should be set up for

location - the location object of the route

resolveNavigationTarget

public Optional<NavigationState> resolveNavigationTarget(String pathInfo,
 Map<String,String[]> parameterMap)

Resolve the navigation target for given path and parameter map using the router routeResolver.

Parameters:

pathInfo - the path relative to the application

parameterMap - A mapping of parameter names to arrays of parameter values

Returns:

NavigationTarget for the given path and parameter map if found

resolveNavigationTarget

public Optional<NavigationState> resolveNavigationTarget(Location location)

Resolve the navigation target for given Location using the router routeResolver.

Parameters:

location - the location object of the route

Returns:

NavigationTarget for the given location if found

resolveRouteNotFoundNavigationTarget

public Optional<NavigationState> resolveRouteNotFoundNavigationTarget()

Resolve a navigation target with an empty NotFoundException.

Returns:

an instance of NavigationState for NotFoundException or empty if there is none in the application.

navigate

public int navigate(UI ui,
 Location location,
 NavigationTrigger trigger)

Navigates the given UI to the given location.

This method just shows the given location on the page and doesn't update the browser location (and page history). Use the UI.navigate(String, QueryParameters) method if you want to update the browser location as well.

Parameters:

ui - the UI to update, not null

location - the location to navigate to, not null

trigger - the type of user action that triggered this navigation, not null

Returns:

the HTTP status code resulting from the navigation

See Also:

• UI.navigate(String)
• UI.navigate(String, QueryParameters)

navigate

public int navigate(UI ui,
 Location location,
 NavigationTrigger trigger,
 com.fasterxml.jackson.databind.node.BaseJsonNode state)

Navigates the given UI to the given location. For internal use only.

This method pushes to the browser history if the trigger is NavigationTrigger.ROUTER_LINK or NavigationTrigger.UI_NAVIGATE.

Parameters:

ui - the UI to update, not null

location - the location to navigate to, not null

trigger - the type of user action that triggered this navigation, not null

state - includes navigation state info including for example the scroll position and the complete href of the RouterLink

Returns:

the HTTP status code resulting from the navigation

See Also:

• UI.navigate(String)
• UI.navigate(String, QueryParameters)

navigate

public int navigate(UI ui,
 Location location,
 NavigationTrigger trigger,
 com.fasterxml.jackson.databind.node.BaseJsonNode state,
 boolean forceInstantiation,
 boolean recreateLayoutChain)

Navigates the given UI to the given location. For internal use only.

This method pushes to the browser history if the trigger is NavigationTrigger.ROUTER_LINK or NavigationTrigger.UI_NAVIGATE.

Parameters:

ui - the UI to update, not null

location - the location to navigate to, not null

trigger - the type of user action that triggered this navigation, not null

state - includes navigation state info including for example the scroll position and the complete href of the RouterLink

forceInstantiation - if set to true, the navigation target will always be instantiated

recreateLayoutChain - if set to true, the complete layout chain up to the navigation target will be re-instantiated. Requires forceInstantiation to be true to have an effect.

Returns:

the HTTP status code resulting from the navigation

See Also:

• UI.navigate(String)
• UI.navigate(String, QueryParameters)

navigate

@Deprecated
public int navigate(UI ui,
 Location location,
 NavigationTrigger trigger,
 elemental.json.JsonValue state)

Deprecated.

Navigates the given UI to the given location. For internal use only.

This method pushes to the browser history if the trigger is NavigationTrigger.ROUTER_LINK or NavigationTrigger.UI_NAVIGATE.

Parameters:

ui - the UI to update, not null

location - the location to navigate to, not null

trigger - the type of user action that triggered this navigation, not null

state - includes navigation state info including for example the scroll position and the complete href of the RouterLink

Returns:

the HTTP status code resulting from the navigation

See Also:

• UI.navigate(String)
• UI.navigate(String, QueryParameters)

navigate

@Deprecated
public int navigate(UI ui,
 Location location,
 NavigationTrigger trigger,
 elemental.json.JsonValue state,
 boolean forceInstantiation,
 boolean recreateLayoutChain)

Deprecated.

Navigates the given UI to the given location. For internal use only.

This method pushes to the browser history if the trigger is NavigationTrigger.ROUTER_LINK or NavigationTrigger.UI_NAVIGATE.

Parameters:

ui - the UI to update, not null

location - the location to navigate to, not null

trigger - the type of user action that triggered this navigation, not null

state - includes navigation state info including for example the scroll position and the complete href of the RouterLink

forceInstantiation - if set to true, the navigation target will always be instantiated

recreateLayoutChain - if set to true, the complete layout chain up to the navigation target will be re-instantiated. Requires forceInstantiation to be true to have an effect.

Returns:

the HTTP status code resulting from the navigation

See Also:

• UI.navigate(String)
• UI.navigate(String, QueryParameters)

handleExceptionNavigation

public int handleExceptionNavigation(UI ui,
 Location location,
 Exception exception,
 NavigationTrigger trigger,
 com.fasterxml.jackson.databind.node.BaseJsonNode state)

Render error view for exception. Finds view to render based on the exception type. Exception view is chosen for matching exception and if no match is found choose by extended type.

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

Parameters:

ui - current UI instance

location - target location for failing navigation

exception - exception thrown

trigger - navigation trigger

state - navigation state info

Returns:

the HTTP status code to return to the client if handling an initial rendering request

executeNavigation

public int executeNavigation(UI ui,
 Location location,
 NavigationEvent navigationEvent,
 NavigationHandler handler,
 IntConsumer onSuccess)

Execute navigation with a pre-resolved handler and optional success callback.

This method handles the common navigation pattern of setting navigation state, executing the handler, running a success callback, and properly handling exceptions via handleExceptionNavigation(com.vaadin.flow.component.UI, com.vaadin.flow.router.Location, java.lang.Exception, com.vaadin.flow.router.NavigationTrigger, com.fasterxml.jackson.databind.node.BaseJsonNode).

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

Parameters:

ui - the UI to update, not null

location - the navigation location, not null

navigationEvent - the navigation event to pass to the handler

handler - the navigation handler to execute

onSuccess - optional callback to run after successful navigation (before clearing navigation state), may be null

Returns:

the HTTP status code resulting from the navigation

getRegistry

public RouteRegistry getRegistry()

getErrorNavigationTarget

public Optional<ErrorTargetEntry> getErrorNavigationTarget(Exception exception)

Get a registered navigation target for given exception.

Parameters:

exception - exception to search error view for

Returns:

optional error target entry corresponding to the given exception