io.stallion.assets

Class AssetsController

java.lang.Object

io.stallion.assets.AssetsController

public class AssetsController
extends Object

Manages assets that can be included on web pages. Takes care of cache-busting URL's and asset bundling

Constructor Summary

Constructors

Constructor and Description
AssetsController()

Method Summary

Modifier and Type	Method and Description
String	bundle(String fileName) Output the HTML required to render a bundle of assets.
String	bundle(String plugin, String path)
static String	ensureSafeAssetsPath(String path)
Long	getCurrentTimeStampForAssetFile(String path)
static HashMap<String,Long>	getTimeStampByPath()
Long	getTimeStampForAssetFile(String path)
AssetsControllerSafeWrapper	getWrapper()
static AssetsController	instance()
static AssetsController	load()
String	pageFooterLiterals() Turn a list of additional strings that should be in the Footer section of the page and return as a string
String	pageHeadLiterals() Turn a list of additional strings that should be in the HEAD section of the page and return as a string
String	resource(String path) Loads a resource from the main stallion jar.
String	resource(String path, String plugin)
String	resource(String path, String plugin, String developerUrl) Get the URL to access an asset file that is bundled in the jar as a resource.
static void	setTimeStampByPath(HashMap<String,Long> timeStampByPath)
static void	shutdown()
String	url(String path) Get the URL for an asset file, with a timestamp added for cache busting.
static AssetsControllerSafeWrapper	wrapper() Get a wrapper for the asset controller with limited methods.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetsController

public AssetsController()

Method Detail

instance

public static AssetsController instance()

ensureSafeAssetsPath

public static String ensureSafeAssetsPath(String path)

wrapper

public static AssetsControllerSafeWrapper wrapper()

Get a wrapper for the asset controller with limited methods. This is used by the template context and other sandboxed situations.

Returns:

load

public static AssetsController load()

shutdown

public static void shutdown()

getTimeStampByPath

public static HashMap<String,Long> getTimeStampByPath()

setTimeStampByPath

public static void setTimeStampByPath(HashMap<String,Long> timeStampByPath)

resource

public String resource(String path)

Loads a resource from the main stallion jar.

Parameters:

path -

Returns:

resource

public String resource(String path,
                       String plugin)

resource

public String resource(String path,
                       String plugin,
                       String developerUrl)

Get the URL to access an asset file that is bundled in the jar as a resource.

Parameters:

path - - the path, relative to the assets folder in side the resource directory

plugin - - the plugin from which you are loading the resource, use "stallion" to load from the main jar

developerUrl - - an alternative URL to use in development mode. Useful if you want to point you local nginx directly at the file, so you can see your changes without recompiling.

Returns:

pageFooterLiterals

public String pageFooterLiterals()

Turn a list of additional strings that should be in the Footer section of the page and return as a string

Returns:

pageHeadLiterals

public String pageHeadLiterals()

Turn a list of additional strings that should be in the HEAD section of the page and return as a string

Returns:

bundle

public String bundle(String plugin,
                     String path)

bundle

public String bundle(String fileName)

Output the HTML required to render a bundle of assets. *

Parameters:

fileName -

Returns:

url

public String url(String path)

Get the URL for an asset file, with a timestamp added for cache busting.

Parameters:

path -

Returns:

getTimeStampForAssetFile

public Long getTimeStampForAssetFile(String path)

getCurrentTimeStampForAssetFile

public Long getCurrentTimeStampForAssetFile(String path)

getWrapper

public AssetsControllerSafeWrapper getWrapper()