org.webjars

Class WebJarAssetLocator

java.lang.Object

org.webjars.WebJarAssetLocator

public class WebJarAssetLocator
extends java.lang.Object

Locate WebJar assets. The class is thread safe.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,org.webjars.WebJarAssetLocator.WebJarInfo>	allWebJars
static java.lang.String	WEBJARS_PACKAGE The webjar package name.
static java.lang.String	WEBJARS_PATH_PREFIX The path to where webjar resources live.

Constructor Summary

Constructors

Constructor and Description
WebJarAssetLocator()
WebJarAssetLocator(java.lang.ClassLoader classLoader)
WebJarAssetLocator(java.lang.ClassLoader classLoader, java.lang.String... whitelistPaths)
WebJarAssetLocator(java.util.Map<java.lang.String,org.webjars.WebJarAssetLocator.WebJarInfo> allWebJars)
WebJarAssetLocator(java.lang.String... whitelistPaths)

Method Summary

Modifier and Type	Method and Description
protected static java.util.Map<java.lang.String,org.webjars.WebJarAssetLocator.WebJarInfo>	findWebJars(io.github.classgraph.ScanResult scanResult)
java.lang.String	getFullPath(java.lang.String partialPath) Given a distinct path within the WebJar index passed in return the full path of the resource.
java.lang.String	getFullPath(java.lang.String webjar, java.lang.String partialPath) Returns the full path of an asset within a specific WebJar
java.lang.String	getFullPathExact(java.lang.String webJarName, java.lang.String exactPath) Returns the full path of an asset within a specific WebJar
static java.util.Map.Entry<java.lang.String,java.lang.String>	getWebJar(java.lang.String path)
java.util.Map<java.lang.String,java.lang.String>	getWebJars()
java.lang.String	groupId(java.lang.String fullPath) Gets the Group ID given a fullPath
java.util.Set<java.lang.String>	listAssets()
java.util.Set<java.lang.String>	listAssets(java.lang.String folderPath) List assets within a folder.
protected static io.github.classgraph.ResourceList	webJarResources(java.lang.String webJarName, io.github.classgraph.ResourceList resources)
protected static java.lang.String	webJarVersion(java.lang.String webJarName, io.github.classgraph.ResourceList resources)

Methods inherited from class java.lang.Object

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

Field Detail

WEBJARS_PACKAGE

public static final java.lang.String WEBJARS_PACKAGE

The webjar package name.

See Also:

Constant Field Values

WEBJARS_PATH_PREFIX

public static final java.lang.String WEBJARS_PATH_PREFIX

The path to where webjar resources live.

See Also:

Constant Field Values

allWebJars

protected final java.util.Map<java.lang.String,org.webjars.WebJarAssetLocator.WebJarInfo> allWebJars

Constructor Detail

WebJarAssetLocator

public WebJarAssetLocator()

WebJarAssetLocator

public WebJarAssetLocator(java.lang.ClassLoader classLoader)

WebJarAssetLocator

public WebJarAssetLocator(java.lang.String... whitelistPaths)

WebJarAssetLocator

public WebJarAssetLocator(java.lang.ClassLoader classLoader,
                          java.lang.String... whitelistPaths)

WebJarAssetLocator

public WebJarAssetLocator(java.util.Map<java.lang.String,org.webjars.WebJarAssetLocator.WebJarInfo> allWebJars)

Method Detail

webJarResources

protected static io.github.classgraph.ResourceList webJarResources(java.lang.String webJarName,
                                                                   io.github.classgraph.ResourceList resources)

webJarVersion

protected static java.lang.String webJarVersion(java.lang.String webJarName,
                                                io.github.classgraph.ResourceList resources)

findWebJars

protected static java.util.Map<java.lang.String,org.webjars.WebJarAssetLocator.WebJarInfo> findWebJars(io.github.classgraph.ScanResult scanResult)

getWebJar

public static java.util.Map.Entry<java.lang.String,java.lang.String> getWebJar(java.lang.String path)

Parameters:

path - The full WebJar path

Returns:

A WebJar tuple (Entry) with key = id and value = version

getFullPath

public java.lang.String getFullPath(java.lang.String partialPath)

Given a distinct path within the WebJar index passed in return the full path of the resource.

Parameters:

partialPath - the path to return e.g. "jquery.js" or "abc/someother.js". This must be a distinct path within the index passed in.

Returns:

a fully qualified path to the resource.

getFullPath

public java.lang.String getFullPath(java.lang.String webjar,
                                    java.lang.String partialPath)

Returns the full path of an asset within a specific WebJar

Parameters:

webjar - The id of the WebJar to search

partialPath - The partial path to look for

Returns:

a fully qualified path to the resource

getFullPathExact

public java.lang.String getFullPathExact(java.lang.String webJarName,
                                         java.lang.String exactPath)

Returns the full path of an asset within a specific WebJar

Parameters:

webJarName - The id of the WebJar to search

exactPath - The exact path of the file within the WebJar

Returns:

a fully qualified path to the resource

listAssets

public java.util.Set<java.lang.String> listAssets()

listAssets

public java.util.Set<java.lang.String> listAssets(java.lang.String folderPath)

List assets within a folder.

Parameters:

folderPath - the root path to the folder.

Returns:

a set of folder paths that match.

getWebJars

public java.util.Map<java.lang.String,java.lang.String> getWebJars()

Returns:

A map of the WebJars based on the files in the CLASSPATH where the key is the artifactId and the value is the version

groupId

public java.lang.String groupId(java.lang.String fullPath)

Gets the Group ID given a fullPath

Parameters:

fullPath - the fullPath to the asset in a WebJar, i.e. META-INF/resources/webjars/jquery/2.1.0/jquery.js

Returns:

the Group ID for the WebJar or null if it can't be determined