com.vaadin.flow.shared.VaadinUriResolver API 12.0.0.alpha5 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.6.4 for the latest.

com.vaadin.flow.shared.

java.lang.Object
- com.vaadin.flow.shared.VaadinUriResolver

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BootstrapHandler.BootstrapUriResolver, ServiceContextUriResolver
```
public abstract class VaadinUriResolver
extends Object
implements Serializable
```
Utility for translating special Vaadin URIs into URLs usable by the browser. This is an abstract class performing the main logic in resolveVaadinUri(String, String, String).
Concrete implementations of this class should implement Serializable in case a reference to an object of this class is stored on the server side.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

VaadinUriResolver()

Method Summary

All Methods
Modifier and Type	Method and Description
`protected String`	`resolveVaadinUri(String uri, String frontendUrl, String servletToContextRoot)` Translates a Vaadin URI to a URL that can be loaded by the browser.

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

- Constructor Detail
  - VaadinUriResolver
```
public VaadinUriResolver()
```
- Method Detail
  - resolveVaadinUri
```
protected String resolveVaadinUri(String uri,
                                  String frontendUrl,
                                  String servletToContextRoot)
```
    Translates a Vaadin URI to a URL that can be loaded by the browser. The following URI schemes are supported:
    - "context://" resolves to the application context root
    - "frontend://" - resolves to the build path where web components were compiled. Browsers supporting ES6 can receive different, more optimized files than browsers that only support ES5.
    - "base://" - resolves to the base URI of the page
    Any other URI protocols, such as http:// or https:// are passed through this method unmodified.
    
    Parameters:
    
    uri - the URI to resolve
    
    frontendUrl - the URL pointing to the path where the frontend files can be found. It is expected that different browsers receive different files depending on their capabilities. Can use the other protocols.
    
    servletToContextRoot - the relative path from the servlet path (used as base path in the client) to the context root
    
    Returns:
    
    the resolved URI