Documentation versions (currently viewingVaadin 14)

You are viewing documentation for an older Vaadin version. View latest documentation

Query Parameters

It is possible to get any query parameters contained in a URL, for example ?name1=value1&name2=value2.

Use the getQueryParameters() method of a Location instance to access query parameters. You can obtain the Location instance through the BeforeEnterEvent parameter of the BeforeEnterObserver::beforeEnter or the BeforeEvent parameter of the HasUrlParameter::setParameter method.

A Location object represents a relative URL made up of path segments and query parameters, without the hostname, that is new Location ("book/search?keyword=Vaadin").

Example: Retrieving query parameters from a BeforeEvent.

public void setParameter(BeforeEvent event,
        @OptionalParameter String parameter) {

    Location location = event.getLocation();
    QueryParameters queryParameters = location.getQueryParameters();

    Map<String, List<String>> parametersMap = queryParameters
getQueryParameters() supports multiple values associated with the same key, for example will result in the corresponding map {"genre" : ["fiction", "classic"], "restrictions": ["16+"]}}.