com.vaadin.flow.server.

java.lang.Object
- com.vaadin.flow.router.internal.AbstractRouteRegistry
- - com.vaadin.flow.server.SessionRouteRegistry

All Implemented Interfaces:

RouteRegistry, Serializable
```
public class SessionRouteRegistry
extends AbstractRouteRegistry
```
SessionRouteRegistry is a mutable route registry that is valid in the scope of VaadinSession. Routes can be added and removed from this registry and any overlap with the registered routes between session and global scope will be handled so that session scope paths overrides global paths.

Since:

1.3

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.vaadin.flow.router.internal.AbstractRouteRegistry
  AbstractRouteRegistry.Configuration

Method Summary

All Methods
Modifier and Type	Method and Description
`Registration`	`addRoutesChangeListener(RoutesChangedListener listener)` Adds the given route change listener to the registry.
`NavigationRouteTarget`	`getNavigationRouteTarget(String url)` Search for a route target using given navigation `url` argument.
`Optional<Class<? extends Component>>`	`getNavigationTarget(String url)` Gets the optional navigation target class for a given path.
`Optional<Class<? extends Component>>`	`getNavigationTarget(String url, List<String> segments)` Gets the optional navigation target class for a given Location matching with path segments.
`List<RouteData>`	`getRegisteredRoutes()` Get the `RouteData` for all registered navigation targets.
`List<Class<? extends RouterLayout>>`	`getRouteLayouts(String path, Class<? extends Component> navigationTarget)` Deprecated. instead use `getNavigationRouteTarget(String)` and retrieve the list of route layouts from the `RouteTarget` contained in the `NavigationRouteTarget`.
`RouteTarget`	`getRouteTarget(Class<? extends Component> target, RouteParameters parameters)` Gets the `RouteTarget` instance matching the given target component and route parameters.
`static RouteRegistry`	`getSessionRegistry(VaadinSession session)` Get the session registry for VaadinSession.
`Optional<String>`	`getTargetUrl(Class<? extends Component> navigationTarget)` Get the url string for given navigation target.
`Optional<String>`	`getTargetUrl(Class<? extends Component> navigationTarget, RouteParameters parameters)` Get the url string for given navigation target.
`Optional<String>`	`getTemplate(Class<? extends Component> navigationTarget)` Get the main template for given navigation target.

Methods inherited from class com.vaadin.flow.router.internal.AbstractRouteRegistry
addErrorTarget, clean, configure, fireEvent, getConfiguration, hasLock, removeRoute, removeRoute, removeRoute, searchByCause, searchBySuperType, setRoute, update

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

- Method Detail
  - getSessionRegistry
```
public static RouteRegistry getSessionRegistry(VaadinSession session)
```
    Get the session registry for VaadinSession. If no SessionRegistry exists then one will be created for given VaadinSession.
    
    Parameters:
    
    session - vaadin session to get registry for
    
    Returns:
    
    session registry for given session
  - getRegisteredRoutes
```
public List<RouteData> getRegisteredRoutes()
```
    Description copied from interface: RouteRegistry
    
    Get the RouteData for all registered navigation targets.
    
    Specified by:
    
    getRegisteredRoutes in interface RouteRegistry
    
    Overrides:
    
    getRegisteredRoutes in class AbstractRouteRegistry
    
    Returns:
    
    list of routes available for this registry
  - addRoutesChangeListener
```
public Registration addRoutesChangeListener(RoutesChangedListener listener)
```
    Adds the given route change listener to the registry.
    For the session scoped registry also changes to the application scoped registry will be delegated to the listener if the added or removed route was not masked by a registration in the session scope.
    
    Specified by:
    
    addRoutesChangeListener in interface RouteRegistry
    
    Overrides:
    
    addRoutesChangeListener in class AbstractRouteRegistry
    
    Parameters:
    
    listener - listener to add
    
    Returns:
    
    registration to remove the listener
  - getNavigationRouteTarget
```
public NavigationRouteTarget getNavigationRouteTarget(String url)
```
    Description copied from interface: RouteRegistry
    
    Search for a route target using given navigation url argument.
    
    Specified by:
    
    getNavigationRouteTarget in interface RouteRegistry
    
    Overrides:
    
    getNavigationRouteTarget in class AbstractRouteRegistry
    
    Parameters:
    
    url - the navigation url used to search a route target.
    
    Returns:
    
    a NavigationRouteTarget instance containing the RouteTarget and RouteParameters extracted from the url argument according with the route configuration.
  - getRouteTarget
```
public RouteTarget getRouteTarget(Class<? extends Component> target,
                                  RouteParameters parameters)
```
    Description copied from interface: RouteRegistry
    
    Gets the RouteTarget instance matching the given target component and route parameters.
    
    Specified by:
    
    getRouteTarget in interface RouteRegistry
    
    Overrides:
    
    getRouteTarget in class AbstractRouteRegistry
    
    Parameters:
    
    target - a component class which is a navigation target.
    
    parameters - parameter values that may be used with given target.
    
    Returns:
    
    the RouteTarget instance matching the given target component and route parameters.
  - getNavigationTarget
```
public Optional<Class<? extends Component>> getNavigationTarget(String url)
```
    Description copied from interface: RouteRegistry
    
    Gets the optional navigation target class for a given path. Returns an empty optional if no navigation target corresponds to the given url.
    
    Specified by:
    
    getNavigationTarget in interface RouteRegistry
    
    Overrides:
    
    getNavigationTarget in class AbstractRouteRegistry
    
    Parameters:
    
    url - the path to get the navigation target for, not null
    
    Returns:
    
    optional of the navigation target corresponding to the given path
  - getNavigationTarget
```
public Optional<Class<? extends Component>> getNavigationTarget(String url,
                                                                List<String> segments)
```
    Description copied from interface: RouteRegistry
    
    Gets the optional navigation target class for a given Location matching with path segments.
    
    Specified by:
    
    getNavigationTarget in interface RouteRegistry
    
    Overrides:
    
    getNavigationTarget in class AbstractRouteRegistry
    
    Parameters:
    
    url - path to get navigation target for, not null
    
    segments - segments given for path
    
    Returns:
    
    optional navigation target corresponding to the given location with given segments if any applicable targets found.
    
    See Also:
    
    Location
  - getTargetUrl
```
public Optional<String> getTargetUrl(Class<? extends Component> navigationTarget)
```
    Description copied from interface: RouteRegistry
    
    Get the url string for given navigation target.
    
    Specified by:
    
    getTargetUrl in interface RouteRegistry
    
    Overrides:
    
    getTargetUrl in class AbstractRouteRegistry
    
    Parameters:
    
    navigationTarget - navigation target to get registered route for, not null
    
    Returns:
    
    Optional navigation target url string or Optional.empty() if navigation target was not found
  - getTargetUrl
```
public Optional<String> getTargetUrl(Class<? extends Component> navigationTarget,
                                     RouteParameters parameters)
```
    Description copied from interface: RouteRegistry
    
    Get the url string for given navigation target.
    
    Specified by:
    
    getTargetUrl in interface RouteRegistry
    
    Overrides:
    
    getTargetUrl in class AbstractRouteRegistry
    
    Parameters:
    
    navigationTarget - navigation target to get registered route for, not null
    
    parameters - parameters for the target url.
    
    Returns:
    
    Optional navigation target url string or Optional.empty() if navigation target was not found
  - getTemplate
```
public Optional<String> getTemplate(Class<? extends Component> navigationTarget)
```
    Description copied from interface: RouteRegistry
    
    Get the main template for given navigation target.
    In case of annotated target the main template is composed of the Route annotation value prefixed by all RoutePrefix values of the parent RouterLayouts chain.
    
    Specified by:
    
    getTemplate in interface RouteRegistry
    
    Overrides:
    
    getTemplate in class AbstractRouteRegistry
    
    Parameters:
    
    navigationTarget - navigation target to get route definition for, not null
    
    Returns:
    
    Optional navigation target template string or Optional.empty() if navigation target was not found
  - getRouteLayouts
```
@Deprecated
public List<Class<? extends RouterLayout>> getRouteLayouts(String path,
                                                                       Class<? extends Component> navigationTarget)
```
    Deprecated. instead use getNavigationRouteTarget(String) and retrieve the list of route layouts from the RouteTarget contained in the NavigationRouteTarget.
    
    Description copied from interface: RouteRegistry
    
    Get the layout chain for given navigation target on the targeted path.
    This chain may be pre-defined or generated from annotation data.
    
    Specified by:
    
    getRouteLayouts in interface RouteRegistry
    
    Overrides:
    
    getRouteLayouts in class AbstractRouteRegistry
    
    Parameters:
    
    path - path to use for resolving chain
    
    navigationTarget - navigation target to get layout chain for
    
    Returns:
    
    layout chain of target
    
    See Also:
    
    RouteTarget.getParentLayouts()

com.vaadin.flow.server.

Class SessionRouteRegistry

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.router.internal.AbstractRouteRegistry

Method Summary

Methods inherited from class com.vaadin.flow.router.internal.AbstractRouteRegistry

Methods inherited from class java.lang.Object

Method Detail

getSessionRegistry

getRegisteredRoutes

addRoutesChangeListener

getNavigationRouteTarget

getRouteTarget

getNavigationTarget

getNavigationTarget

getTargetUrl

getTargetUrl

getTemplate

getRouteLayouts