Package org.ametys.plugins.skineditor.skin

Class SkinDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.skincommons.AbstractCommonSkinDAO

org.ametys.plugins.skineditor.skin.SkinDAO

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class SkinDAO
extends AbstractCommonSkinDAO

DAO for files and folders inside a skin directory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EDIT_CURRENT_SKIN_RIGHT_ID	Constant for the id of right to edit teh current skin
static final String	EDIT_SKINS_RIGHT_ID	Constant for the id of right to edit all skins
static final String	ROLE	The Avalon role
static final String	SKIN_EDITOR_TOOL_ID	Constant for skin editor tool id

Fields inherited from class org.ametys.plugins.skincommons.AbstractCommonSkinDAO

_lockManager, _siteManager, _skinHelper, _skinsManager, _userManager, _userProvider

Constructor Summary

Constructors

Constructor	Description
SkinDAO()

Method Summary

Modifier and Type	Method	Description
protected void	checkUserRight(String skinName)	Check user rights and throws AccessDeniedException if it is not authorized
List<Object>	getSkinsList()	Get the list of available and modifiable skins for a site
String	openSkin(String skinId, String mode, boolean unlinkModel)	Open a skin for editing
void	service(ServiceManager manager)
protected void	unlinkModel(Path skinDir)	Unlink model

Methods inherited from class org.ametys.plugins.skincommons.AbstractCommonSkinDAO

cancelChanges, checkUnsaveModifications, clearModifications, commitChanges, getLock, getPreviewURI, getSkinModel, saveChanges

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

EDIT_SKINS_RIGHT_ID

public static final String EDIT_SKINS_RIGHT_ID

Constant for the id of right to edit all skins

See Also:

• Constant Field Values

EDIT_CURRENT_SKIN_RIGHT_ID

public static final String EDIT_CURRENT_SKIN_RIGHT_ID

Constant for the id of right to edit teh current skin

See Also:

• Constant Field Values

SKIN_EDITOR_TOOL_ID

public static final String SKIN_EDITOR_TOOL_ID

Constant for skin editor tool id

See Also:

• Constant Field Values

Constructor Details

SkinDAO

public SkinDAO()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractCommonSkinDAO

Throws:

ServiceException

checkUserRight

protected void checkUserRight(String skinName)

Description copied from class: AbstractCommonSkinDAO

Check user rights and throws AccessDeniedException if it is not authorized

Specified by:

checkUserRight in class AbstractCommonSkinDAO

Parameters:

skinName - the skin name

getSkinsList

public List<Object> getSkinsList()

Get the list of available and modifiable skins for a site

Returns:

the list of skins

openSkin

public String openSkin(String skinId,
 String mode,
 boolean unlinkModel)
                throws Exception

Open a skin for editing

Parameters:

skinId - the skin id

mode - the edition mode

unlinkModel - True to remove any existing change

Returns:

the skin id

Throws:

Exception - if an error occurs during the skin opening process

unlinkModel

protected void unlinkModel(Path skinDir)
                    throws IOException

Unlink model

Parameters:

skinDir - The skin directory

Throws:

IOException - If an error occurred