org.ametys.core.ui

Class RibbonManagerCache

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.RibbonManagerCache

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable

public class RibbonManagerCache
extends AbstractLogEnabled
implements Contextualizable, Serviceable, Component

Helper for RibbonManager, that support Thread safe usage of the managers, while implementing a cache for performances.

Field Summary

Fields

Modifier and Type	Field and Description
private ServiceManager	_cocoonManager
private Context	_context
private SourceResolver	_resolver
private Map<RibbonManager,RibbonConfiguration>	_ribbonConfigurationCache
private RibbonControlsManager	_ribbonControlsManager
private Map<String,RibbonManager>	_ribbonManagerCache
private Map<RibbonManager,Map<String,Long>>	_ribbonManagerCacheValidity
private Map<RibbonManager,Integer>	_ribbonManagerUsageCache
private Map<RibbonManager,ThreadSafeComponentManager<Object>>	_ribbonServiceManagers
private RibbonTabsManager	_ribbonTabsManager
static String	ROLE Avalon role

Constructor Summary

Constructors

Constructor and Description
RibbonManagerCache()

Method Summary

Modifier and Type	Method and Description
private RibbonManager	_createRibbonManager()
private void	_decreaseUsage(RibbonManager ribbonManager, boolean forceRemove)
private void	_increaseUsage(RibbonManager ribbonManager)
private boolean	_isRibbonEntryStillValid(Long cachedValidity, RibbonConfigurationSource ribbonEntrySource)
private boolean	_isRibbonManagerStillValid(RibbonManager ribbonManager)
void	addCachedConfiguration(RibbonManager ribbonManager, RibbonConfiguration configuration, Map<String,Long> importsValidity) Add a ribbon configuration to the cache
void	contextualize(Context context)
void	dispose(RibbonManager ribbonManager) Dispose of a RibbonManager that was previously retrieve with this helper
RibbonConfiguration	getCachedConfiguration(RibbonManager ribbonManager) Get the ribbon configuration managed by the RibbonManager
RibbonManager	getManager(String uri) Create the RibbonManager associated with the given ribbon file.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final String ROLE

Avalon role

_ribbonManagerCache

private Map<String,RibbonManager> _ribbonManagerCache

_ribbonManagerCacheValidity

private Map<RibbonManager,Map<String,Long>> _ribbonManagerCacheValidity

_ribbonManagerUsageCache

private Map<RibbonManager,Integer> _ribbonManagerUsageCache

_ribbonConfigurationCache

private Map<RibbonManager,RibbonConfiguration> _ribbonConfigurationCache

_ribbonServiceManagers

private Map<RibbonManager,ThreadSafeComponentManager<Object>> _ribbonServiceManagers

_context

private Context _context

_cocoonManager

private ServiceManager _cocoonManager

_ribbonControlsManager

private RibbonControlsManager _ribbonControlsManager

_ribbonTabsManager

private RibbonTabsManager _ribbonTabsManager

_resolver

private SourceResolver _resolver

Constructor Detail

RibbonManagerCache

public RibbonManagerCache()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getManager

public RibbonManager getManager(String uri)
                         throws Exception

Create the RibbonManager associated with the given ribbon file. If the RibbonManager already exists for the ribbon file and is still valid, it is simply returned.

Parameters:

uri - The ribbon configuration uri

Returns:

The RibbonManager

Throws:

Exception - If an error occurs

_isRibbonManagerStillValid

private boolean _isRibbonManagerStillValid(RibbonManager ribbonManager)

_isRibbonEntryStillValid

private boolean _isRibbonEntryStillValid(Long cachedValidity,
                                         RibbonConfigurationSource ribbonEntrySource)

_createRibbonManager

private RibbonManager _createRibbonManager()
                                    throws Exception

Throws:

Exception

dispose

public void dispose(RibbonManager ribbonManager)

Dispose of a RibbonManager that was previously retrieve with this helper

Parameters:

ribbonManager - The ribbon manager

_increaseUsage

private void _increaseUsage(RibbonManager ribbonManager)

_decreaseUsage

private void _decreaseUsage(RibbonManager ribbonManager,
                            boolean forceRemove)

getCachedConfiguration

public RibbonConfiguration getCachedConfiguration(RibbonManager ribbonManager)

Get the ribbon configuration managed by the RibbonManager

Parameters:

ribbonManager - The ribbon manager

Returns:

The configuration, or null if no configuration was cached

addCachedConfiguration

public void addCachedConfiguration(RibbonManager ribbonManager,
                                   RibbonConfiguration configuration,
                                   Map<String,Long> importsValidity)

Add a ribbon configuration to the cache

Parameters:

ribbonManager - The ribbon manager

configuration - The configuration

importsValidity - The list of imports for this ribbon configuration and their validity