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
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() Convenience constructor that will form a locator for all resources on the current class path.
WebJarAssetLocator(java.util.SortedMap<java.lang.String,java.lang.String> fullPathIndex) Establish a locator given an index that it should use.

Method Summary

Modifier and Type	Method and Description
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.util.SortedMap<java.lang.String,java.lang.String>	getFullPathIndex()
static java.util.SortedMap<java.lang.String,java.lang.String>	getFullPathIndex(java.util.regex.Pattern filterExpr, java.lang.ClassLoader... classLoaders) Return a map that can be used to perform index lookups of partial file paths.
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.util.Set<java.lang.String>	listAssets(java.lang.String folderPath) List assets within a folder.

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

Constructor Detail

WebJarAssetLocator

public WebJarAssetLocator()

Convenience constructor that will form a locator for all resources on the current class path.

WebJarAssetLocator

public WebJarAssetLocator(java.util.SortedMap<java.lang.String,java.lang.String> fullPathIndex)

Establish a locator given an index that it should use.

Parameters:

fullPathIndex - the index to use.

Method Detail

getFullPathIndex

public static java.util.SortedMap<java.lang.String,java.lang.String> getFullPathIndex(java.util.regex.Pattern filterExpr,
                                                                                      java.lang.ClassLoader... classLoaders)

Return a map that can be used to perform index lookups of partial file paths. This index constitutes a key that is the reverse form of the path it relates to. Thus if a partial lookup needs to be performed from the rightmost path components then the key to access can be expressed easily e.g. the path "a/b" would be the map tuple "b/a" -> "a/b". If we need to look for an asset named "a" without knowing the full path then we can perform a partial lookup on the sorted map.

Parameters:

filterExpr - the regular expression to be used to filter resources that will be included in the index.

classLoaders - the class loaders to be considered for loading the resources from.

Returns:

the index.

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

getFullPathIndex

public java.util.SortedMap<java.lang.String,java.lang.String> getFullPathIndex()

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. Must begin with '/'.

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

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