Package org.ametys.plugins.skincommons

Class AbstractCommonSkinDAO

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.skincommons.AbstractCommonSkinDAO

All Implemented Interfaces:

LogEnabled, Component, Serviceable

Direct Known Subclasses:

SkinDAO, SkinDAO

public abstract class AbstractCommonSkinDAO
extends AbstractLogEnabled
implements Serviceable, Component

DAO for skin edition.

Field Summary

Fields

Modifier and Type	Field	Description
protected SkinLockManager	_lockManager	The lock manager
protected SiteManager	_siteManager	The site manager
protected SkinEditionHelper	_skinHelper	The skin helper
protected SkinsManager	_skinsManager	The skin manager
protected UserManager	_userManager	The user manager
protected CurrentUserProvider	_userProvider	The current user provider

Constructor Summary

Constructors

Constructor	Description
AbstractCommonSkinDAO()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	cancelChanges(String skinName, boolean workVersion, String toolId)	Cancel the current modification to the skin
Map<String,Object>	checkUnsaveModifications(String skinName)	Check if there is unsaved or uncomitted changes
protected abstract void	checkUserRight(String skinName)	Check user rights and throws AccessDeniedException if it is not authorized
Map<String,Object>	clearModifications(String skinName, boolean workVersion)	Revert changes and back to last work version or to current skin
Map<String,Object>	commitChanges(String skinName, boolean quit)	Commit the changes made to the skin
Map<String,Object>	getLock(String siteName, String skinName)	Get lock informations on a skin
String	getPreviewURI(String siteName, String lang)	Get the URI to preview a site
String	getSkinModel(String siteName, String skinName, String mode)	Get the model for the skin
Map<String,Object>	saveChanges(String skinName, boolean quit)	Save the current skin into the skin work folder
void	service(ServiceManager smanager)

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

_siteManager

protected SiteManager _siteManager

The site manager

_skinHelper

protected SkinEditionHelper _skinHelper

The skin helper

_lockManager

protected SkinLockManager _lockManager

The lock manager

_userProvider

protected CurrentUserProvider _userProvider

The current user provider

_userManager

protected UserManager _userManager

The user manager

_skinsManager

protected SkinsManager _skinsManager

The skin manager

Constructor Details

AbstractCommonSkinDAO

public AbstractCommonSkinDAO()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getPreviewURI

public String getPreviewURI(String siteName,
 String lang)

Get the URI to preview a site

Parameters:

siteName - the site name

lang - the site langage

Returns:

The uri

checkUnsaveModifications

public Map<String,Object> checkUnsaveModifications(String skinName)
                                            throws IOException

Check if there is unsaved or uncomitted changes

Parameters:

skinName - The skin name

Returns:

The result

Throws:

IOException - if an error occurs while manipulating files

saveChanges

public Map<String,Object> saveChanges(String skinName,
 boolean quit)
                               throws IOException

Save the current skin into the skin work folder

Parameters:

skinName - The name of the skin

quit - True if the temp directory can be removed

Returns:

The name of the skin

Throws:

IOException - if an error occurs while manipulating files

checkUserRight

protected abstract void checkUserRight(String skinName)

Check user rights and throws AccessDeniedException if it is not authorized

Parameters:

skinName - the skin name

commitChanges

public Map<String,Object> commitChanges(String skinName,
 boolean quit)
                                 throws Exception

Commit the changes made to the skin

Parameters:

skinName - the name of the skin

quit - True to remove the temporary directory

Returns:

A map with information

Throws:

Exception - if an error occurs when committing the skin changes

cancelChanges

public Map<String,Object> cancelChanges(String skinName,
 boolean workVersion,
 String toolId)
                                 throws IOException

Cancel the current modification to the skin

Parameters:

skinName - The name of the skin

workVersion - True it is the work version, false for the temp version

toolId - the id of the tool

Returns:

True if some changes were canceled

Throws:

IOException - if an error occurs while manipulating files

getSkinModel

public String getSkinModel(String siteName,
 String skinName,
 String mode)

Get the model for the skin

Parameters:

siteName - the site name. Can be null if skinName is not null.

skinName - the skin name. Can be null if siteName is not null.

mode - the edition mode. Can be null.

Returns:

the model's name or null if there is no model for this skin

getLock

public Map<String,Object> getLock(String siteName,
 String skinName)
                           throws IOException

Get lock informations on a skin

Parameters:

siteName - the site name. Can be null if skinName is not null.

skinName - the skin name. Can be null if siteName is not null.

Returns:

Informations about the lock

Throws:

IOException - if an error occurs

clearModifications

public Map<String,Object> clearModifications(String skinName,
 boolean workVersion)
                                      throws IOException

Revert changes and back to last work version or to current skin

Parameters:

skinName - The skin name

workVersion - true to get back the work version

Returns:

The skin name in case of success or lock infos if the skin is locked.

Throws:

IOException - if an error occurs