Interface UIResourceProvider

  • All Known Implementing Classes:
    BundleBasedUIResourceProvider, UIResourceRegistry

    public interface UIResourceProvider
    Defines a set of methos to load UI resources and resource paths from resource providers such as OSGi Bundles, registry, file system, etc.
    • Method Detail

      • getUIResource

        URL getUIResource​(String path)
        Returns a URL to the resource that is mapped to a specified path. The path must begin with a "/" and is interpreted as relative to the current context root. This method returns null if no resource is mapped to the pathname.
        Parameters:
        path - a String specifying the path to the resource
        Returns:
        the resource located at the named path, or null if there is no resource at that path
      • getUIResourcePaths

        Set<String> getUIResourcePaths​(String path)
        Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument. Paths indicating subdirectory paths end with a '/'. The returned paths are all relative to the root of resource provider and have a leading '/'. For example, for a resource provider containing /welcome.html /WEB_INF /WEB-INF/web.xml /WEB-INF/tiles /WEB-INF/tiles/main_defs.xml getResourcePaths("/") returns {"/welcome.html", "/WEB_INF"}. getResourcePaths("/WEB_INF/") returns {"/WEB-INF/web.xml", "/WEB-INF/tiles/"}. getResourcePaths("/WEB-INF/tiles/") returns {"/WEB-INF/tiles/main_defs.xml"}.
        Parameters:
        path - partial path used to match the resources, which must start with a /
        Returns:
        a Set containing the directory listing, or null if there are no resources whose path begins with the supplied path.