ru.vyarus.guicey.gsp.app.asset

Class AssetLookup

java.lang.Object

ru.vyarus.guicey.gsp.app.asset.AssetLookup

All Implemented Interfaces:

java.io.Serializable

public class AssetLookup
extends java.lang.Object
implements java.io.Serializable

Assets are stored in classpath. Multiple classpath locations could be mapped for assets (overriding default location). Some assets could be mapped into exact urls (with ability to override too).

Since:

26.11.2019

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AssetLookup(java.lang.String primaryLocation, com.google.common.collect.Multimap<java.lang.String,java.lang.String> locations)

Method Summary

Modifier and Type	Method and Description
com.google.common.collect.Multimap<java.lang.String,java.lang.String>	getLocations()
java.util.List<java.lang.String>	getMatchingLocations(java.lang.String path) Supposed to be used for error reporting.
java.lang.String	getPrimaryLocation()
java.lang.String	getRelativePath(java.lang.String path) Checks if provided path is absolute path into primary location and returns relative url instead.
java.lang.String	lookup(java.lang.String path) Lookup asset in classpath by url (relative to application root).

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetLookup

public AssetLookup(java.lang.String primaryLocation,
                   com.google.common.collect.Multimap<java.lang.String,java.lang.String> locations)

Method Detail

getPrimaryLocation

public java.lang.String getPrimaryLocation()

Returns:

main application assets classpath path

getLocations

public com.google.common.collect.Multimap<java.lang.String,java.lang.String> getLocations()

Returns:

assets mapping paths

getRelativePath

public java.lang.String getRelativePath(java.lang.String path)

Checks if provided path is absolute path into primary location and returns relative url instead.

Parameters:

path - possibly absolute path

Returns:

relative path (without primary loctation part if detected)

lookup

public java.lang.String lookup(java.lang.String path)

Lookup asset in classpath by url (relative to application root). Assets, registered to exact url are processed in priority. For example, if assets registered for '/foo/bar/' path then url '/foo/bar/sample.css' will be checked first in url-specific assets. Multiple asset packages copuld be configured on each url: assets checked in registration-reverse order to grant regitstration order priority (resources from package, registered later are prioritized).

Parameters:

path - path to find asset for

Returns:

classpath path to resource or null if resource not found

getMatchingLocations

public java.util.List<java.lang.String> getMatchingLocations(java.lang.String path)

Supposed to be used for error reporting. Return locations in package notion.

Parameters:

path - url relative to application root

Returns:

matching classpath locations (not where resource is found, but where it is searched)