Package org.ametys.plugins.linkdirectory

Class LinkDirectoryInputData

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.linkdirectory.LinkDirectoryInputData

All Implemented Interfaces:

InputData, Initializable, Contextualizable, LogEnabled, Serviceable

public class LinkDirectoryInputData
extends AbstractLogEnabled
implements Contextualizable, InputData, Initializable, Serviceable

Input data for the link directory user preferences in thumbnails mode

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	LinkDirectoryInputData.ThemeInputData

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__CONF_FILE_PATH	The path to the configuration file
private static String	__WILDCARD	The wildcard
private Map<String,String>	_configurationError
private Context	_context	The Avalon context
protected CurrentUserProvider	_currentUserProvider	The current user provider
private DirectoryHelper	_directoryHelper
private Map<String,Long>	_lastConfUpdate	The last time the file was loaded
private SourceResolver	_sourceResolver	Excalibur source resolver
private Map<String,List<LinkDirectoryInputData.ThemeInputData>>	_themesCache	Cache for themes: <skinId, List<theme info>>

Constructor Summary

Constructors

Constructor	Description
LinkDirectoryInputData()

Method Summary

Modifier and Type	Method	Description
private void	_cacheConfigurationValues(Source source, String skinId)	Read the configuration values and store them
private boolean	_filterByTemplate(LinkDirectoryInputData.ThemeInputData theme, String template)
private List<String>	_getConfiguredThemes(LinkDirectoryInputData.ThemeInputData themeInputData, String lang)	Retrieve the configured themes names defined in the skin file link-directory.xml for the current input data and the current language
private String	_getSkin(Request request)	Get the current skin
private String	_getTemplate(Request request)	Get the current template
private List<LinkDirectoryInputData.ThemeInputData>	_getThemesForSkinAndTemplate(String skinId, String template)
private void	_saxLinks(ContentHandler contentHandler, UserIdentity user, Request request, List<String> themeIds, boolean displayUserLinks, String specificContext)
private void	_saxThemes(ContentHandler contentHandler, List<String> themeIds, List<String> unknownThemesNames)
private void	_updateConfigurationValues(String skinId)	Update the configuration values : read them if the map is empty, update them if the file was changed or simply return them
void	contextualize(Context context)
void	initialize()
boolean	isCacheable(Site site, Page currentPage)	Returns true if this InputData is cacheable for the current site and if possible page.
void	service(ServiceManager manager)
void	toSAX(ContentHandler contentHandler)	Generates SAX events for providing data.

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.web.inputdata.InputData

shouldBeCached

Field Detail

__CONF_FILE_PATH

private static final String __CONF_FILE_PATH

The path to the configuration file

See Also:

Constant Field Values

__WILDCARD

private static final String __WILDCARD

The wildcard

See Also:

Constant Field Values

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_context

private Context _context

The Avalon context

_sourceResolver

private SourceResolver _sourceResolver

Excalibur source resolver

_directoryHelper

private DirectoryHelper _directoryHelper

_themesCache

private Map<String,List<LinkDirectoryInputData.ThemeInputData>> _themesCache

Cache for themes: <skinId, List<theme info>>

_configurationError

private Map<String,String> _configurationError

_lastConfUpdate

private Map<String,Long> _lastConfUpdate

The last time the file was loaded

Constructor Detail

LinkDirectoryInputData

public LinkDirectoryInputData()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

isCacheable

public boolean isCacheable(Site site,
                           Page currentPage)

Description copied from interface: InputData

Returns true if this InputData is cacheable for the current site and if possible page.

Specified by:

isCacheable in interface InputData

Parameters:

site - the current Site.

currentPage - the current Page. Can be null.

Returns:

true if this InputData is cacheable for the current site or page.

toSAX

public void toSAX(ContentHandler contentHandler)
           throws ProcessingException

Description copied from interface: InputData

Generates SAX events for providing data.

Specified by:

toSAX in interface InputData

Parameters:

contentHandler - the content handler to SAX into.

Throws:

ProcessingException - if an error occurs during processing.

_saxThemes

private void _saxThemes(ContentHandler contentHandler,
                        List<String> themeIds,
                        List<String> unknownThemesNames)
                 throws SAXException

Throws:

SAXException

_saxLinks

private void _saxLinks(ContentHandler contentHandler,
                       UserIdentity user,
                       Request request,
                       List<String> themeIds,
                       boolean displayUserLinks,
                       String specificContext)
                throws ProcessingException

Throws:

ProcessingException

_getConfiguredThemes

private List<String> _getConfiguredThemes(LinkDirectoryInputData.ThemeInputData themeInputData,
                                          String lang)

Retrieve the configured themes names defined in the skin file link-directory.xml for the current input data and the current language

Parameters:

themeInputData - Can be an empty String

lang - language to filter by. Themes with lang=null will always be returned.

Returns:

the list of configured themes ids, can be empty, cannot be null

_getThemesForSkinAndTemplate

private List<LinkDirectoryInputData.ThemeInputData> _getThemesForSkinAndTemplate(String skinId,
                                                                                 String template)

_filterByTemplate

private boolean _filterByTemplate(LinkDirectoryInputData.ThemeInputData theme,
                                  String template)

_updateConfigurationValues

private void _updateConfigurationValues(String skinId)
                                 throws Exception

Update the configuration values : read them if the map is empty, update them if the file was changed or simply return them

Parameters:

skinId - The skin

Throws:

Exception - if an exception occurs

_cacheConfigurationValues

private void _cacheConfigurationValues(Source source,
                                       String skinId)

Read the configuration values and store them

Parameters:

source - the file's source

skinId - The skin

_getTemplate

private String _getTemplate(Request request)

Get the current template

Parameters:

request - the request

Returns:

the current template

_getSkin

private String _getSkin(Request request)

Get the current skin

Parameters:

request - the request

Returns:

the current skin