Package org.ametys.web.skin

Class SkinConfigurationHelper

java.lang.Object

org.ametys.web.skin.SkinConfigurationHelper

All Implemented Interfaces:

Component, Serviceable

public class SkinConfigurationHelper
extends Object
implements Component, Serviceable

Helper to read a skin configuration file that will handle inheritance

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ROLE	The avalon role

Constructor Summary

Constructors

Constructor	Description
SkinConfigurationHelper()

Method Summary

Modifier and Type	Method	Description
Configuration	getInheritanceMergedConfiguration(Skin skin, String relativeConfigurationFileUri, InputStream mergeXSLIS)	Get the configuration representing a file in a skin taking in account the inheritance process
Configuration	getInheritanceMergedConfiguration(Skin skin, String relativeConfigurationFileUri, String relativeDefaultConfigurationFileUri, InputStream mergeXSLIS)	Get the configuration representing a file in a skin taking in account the inheritance process
void	service(ServiceManager manager)

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 avalon role

Constructor Details

SkinConfigurationHelper

public SkinConfigurationHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getInheritanceMergedConfiguration

public Configuration getInheritanceMergedConfiguration(Skin skin,
 String relativeConfigurationFileUri,
 String relativeDefaultConfigurationFileUri,
 InputStream mergeXSLIS)
                                                throws IOException,
ConfigurationException,
SAXException

Get the configuration representing a file in a skin taking in account the inheritance process

Parameters:

skin - The skin to consider

relativeConfigurationFileUri - The configuration file uri relative to the skin. For example : "conf/tags.xml"

relativeDefaultConfigurationFileUri - A configuration file uri relative to the skin with default value.

mergeXSLIS - The XSL file used to merge two configuration file

Returns:

The configuration or null if the configuration file does not exists

Throws:

IOException - If an error occurred while opening the configuration file

ConfigurationException - If the configuration file contains errors

SAXException - If a XML parsing error occurred in the configuration file

getInheritanceMergedConfiguration

public Configuration getInheritanceMergedConfiguration(Skin skin,
 String relativeConfigurationFileUri,
 InputStream mergeXSLIS)
                                                throws IOException,
ConfigurationException,
SAXException

Get the configuration representing a file in a skin taking in account the inheritance process

Parameters:

skin - The skin to consider

relativeConfigurationFileUri - The configuration file uri relative to the skin. For example : "conf/tags.xml"

mergeXSLIS - The XSL file used to merge two configuration file

Returns:

The configuration or null if the configuration file does not exists

Throws:

IOException - If an error occurred while opening the configuration file

ConfigurationException - If the configuration file contains errors

SAXException - If a XML parsing error occurred in the configuration file