com.github.dandelion.core

Class Context

java.lang.Object

com.github.dandelion.core.Context

public class Context
extends Object

Holds the whole Dandelion context.

This class is in charge of discovering and storing several configuration points, such as the configured RequestCache implementation or the active AssetProcessors.

There should be only one instance of this class per JVM.

Since:

0.10.0

Author:

Thibault Duchateau

Constructor Summary

Constructors

Constructor and Description
Context(javax.servlet.FilterConfig filterConfig) Public constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
List<AssetProcessor>	getActiveProcessors()
AssetVersioningStrategy	getActiveVersioningStrategy()
Map<String,AssetLocator>	getAssetLocatorsMap()
AssetStorage	getAssetStorage()
List<BundleLoader>	getBundleLoaders()
BundleStorage	getBundleStorage()
RequestCache	getCache()
CacheManager	getCacheManager()
Configuration	getConfiguration()
Map<String,DebugMenu>	getDebugMenuMap()
Map<String,DebugPage>	getDebugPageMap()
HandlerChain	getPostHandlerChain()
HandlerChain	getPreHandlerChain()
AssetProcessorManager	getProcessorManager()
Map<String,AssetProcessor>	getProcessorsMap()
Cache<String,RequestFlashData>	getRequestFlashDataCache()
Map<String,AssetVersioningStrategy>	getVersioningStrategyMap()
void	init(javax.servlet.FilterConfig filterConfig) Performs all the required initializations of the Dandelion context.
void	initAssetLocators() Initializes all service providers of the AssetLocator SPI.
void	initAssetProcessors() Initializes all service providers of the AssetProcessor SPI and stores them all in the processorsMap.
void	initAssetStorage()
void	initAssetVersioning() Initializes the asset versioning for the whole application.
void	initBundleLoaders() Initializes the BundleLoaders in a particular order: First, the VendorBundleLoader which loads all "vendor bundles" Then, all service providers of the BundleLoader SPI present in the classpath Finally the DandelionBundleLoader which loads all "user bundles"
void	initBundleStorage() Initializes the BundleStorage by using all configured BundleLoaders.
void	initComponents()
void	initConfiguration(javax.servlet.FilterConfig filterConfig) Returns an implementation of ConfigurationLoader using the following strategy: Check first if the dandelion.confloader.class system property is set and tries to instantiate it Otherwise, instantiate the StandardConfigurationLoader which reads properties files
void	initDebugMenus()
void	initHandlers() Initializes the handler chains to be invoked in the DandelionFilter to preprocess requests and postprocess responses.
void	initMBean(javax.servlet.FilterConfig filterConfig) If JMX is enabled, initializes a MBean allowing to reload bundles and access cache.
void	initRequestCache() Initialize the service provider of RequestCache to use for caching.
void	initRequestFlashDataCache() Initialize the request flash data cache only if Thymeleaf is present in the classpath.
boolean	isDevProfileEnabled()
boolean	isProdProfileEnabled()

Methods inherited from class java.lang.Object

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

Constructor Detail

Context

public Context(javax.servlet.FilterConfig filterConfig)

Public constructor.

Parameters:

filterConfig - The servlet filter configuration.

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)

Performs all the required initializations of the Dandelion context.

Parameters:

filterConfig - The servlet filter configuration.

initComponents

public void initComponents()

initConfiguration

public void initConfiguration(javax.servlet.FilterConfig filterConfig)

Returns an implementation of ConfigurationLoader using the following strategy:

1. Check first if the dandelion.confloader.class system property is set and tries to instantiate it
2. Otherwise, instantiate the StandardConfigurationLoader which reads properties files

initAssetVersioning

public void initAssetVersioning()

Initializes the asset versioning for the whole application.

initBundleLoaders

public void initBundleLoaders()

Initializes the BundleLoaders in a particular order:

1. First, the VendorBundleLoader which loads all "vendor bundles"
2. Then, all service providers of the BundleLoader SPI present in the classpath
3. Finally the DandelionBundleLoader which loads all "user bundles"

initRequestFlashDataCache

public void initRequestFlashDataCache()

Initialize the request flash data cache only if Thymeleaf is present in the classpath.

initRequestCache

public void initRequestCache()

Initialize the service provider of RequestCache to use for caching.

initAssetLocators

public void initAssetLocators()

Initializes all service providers of the AssetLocator SPI. The order doesn't matter.

initAssetProcessors

public void initAssetProcessors()

Initializes all service providers of the AssetProcessor SPI and stores them all in the processorsMap.

If minification is enabled, the activeProcessors is filled with default service providers.

initBundleStorage

public void initBundleStorage()

Initializes the BundleStorage by using all configured BundleLoaders.

Once loader, some checks are performed on the BundleStorage.

initAssetStorage

public void initAssetStorage()

initMBean

public void initMBean(javax.servlet.FilterConfig filterConfig)

If JMX is enabled, initializes a MBean allowing to reload bundles and access cache.

Parameters:

filterConfig - The servlet filter configuration.

initHandlers

public void initHandlers()

Initializes the handler chains to be invoked in the DandelionFilter to preprocess requests and postprocess responses.

initDebugMenus

public void initDebugMenus()

destroy

public void destroy()

getCache

public RequestCache getCache()

Returns:

the selected asset caching system.

getProcessorsMap

public Map<String,AssetProcessor> getProcessorsMap()

Returns:

the map of all available AssetProcessor.

getBundleLoaders

public List<BundleLoader> getBundleLoaders()

getAssetLocatorsMap

public Map<String,AssetLocator> getAssetLocatorsMap()

Returns:

the map of all available AssetLocator.

getActiveProcessors

public List<AssetProcessor> getActiveProcessors()

getBundleStorage

public BundleStorage getBundleStorage()

getAssetStorage

public AssetStorage getAssetStorage()

getProcessorManager

public AssetProcessorManager getProcessorManager()

getCacheManager

public CacheManager getCacheManager()

getConfiguration

public Configuration getConfiguration()

Returns:

the Configuration store associated to the Dandelion Context .

isDevProfileEnabled

public boolean isDevProfileEnabled()

Returns:

true if the current Profile is set to "dev" or any other aliases present in Profile.DEV_ALIASES, false otherwise.

isProdProfileEnabled

public boolean isProdProfileEnabled()

Returns:

true if the current Profile is set to "prod" or any other aliases present in Profile.PROD_ALIASES, false otherwise.

getActiveVersioningStrategy

public AssetVersioningStrategy getActiveVersioningStrategy()

Returns:

the active AssetVersioningStrategy.

getVersioningStrategyMap

public Map<String,AssetVersioningStrategy> getVersioningStrategyMap()

Returns:

the map of all available AssetVersioningStrategy.

getPreHandlerChain

public HandlerChain getPreHandlerChain()

Returns:

the HandlerChain to be invoked in the DandelionFilter to preprocess requests.

getPostHandlerChain

public HandlerChain getPostHandlerChain()

Returns:

the HandlerChain to be invoked in the DandelionFilter to postprocess server responses.

getDebugMenuMap

public Map<String,DebugMenu> getDebugMenuMap()

getDebugPageMap

public Map<String,DebugPage> getDebugPageMap()

getRequestFlashDataCache

public Cache<String,RequestFlashData> getRequestFlashDataCache()