Package org.ametys.plugins.linkdirectory

Class LinkDirectoryColorsComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.linkdirectory.LinkDirectoryColorsComponent

All Implemented Interfaces:

LogEnabled, Initializable, Component, Configurable, Serviceable

public class LinkDirectoryColorsComponent
extends AbstractLogEnabled
implements Component, Serviceable, Configurable, Initializable

Component listing the available colors for a link

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LinkDirectoryColorsComponent.ColorsConfiguration	Class representing a colors configuration
static class	LinkDirectoryColorsComponent.LinkDirectoryReloader	Class representing a link directory reloader

Field Summary

Fields

Modifier and Type	Field	Description
protected LinkDirectoryColorsComponent.ColorsConfiguration	_colorsConfiguration	The colors configuration
protected FileReloaderUtils	_fileReloaderUtils	The file reloader utils
protected SiteManager	_siteManager	The site manager
protected static final String	COLOR_SKIN_CACHE	The color skin cache id
static final String	ROLE	The component role

Constructor Summary

Constructors

Constructor	Description
LinkDirectoryColorsComponent()

Method Summary

Modifier and Type	Method	Description
protected LinkDirectoryColorsComponent.ColorsConfiguration	_getColorsFromSkin(String siteName)	Get colors configuration from skin
protected LinkDirectoryColorsComponent.ColorsConfiguration	_parseColors(Configuration configuration)	Parse colors from configuration
void	configure(Configuration configuration)
Map<String,Map<String,String>>	getColors(String siteName)	Get colors from site name
String	getDefaultKey(String siteName)	Get the default color key
void	initialize()
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 Details

ROLE

public static final String ROLE

The component role

COLOR_SKIN_CACHE

protected static final String COLOR_SKIN_CACHE

The color skin cache id

_siteManager

protected SiteManager _siteManager

The site manager

_fileReloaderUtils

protected FileReloaderUtils _fileReloaderUtils

The file reloader utils

_colorsConfiguration

protected LinkDirectoryColorsComponent.ColorsConfiguration _colorsConfiguration

The colors configuration

Constructor Details

LinkDirectoryColorsComponent

public LinkDirectoryColorsComponent()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

getColors

public Map<String,Map<String,String>> getColors(String siteName)

Get colors from site name

Parameters:

siteName - the site name

Returns:

the map of colors

getDefaultKey

public String getDefaultKey(String siteName)

Get the default color key

Parameters:

siteName - the site name

Returns:

the default key

_parseColors

protected LinkDirectoryColorsComponent.ColorsConfiguration _parseColors(Configuration configuration)
                                                                 throws ConfigurationException

Parse colors from configuration

Parameters:

configuration - the configuration

Returns:

the colors configuration

Throws:

ConfigurationException - if a configuration error occurred

_getColorsFromSkin

protected LinkDirectoryColorsComponent.ColorsConfiguration _getColorsFromSkin(String siteName)

Get colors configuration from skin

Parameters:

siteName - the site name

Returns:

the colors configuration