org.wikimedia.eventutilities.core.util

Class ResourceLoader

java.lang.Object

org.wikimedia.eventutilities.core.util.ResourceLoader

public class ResourceLoader
extends Object

Loads resource content at URIs. How the resource is loaded depends on the configured loader functions for a URL protocol scheme. Usage:

     ResourceLoader resourceLoader = ResourceLoader.builder()
          .setBaseUrls(Arrays.asList(
              new URL

 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceLoader.Builder Builder class for ResouceLoader.

Constructor Summary

Constructors

Constructor and Description
ResourceLoader(Map<String,Function<URI,byte[]>> loaders, Function<URI,byte[]> defaultLoader, List<URL> baseUrls)

Method Summary

Modifier and Type	Method and Description
static URL	asURL(String u) Helper function to convert a String url to a URL.
static List<URL>	asURLs(Collection<String> baseUrls) Helper function to convert a List of String urls to URLs.
static ResourceLoader.Builder	builder() Returns a ResourceLoader.Builder.
List<URI>	getPossibleResourceUris(URI uri) If the uri is aboslute, or if no baseUris are set, the only possible uri is the provided one.
byte[]	load(URI uri) Loads the resource at uri, potentially prefixing relative URIs with baseUrls.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ResourceLoader

public ResourceLoader(Map<String,Function<URI,byte[]>> loaders,
                      Function<URI,byte[]> defaultLoader,
                      List<URL> baseUrls)

Parameters:

loaders - Map of URI protocol/scheme (e.g. file, http, https, etc.) to Function that takes a URI and returns a byte[] of the content at the URI.

defaultLoader - Default loader to use if no loader exists for the URI's scheme.

baseUrls - baseUrls prefixes that act like a relative URI search path. When loading a uri, if that uri is relative, each baseUrl will be prefixed to it and then attempted to be loaded. Whichever baseUrl + uri successfully loads first will be returned.

Method Detail

load

public byte[] load(URI uri)
            throws ResourceLoadingException

Loads the resource at uri, potentially prefixing relative URIs with baseUrls.

Parameters:

uri - URI

Returns:

contents as bute[] at uri

Throws:

ResourceLoadingException

getPossibleResourceUris

public List<URI> getPossibleResourceUris(URI uri)

If the uri is aboslute, or if no baseUris are set, the only possible uri is the provided one. Else, the uri will be prefixed with each of the baseUris.

builder

public static ResourceLoader.Builder builder()

Returns a ResourceLoader.Builder.

asURL

public static URL asURL(String u)

Helper function to convert a String url to a URL.

asURLs

public static List<URL> asURLs(Collection<String> baseUrls)

Helper function to convert a List of String urls to URLs.

toString

public String toString()

Overrides:

toString in class Object