org.ametys.plugins.skincommons

Class CommonSkinDAO

java.lang.Object

org.ametys.plugins.skincommons.CommonSkinDAO

All Implemented Interfaces:

Component, Serviceable

public class CommonSkinDAO
extends Object
implements Serviceable, Component

DAO for skin edition.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	__TEMP_MODE
private static String	__WORK_MODE
private SkinLockManager	_lockManager
private SiteManager	_siteManager
private SkinEditionHelper	_skinHelper
private UserManager	_userManager
private CurrentUserProvider	_userProvider

Constructor Summary

Constructors

Constructor and Description
CommonSkinDAO()

Method Summary

Modifier and Type	Method and Description
private Map<String,Object>	_checkLock(String skinName)
private String	_getSkinName(String siteName, String skinName)
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
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

__TEMP_MODE

private static final String __TEMP_MODE

See Also:

Constant Field Values

__WORK_MODE

private static final String __WORK_MODE

See Also:

Constant Field Values

_siteManager

private SiteManager _siteManager

_skinHelper

private SkinEditionHelper _skinHelper

_lockManager

private SkinLockManager _lockManager

_userProvider

private CurrentUserProvider _userProvider

_userManager

private UserManager _userManager

Constructor Detail

CommonSkinDAO

public CommonSkinDAO()

Method Detail

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

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

_checkLock

private Map<String,Object> _checkLock(String skinName)
                               throws IOException

Throws:

IOException

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

_getSkinName

private String _getSkinName(String siteName,
                            String skinName)

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