Package org.ametys.web.sitemap

Class SkinSitemapIconsProvider

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.web.sitemap.SkinSitemapIconsProvider

All Implemented Interfaces:

FileReloader, LogEnabled, SitemapIconsProvider, Initializable, Contextualizable, Serviceable

public class SkinSitemapIconsProvider
extends AbstractLogEnabled
implements SitemapIconsProvider, Initializable, Serviceable, FileReloader, Contextualizable

Implementation of SitemapIconsProvider for icons provided by skins

Field Summary

Fields

Modifier and Type	Field	Description
protected SkinsManager	_skinsManager	The skins manager
protected SourceResolver	_srcResolver	The source resolver

Constructor Summary

Constructors

Constructor	Description
SkinSitemapIconsProvider()

Method Summary

Modifier and Type	Method	Description
protected void	_createCaches()	Creates the caches
void	contextualize(Context context)
Set<SitemapTreeIndicator>	getIcons(String skinName)	Get the list of available icons
String	getId(String sourceUrl)	Get an unique ID for this File Reloader
void	initialize()
void	service(ServiceManager smanager)
void	updateFile(String sourceUrl, Source source, InputStream is)	Update the file, the sourceUrl is only there if you manage multiple files, the Configuration object is already present to read it

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

_skinsManager

protected SkinsManager _skinsManager

The skins manager

_srcResolver

protected SourceResolver _srcResolver

The source resolver

Constructor Details

SkinSitemapIconsProvider

public SkinSitemapIconsProvider()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

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

_createCaches

protected void _createCaches()

Creates the caches

getIcons

public Set<SitemapTreeIndicator> getIcons(String skinName)

Description copied from interface: SitemapIconsProvider

Get the list of available icons

Specified by:

getIcons in interface SitemapIconsProvider

Parameters:

skinName - name of the skin

Returns:

the list of available icons

updateFile

public void updateFile(String sourceUrl,
 Source source,
 InputStream is)
                throws Exception

Description copied from interface: FileReloader

Update the file, the sourceUrl is only there if you manage multiple files, the Configuration object is already present to read it

Specified by:

updateFile in interface FileReloader

Parameters:

sourceUrl - the url of the file.

source - the source to read, can be null if no file was read

is - the input stream to read, can be null if no file was read

Throws:

Exception - something went wrong while reading the inputstream

getId

public String getId(String sourceUrl)

Description copied from interface: FileReloader

Get an unique ID for this File Reloader

Specified by:

getId in interface FileReloader

Parameters:

sourceUrl - this is passed as an argument if your class read multiple files. If it reads only one file, the full class name can be a good enough ID

Returns:

an unique ID