com.vaadin.flow.server.

Class 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

    • 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

      • 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

      • getNavigationTarget

        public Optional<Class<? extends Component>> getNavigationTarget(String pathString)

        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 path.

        Note! If a path has been specifically removed from a registry it will not be served from possible higher lever registries either.

        Parameters:

        pathString - 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 pathString,
                                                                List<String> segments)

        Description copied from interface: RouteRegistry

        Gets the optional navigation target class for a given Location matching with path segments.

        Note! If a path has been specifically removed from a registry it will not be served from possible higher lever registries either.

        Parameters:

        pathString - 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.

        Will return Optional.empty is navigation target was not found.

        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