org.ametys.web.clientsideelement

Class LivePageClientSideElement

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.core.ui.StaticFileImportsClientSideElement

org.ametys.core.ui.StaticClientSideElement

org.ametys.web.clientsideelement.AbstractPageClientSideElement

org.ametys.web.clientsideelement.LivePageClientSideElement

All Implemented Interfaces:

ClientSideElement, LogEnabled, PluginAware, Configurable, Serviceable

public class LivePageClientSideElement
extends AbstractPageClientSideElement

This ClientSideElement creates a button that will be enabled if page and its hierarchy is valid.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.core.ui.ClientSideElement

ClientSideElement.Script, ClientSideElement.ScriptFile

Field Summary

Fields

Modifier and Type	Field and Description
private GroupManager	_foGroupsManager The GroupManager for front-end groups
private UserManager	_foUsersManager The UserManager for front-end users
private I18nUtils	_i18nUtils The I18nUtils
private Repository	_repository The repository
private SiteConfigurationExtensionPoint	_siteConfiguration The SiteConfigurationExtensionPoint
private SkinsManager	_skinManager The SkinsManager
private UserHelper	_userHelper
private UserManager	_userManager The UserManager

Fields inherited from class org.ametys.web.clientsideelement.AbstractPageClientSideElement

_resolver, _synchronizeComponent

Fields inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_currentUserProvider, _dependencies, _featureName, _id, _pluginName, _rightManager, _rights, _rightsMode, _script

Constructor Summary

Constructors

Constructor and Description
LivePageClientSideElement()

Method Summary

Modifier and Type	Method and Description
private String	_getBody(User sender, User user, Page page, String comment) Get the email body
private Set<User>	_getDistinctUsers(List<UserIdentity> userIdentities, List<GroupIdentity> groupIdentities)
private I18nizableText	_getInvalidHierarchyDescription(Page page) Get i18n description for invalid hierarchy
private I18nizableText	_getInvalidPageDescription(Page page) Get i18n description for invalid page
private String	_getSender(User sender, Page page) Get the email sender
private String	_getSubject(User sender, Page page) Get the email subject
Map<String,Object>	getStatus(List<String> pageIds) Get the live status of given pages
boolean	sendOnlineNotification(List<String> pageIds, List<Map<String,String>> users, List<Map<String,String>> groups, String comment) Send a notification for online pages.
void	service(ServiceManager smanager)

Methods inherited from class org.ametys.web.clientsideelement.AbstractPageClientSideElement

getAllRightPageDescription, getNoModifiablePageDescription, getNoRightPageDescription, getPageDefaultParameters, hasRight

Methods inherited from class org.ametys.core.ui.StaticClientSideElement

_configureClass, _configureParameters, _configureScript, configureInitialParameters

Methods inherited from class org.ametys.core.ui.StaticFileImportsClientSideElement

_configureDependencies, _configureImports, _configureRights, _configureRightsMode, configure, getDependencies, getId, getPluginName, getRights, getScripts, getScripts, hasRight, setPluginInfo, toString

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, wait, wait, wait

Field Detail

_userManager

private UserManager _userManager

The UserManager

_foUsersManager

private UserManager _foUsersManager

The UserManager for front-end users

_foGroupsManager

private GroupManager _foGroupsManager

The GroupManager for front-end groups

_siteConfiguration

private SiteConfigurationExtensionPoint _siteConfiguration

The SiteConfigurationExtensionPoint

_i18nUtils

private I18nUtils _i18nUtils

The I18nUtils

_skinManager

private SkinsManager _skinManager

The SkinsManager

_repository

private Repository _repository

The repository

_userHelper

private UserHelper _userHelper

Constructor Detail

LivePageClientSideElement

public LivePageClientSideElement()

Method Detail

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractPageClientSideElement

Throws:

ServiceException

getStatus

public Map<String,Object> getStatus(List<String> pageIds)

Get the live status of given pages

Parameters:

pageIds - The page id

Returns:

the result

sendOnlineNotification

public boolean sendOnlineNotification(List<String> pageIds,
                                      List<Map<String,String>> users,
                                      List<Map<String,String>> groups,
                                      String comment)

Send a notification for online pages.

Parameters:

pageIds - the ids of the pages

users - the users that will be notified

groups - the groups that will be notified

comment - the comment of the notifier

Returns:

true

_getInvalidPageDescription

private I18nizableText _getInvalidPageDescription(Page page)

Get i18n description for invalid page

Parameters:

page - The page

Returns:

The I18nizableText description

_getInvalidHierarchyDescription

private I18nizableText _getInvalidHierarchyDescription(Page page)

Get i18n description for invalid hierarchy

Parameters:

page - The page

Returns:

The I18nizableText description

_getSender

private String _getSender(User sender,
                          Page page)

Get the email sender

Parameters:

sender - The user responsible for the action

page - The published page

Returns:

The sender

_getSubject

private String _getSubject(User sender,
                           Page page)

Get the email subject

Parameters:

sender - The user responsible for the notification

page - The published page

Returns:

The email subject

_getBody

private String _getBody(User sender,
                        User user,
                        Page page,
                        String comment)

Get the email body

Parameters:

sender - The user responsible for the notification

user - The recipient of the notification

page - The published page

comment - The user's comment. Can be empty or null.

Returns:

The email body

_getDistinctUsers

private Set<User> _getDistinctUsers(List<UserIdentity> userIdentities,
                                    List<GroupIdentity> groupIdentities)