Package org.ametys.web.skin

Class SkinModelsManager

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.web.skin.SkinModelsManager

All Implemented Interfaces:

Initializable, Component, Contextualizable, LogEnabled, Serviceable, ThreadSafe

public class SkinModelsManager
extends AbstractLogEnabled
implements ThreadSafe, Serviceable, Component, Contextualizable, Initializable

Manages the models of skin

Field Summary

Fields

Modifier and Type	Field	Description
protected Context	_cocoonContext	Cocoon context
protected Context	_context	Avalon context
protected Map<String,Path>	_externalSkinModels	The models declared as external: name of the models and file location
protected ServiceManager	_manager	The avalon service manager
protected Map<Path,SkinModel>	_models	The set of templates classified by skins
protected Map<String,Path>	_resourcesSkinModels	The models declared in jar files
protected SkinsManager	_skinsManager	The sites manager
protected SourceResolver	_sourceResolver	The excalibur source resolver
static String	ROLE	The avalon role name

Constructor Summary

Constructors

Constructor	Description
SkinModelsManager()

Method Summary

Modifier and Type	Method	Description
private Path	_getPath(String path)
private boolean	_isASkinModelPath(Path modelDir)
private void	_listExternalSkinModels(String uri)
private void	_listResourcesSkinModels()
void	contextualize(Context context)
void	generateModelFile(Path skinDir, String modelId)	Generates the model.xml file for the skin
void	generateModelFile(Path skinDir, String modelId, String colorTheme)	Generates the model.xml file for the skin
Path	getLocalModelsLocation()	Get the skins location
SkinModel	getModel(String id)	Get a model
String	getModelHash(String id)	Get hash from model
String	getModelOfSkin(Skin skin)	Get the id of model associated to a skin
Set<String>	getModels()	Get the list of existing models
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

_models

protected Map<Path,SkinModel> _models

The set of templates classified by skins

_externalSkinModels

protected Map<String,Path> _externalSkinModels

The models declared as external: name of the models and file location

_resourcesSkinModels

protected Map<String,Path> _resourcesSkinModels

The models declared in jar files

_manager

protected ServiceManager _manager

The avalon service manager

_sourceResolver

protected SourceResolver _sourceResolver

The excalibur source resolver

_skinsManager

protected SkinsManager _skinsManager

The sites manager

_context

protected Context _context

Avalon context

_cocoonContext

protected Context _cocoonContext

Cocoon context

Constructor Detail

SkinModelsManager

public SkinModelsManager()

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

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

_listResourcesSkinModels

private void _listResourcesSkinModels()
                               throws IOException

Throws:

IOException

_listExternalSkinModels

private void _listExternalSkinModels(String uri)
                              throws Exception

Throws:

Exception

_getPath

private Path _getPath(String path)

getModels

public Set<String> getModels()

Get the list of existing models

Returns:

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

getModel

public SkinModel getModel(String id)

Get a model

Parameters:

id - The id of the model

Returns:

The model or null if the model does not exists

getModelOfSkin

public String getModelOfSkin(Skin skin)

Get the id of model associated to a skin

Parameters:

skin - The skin

Returns:

The id of the model or null if there is no model for this skin

getModelHash

public String getModelHash(String id)

Get hash from model

Parameters:

id - The id of the model

Returns:

unique has

generateModelFile

public void generateModelFile(Path skinDir,
                              String modelId,
                              String colorTheme)
                       throws IOException,
                              SAXException,
                              TransformerConfigurationException

Generates the model.xml file for the skin

Parameters:

skinDir - The skin directory

modelId - The model id

colorTheme - The id of color theme. Can be null.

Throws:

IOException - if an I/O exception occurs during generation

SAXException - if an error occurs during generation

TransformerConfigurationException - if an error occurs during generation

generateModelFile

public void generateModelFile(Path skinDir,
                              String modelId)
                       throws IOException,
                              SAXException,
                              TransformerConfigurationException

Generates the model.xml file for the skin

Parameters:

skinDir - The skin directory

modelId - The model id

Throws:

IOException - if an I/O exception occurs during generation

SAXException - if an error occurs during generation

TransformerConfigurationException - if an error occurs during generation

getLocalModelsLocation

public Path getLocalModelsLocation()

Get the skins location

Returns:

the skin location

_isASkinModelPath

private boolean _isASkinModelPath(Path modelDir)