org.ametys.plugins.linkdirectory

Class LinkDirectorySetUserPreferencesAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.plugins.linkdirectory.LinkDirectorySetUserPreferencesAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action

public class LinkDirectorySetUserPreferencesAction
extends ServiceableAction

Create or set user preferences attached to a link directory service or the link directory input data mode for front-end users

Field Summary

Fields

Modifier and Type	Field and Description
private CurrentUserProvider	_currentUserProvider The current user provider
private AmetysObjectResolver	_resolver The ametys object resolver
private UserPreferencesManager	_userPrefManager The user preferences manager.

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor and Description
LinkDirectorySetUserPreferencesAction()

Method Summary

Modifier and Type	Method and Description
private Map<String,String>	_getContextVars(String siteName, String language) Get the context with the language and the site name
private String	_getHiddenLinks(Request request) Get the hidden link ids from the request
private String	_getLinksPosition(Request request) Get the ordered link ids from the request
private String	_getStorageContext(String siteName, String language, String zoneItemId) Get the appropriate storage context
private void	_setHiddenLinksUserPref(Request request, String storageContext, Map<String,String> contextVars, UserIdentity user) Set the hidden links user pref
private void	_setLinksPositionUserPref(Request request, String storageContext, Map<String,String> contextVars, UserIdentity user) Set the links position user pref
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
void	service(ServiceManager serviceManager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

_userPrefManager

private UserPreferencesManager _userPrefManager

The user preferences manager.

_resolver

private AmetysObjectResolver _resolver

The ametys object resolver

_currentUserProvider

private CurrentUserProvider _currentUserProvider

The current user provider

Constructor Detail

LinkDirectorySetUserPreferencesAction

public LinkDirectorySetUserPreferencesAction()

Method Detail

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableAction

Throws:

ServiceException

act

public Map act(Redirector redirector,
               SourceResolver resolver,
               Map objectModel,
               String source,
               Parameters parameters)
        throws Exception

Throws:

Exception

_getStorageContext

private String _getStorageContext(String siteName,
                                  String language,
                                  String zoneItemId)

Get the appropriate storage context

Parameters:

siteName - the name of the site

language - the language

zoneItemId - the id of the zone item if we deal with a service, null for an input data

Returns:

the storage context in which the user preferences will be kept

_getContextVars

private Map<String,String> _getContextVars(String siteName,
                                           String language)

Get the context with the language and the site name

Parameters:

siteName - the name of the site

language - the language

Returns:

the context map

_setLinksPositionUserPref

private void _setLinksPositionUserPref(Request request,
                                       String storageContext,
                                       Map<String,String> contextVars,
                                       UserIdentity user)
                                throws UserPreferencesException

Set the links position user pref

Parameters:

request - the request

storageContext - the storage context

contextVars - the context vars

user - the current user

Throws:

UserPreferencesException - If failed to save user preferences

_getLinksPosition

private String _getLinksPosition(Request request)

Get the ordered link ids from the request

Parameters:

request - the request

Returns:

the comma-separated string of ordered links ids

_setHiddenLinksUserPref

private void _setHiddenLinksUserPref(Request request,
                                     String storageContext,
                                     Map<String,String> contextVars,
                                     UserIdentity user)
                              throws UserPreferencesException

Set the hidden links user pref

Parameters:

request - the request

storageContext - the storage context

contextVars - the context vars

user - the current user

Throws:

UserPreferencesException - if failed to save user preferences

_getHiddenLinks

private String _getHiddenLinks(Request request)

Get the hidden link ids from the request

Parameters:

request - the request

Returns:

the comma-separated string of hidden links ids