Package org.ametys.plugins.skineditor.skin

Class SkinDAO

java.lang.Object

org.ametys.plugins.skineditor.skin.SkinDAO

All Implemented Interfaces:

Component, Serviceable

public class SkinDAO
extends Object
implements Serviceable, Component

DAO for files and folders inside a skin directory

Field Summary

Fields

Modifier and Type	Field	Description
private static String	__PROD_MODE
private static String	__WORK_MODE
protected SkinLockManager	_lockManager	The lock manager
private RightManager	_rightManager
private SiteManager	_siteManager
protected SkinEditionHelper	_skinHelper	The skin edition helper
private SkinsManager	_skinManager
private CurrentUserProvider	_userProvider
static String	ROLE	The Avalon role
static String	SKIN_EDITOR_TOOL_ID	Constant for skin editor tool id

Constructor Summary

Constructors

Constructor	Description
SkinDAO()

Method Summary

Modifier and Type	Method	Description
private Map<String,Object>	_skin2JsonObject(Skin skin, boolean current)
List<Object>	getSkinsList(String siteName)	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 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

SKIN_EDITOR_TOOL_ID

public static final String SKIN_EDITOR_TOOL_ID

Constant for skin editor tool id

See Also:

Constant Field Values

__WORK_MODE

private static final String __WORK_MODE

See Also:

Constant Field Values

__PROD_MODE

private static final String __PROD_MODE

See Also:

Constant Field Values

_lockManager

protected SkinLockManager _lockManager

The lock manager

_skinHelper

protected SkinEditionHelper _skinHelper

The skin edition helper

_skinManager

private SkinsManager _skinManager

_userProvider

private CurrentUserProvider _userProvider

_rightManager

private RightManager _rightManager

_siteManager

private SiteManager _siteManager

Constructor Detail

SkinDAO

public SkinDAO()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getSkinsList

public List<Object> getSkinsList(String siteName)

Get the list of available and modifiable skins for a site

Parameters:

siteName - The site name

Returns:

the list of skins

_skin2JsonObject

private Map<String,Object> _skin2JsonObject(Skin skin,
                                                  boolean current)

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