Package com.vaadin.flow.di

Interface ResourceProvider

  • All Known Implementing Classes:
    LookupInitializer.ResourceProviderImpl
    public interface ResourceProvider
    Static "classpath" resources provider.

    This is SPI to access resources available at runtime. Depending on the web container this can be an application classpath only or bundles which are identified by the provided context.

    Since:
    Author:
    Vaadin Ltd

    • Method Detail

      • getApplicationResource

        URL getApplicationResource​(String path)
        Gets the resource identified by path located in the application bundle (jar) which may be found using this resource provider instance.

        If the provider doesn't contain any information about application bundle or there is no resource with the given path then this method returns null.

        Parameters:
        path - the resource path
        Returns:
        an URL of the resource, may be null

      • getApplicationResources

        List<URL> getApplicationResources​(String path)
                           throws IOException
        Gets all the resources identified by path located in in the application bundle (jar) which may be found using this resource provider.

        If the provider doesn't contain any information about application bundle or there is no resource with the given path then this method returns an empty list.

        Parameters:
        path - the resource path
        Returns:
        a list of URLs of the resources or an empty list if resources are not found
        Throws:
        IOException - if there is an I/O error

      • getClientResource

        URL getClientResource​(String path)
        Gets "flow-client" bundle resource identified by the path.
        Parameters:
        path - the resource path
        Returns:
        an URL of the resource, may be null

      • getClientResourceAsStream

        InputStream getClientResourceAsStream​(String path)
                               throws IOException
        Gets "flow-client" bundle resource content identified by the path.
        Parameters:
        path - the resource path
        Returns:
        an URL of the resource, may be null
        Throws:
        IOException - If there is an I/O error.