Package org.ametys.web.skin

Class SkinsManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.skin.SkinsManager

All Implemented Interfaces:

Disposable, Initializable, Component, Contextualizable, LogEnabled, Serviceable, ThreadSafe

public class SkinsManager
extends AbstractLogEnabled
implements ThreadSafe, Serviceable, Component, Contextualizable, Initializable, Disposable

Manages the skins

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_cocoonContext	Cocoon context
protected Context	_context	Avalon context
protected Map<String,Path>	_externalSkins	The skins declared as external: name of the skin and file location
protected ServiceManager	_manager	The avalon service manager
protected Map<String,Path>	_resourcesSkins	The skins declared in jar files
protected SiteManager	_siteManager	The site manager
protected Map<Path,Skin>	_skins	A cache of skins objects classified by absolute path
protected SourceResolver	_sourceResolver	The excalibur source resolver
protected ViewAndParametersParser	_viewAndParametersParser	The view and parameters parser
protected ViewParameterTypeExtensionPoint	_viewParametersEP	The extension point for type of view parameter
protected ViewParametersManager	_viewParametersManager	The view parameters manager
static String	ROLE	The avalon role name

Constructor Summary

Constructors

Constructor	Description
SkinsManager()

Method Summary

Modifier and Type	Method	Description
private Path	_getPath(String path)
private boolean	_isASkinPath(Path skinDir)
private void	_listExternalSkins(String uri)
private void	_listResourcesSkins()
void	contextualize(Context context)
void	dispose()
(package private) Context	getContext()
List<Skin>	getDirectChildren(Skin skin)	Compute the skin that are directly derived from the given one
Path	getLocalSkinsLocation()	Get the skins location
(package private) ServiceManager	getServiceManager()
Skin	getSkin(String id)	Get a skin
List<Skin>	getSkinAndParents(Skin skin)	Get the skin and recursively its parents skins in the right weight order
String	getSkinNameFromRequest()	Get the skin name from request or null if not found
String	getSkinNameFromRequest(Request request)	Get the skin name from request or null if not found
Set<String>	getSkins()	Get the list of existing skins
(package private) SourceResolver	getSourceResolver()
(package private) ViewAndParametersParser	getViewAndParametersParser()
(package private) ViewParametersManager	getViewParametersManager()
(package private) ViewParameterTypeExtensionPoint	getViewParameterTypeExtensionPoint()
void	initialize()
void	service(ServiceManager manager)

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

Field Detail

ROLE

public static final String ROLE

The avalon role name

_skins

protected Map<Path,Skin> _skins

A cache of skins objects classified by absolute path

_externalSkins

protected Map<String,Path> _externalSkins

The skins declared as external: name of the skin and file location

_resourcesSkins

protected Map<String,Path> _resourcesSkins

The skins declared in jar files

_manager

protected ServiceManager _manager

The avalon service manager

_sourceResolver

protected SourceResolver _sourceResolver

The excalibur source resolver

_context

protected Context _context

Avalon context

_cocoonContext

protected Context _cocoonContext

Cocoon context

_siteManager

protected SiteManager _siteManager

The site manager

_viewParametersManager

protected ViewParametersManager _viewParametersManager

The view parameters manager

_viewAndParametersParser

protected ViewAndParametersParser _viewAndParametersParser

The view and parameters parser

_viewParametersEP

protected ViewParameterTypeExtensionPoint _viewParametersEP

The extension point for type of view parameter

Constructor Detail

SkinsManager

public SkinsManager()

Method Detail

service

public void service(ServiceManager manager)
             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

getServiceManager

ServiceManager getServiceManager()

getContext

Context getContext()

getSourceResolver

SourceResolver getSourceResolver()

getViewParametersManager

ViewParametersManager getViewParametersManager()

getViewAndParametersParser

ViewAndParametersParser getViewAndParametersParser()

getViewParameterTypeExtensionPoint

ViewParameterTypeExtensionPoint getViewParameterTypeExtensionPoint()

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

dispose

public void dispose()

Specified by:

dispose in interface Disposable

_listResourcesSkins

private void _listResourcesSkins()
                          throws IOException

Throws:

IOException

_listExternalSkins

private void _listExternalSkins(String uri)
                         throws Exception

Throws:

Exception

_getPath

private Path _getPath(String path)

getSkins

public Set<String> getSkins()

Get the list of existing skins

Returns:

A set of skin names. Can be null if there is an error.

getSkin

public Skin getSkin(String id)

Get a skin

Parameters:

id - The id of the skin

Returns:

The skin or null if the skin does not exist

getSkinAndParents

public List<Skin> getSkinAndParents(Skin skin)

Get the skin and recursively its parents skins in the right weight order

Parameters:

skin - The non null skin to check

Returns:

The list of parent skins INCLUDING the given one

getDirectChildren

public List<Skin> getDirectChildren(Skin skin)

Compute the skin that are directly derived from the given one

Parameters:

skin - A non null skin

Returns:

A non null list of skins

getLocalSkinsLocation

public Path getLocalSkinsLocation()

Get the skins location

Returns:

the skin location

getSkinNameFromRequest

public String getSkinNameFromRequest()

Get the skin name from request or null if not found

Returns:

The skin name or null

getSkinNameFromRequest

public String getSkinNameFromRequest(Request request)

Get the skin name from request or null if not found

Parameters:

request - The request

Returns:

The skin name or null

_isASkinPath

private boolean _isASkinPath(Path skinDir)