org.ametys.plugins.odfweb.userpref

Class ODFCartUserPreferencesStorage

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.odfweb.userpref.ODFCartUserPreferencesStorage

All Implemented Interfaces:

UserPreferencesStorage, Component, Configurable, LogEnabled

public class ODFCartUserPreferencesStorage
extends AbstractLogEnabled
implements UserPreferencesStorage, Configurable, Component

Specific storage for odf cart user preferences

Field Summary

Fields

Modifier and Type	Field and Description
protected String	_contentIdColumn The content id column
protected String	_contextColumn The context column, can be null if the database is not context-dependent.
protected String	_dataSourceId The id of the data source used.
protected String	_loginColumn The login column, cannot be null.
protected String	_populationColumn The population id column, cannot be null.
protected Map<String,String>	_prefIdToTable Mapping from preference id to table name.
static String	ROLE The Avalon Role
static String	USER_PREF_COURSE_IDS The id of user preference for ids for courses
static String	USER_PREF_PROGRAM_IDS The id of user preference for ids for programs

Constructor Summary

Constructors

Constructor and Description
ODFCartUserPreferencesStorage()

Method Summary

Modifier and Type	Method and Description
private void	_insertPreferences(Connection connection, Map<String,String> preferences, UserIdentity user, String storageContext)
private void	_removeContentFromUserPreferences(String contentId, String tableName)
private void	_removeUserPreferencesFromTable(Connection connection, UserIdentity user, String storageContext, String table)
void	configure(Configuration configuration)
void	configureMappings(Configuration configuration) Configure the mappings from preference ID to table name.
Map<String,String>	getUnTypedUserPrefs(UserIdentity user, String storageContext, Map<String,String> contextVars) Get a user's preference values (as String) for a given context.
Boolean	getUserPreferenceAsBoolean(UserIdentity user, String storageContext, Map<String,String> contextVars, String id) Get a single boolean user preference value for a given context.
Date	getUserPreferenceAsDate(UserIdentity user, String storageContext, Map<String,String> contextVars, String id) Get a single date user preference value for a given context.
Double	getUserPreferenceAsDouble(UserIdentity user, String storageContext, Map<String,String> contextVars, String id) Get a single double user preference value for a given context.
Long	getUserPreferenceAsLong(UserIdentity user, String storageContext, Map<String,String> contextVars, String id) Get a single long user preference value for a given context.
String	getUserPreferenceAsString(UserIdentity user, String storageContext, Map<String,String> contextVars, String id) Get a single string user preference value for a given context.
void	removeCourseFromUserPreferences(String courseId) Remove all user preferences referencing a Course
void	removeProgramFromUserPreferences(String programId) Remove all user preferences referencing a Program
void	removeUserPreferences(UserIdentity user, String storageContext, Map<String,String> contextVars) Remove the stored user preferences for a login in a given context.
void	setUserPreferences(UserIdentity user, String storageContext, Map<String,String> contextVars, Map<String,String> preferences) Set a user's preferences for a given context.

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

ROLE

public static final String ROLE

The Avalon Role

USER_PREF_PROGRAM_IDS

public static final String USER_PREF_PROGRAM_IDS

The id of user preference for ids for programs

See Also:

Constant Field Values

USER_PREF_COURSE_IDS

public static final String USER_PREF_COURSE_IDS

The id of user preference for ids for courses

See Also:

Constant Field Values

_dataSourceId

protected String _dataSourceId

The id of the data source used.

_loginColumn

protected String _loginColumn

The login column, cannot be null.

_populationColumn

protected String _populationColumn

The population id column, cannot be null.

_contextColumn

protected String _contextColumn

The context column, can be null if the database is not context-dependent.

_contentIdColumn

protected String _contentIdColumn

The content id column

_prefIdToTable

protected Map<String,String> _prefIdToTable

Mapping from preference id to table name.

Constructor Detail

ODFCartUserPreferencesStorage

public ODFCartUserPreferencesStorage()

Method Detail

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

configureMappings

public void configureMappings(Configuration configuration)
                       throws ConfigurationException

Configure the mappings from preference ID to table name.

Parameters:

configuration - the mapping configuration root.

Throws:

ConfigurationException - if an error occurs.

getUnTypedUserPrefs

public Map<String,String> getUnTypedUserPrefs(UserIdentity user,
                                              String storageContext,
                                              Map<String,String> contextVars)
                                       throws UserPreferencesException

Description copied from interface: UserPreferencesStorage

Get a user's preference values (as String) for a given context.

Specified by:

getUnTypedUserPrefs in interface UserPreferencesStorage

Parameters:

user - the user.

storageContext - the preferences storage context.

contextVars - The context variables including environment elements

Returns:

the user preference values as a Map of String indexed by preference ID.

Throws:

UserPreferencesException - if an error occurs getting the preferences.

removeUserPreferences

public void removeUserPreferences(UserIdentity user,
                                  String storageContext,
                                  Map<String,String> contextVars)
                           throws UserPreferencesException

Description copied from interface: UserPreferencesStorage

Remove the stored user preferences for a login in a given context.

Specified by:

removeUserPreferences in interface UserPreferencesStorage

Parameters:

user - the user.

storageContext - the preferences storage context.

contextVars - the context variables.

Throws:

UserPreferencesException - if an error occurred

_removeUserPreferencesFromTable

private void _removeUserPreferencesFromTable(Connection connection,
                                             UserIdentity user,
                                             String storageContext,
                                             String table)
                                      throws SQLException

Throws:

SQLException

removeProgramFromUserPreferences

public void removeProgramFromUserPreferences(String programId)
                                      throws UserPreferencesException

Remove all user preferences referencing a Program

Parameters:

programId - The id of program to remove from user preferences

Throws:

UserPreferencesException - if failed to delete users preferences

removeCourseFromUserPreferences

public void removeCourseFromUserPreferences(String courseId)
                                     throws UserPreferencesException

Remove all user preferences referencing a Course

Parameters:

courseId - The id of course to remove from user preferences

Throws:

UserPreferencesException - if failed to delete users preferences

_removeContentFromUserPreferences

private void _removeContentFromUserPreferences(String contentId,
                                               String tableName)
                                        throws UserPreferencesException

Throws:

UserPreferencesException

setUserPreferences

public void setUserPreferences(UserIdentity user,
                               String storageContext,
                               Map<String,String> contextVars,
                               Map<String,String> preferences)
                        throws UserPreferencesException

Description copied from interface: UserPreferencesStorage

Set a user's preferences for a given context.

Specified by:

setUserPreferences in interface UserPreferencesStorage

Parameters:

user - the user.

storageContext - the preferences storage context.

contextVars - The context variables including environment elements

preferences - a Map of the preference values indexed by ID.

Throws:

UserPreferencesException - if an error occurred

_insertPreferences

private void _insertPreferences(Connection connection,
                                Map<String,String> preferences,
                                UserIdentity user,
                                String storageContext)
                         throws SQLException

Throws:

SQLException

getUserPreferenceAsString

public String getUserPreferenceAsString(UserIdentity user,
                                        String storageContext,
                                        Map<String,String> contextVars,
                                        String id)
                                 throws UserPreferencesException

Description copied from interface: UserPreferencesStorage

Get a single string user preference value for a given context.

Specified by:

getUserPreferenceAsString in interface UserPreferencesStorage

Parameters:

user - the user.

storageContext - the preferences storage context.

contextVars - The context variables including environment elements

id - the preference ID.

Returns:

the user preference value as a String.

Throws:

UserPreferencesException - if an error occurred

getUserPreferenceAsLong

public Long getUserPreferenceAsLong(UserIdentity user,
                                    String storageContext,
                                    Map<String,String> contextVars,
                                    String id)
                             throws UserPreferencesException

Description copied from interface: UserPreferencesStorage

Get a single long user preference value for a given context.

Specified by:

getUserPreferenceAsLong in interface UserPreferencesStorage

Parameters:

user - the user.

storageContext - the preferences storage context.

contextVars - The context variables including environment elements

id - the preference ID.

Returns:

the user preference value as a Long.

Throws:

UserPreferencesException - if an error occurred

getUserPreferenceAsDate

public Date getUserPreferenceAsDate(UserIdentity user,
                                    String storageContext,
                                    Map<String,String> contextVars,
                                    String id)
                             throws UserPreferencesException

Description copied from interface: UserPreferencesStorage

Get a single date user preference value for a given context.

Specified by:

getUserPreferenceAsDate in interface UserPreferencesStorage

Parameters:

user - the user.

storageContext - the preferences storage context.

contextVars - The context variables including environment elements

id - the preference ID.

Returns:

the user preference value as a Date.

Throws:

UserPreferencesException - if an error occurred

getUserPreferenceAsBoolean

public Boolean getUserPreferenceAsBoolean(UserIdentity user,
                                          String storageContext,
                                          Map<String,String> contextVars,
                                          String id)
                                   throws UserPreferencesException

Description copied from interface: UserPreferencesStorage

Get a single boolean user preference value for a given context.

Specified by:

getUserPreferenceAsBoolean in interface UserPreferencesStorage

Parameters:

user - the user.

storageContext - the preferences storage context.

contextVars - The context variables including environment elements

id - the preference ID.

Returns:

the user preference value as a Boolean.

Throws:

UserPreferencesException - if an error occurred

getUserPreferenceAsDouble

public Double getUserPreferenceAsDouble(UserIdentity user,
                                        String storageContext,
                                        Map<String,String> contextVars,
                                        String id)
                                 throws UserPreferencesException

Description copied from interface: UserPreferencesStorage

Get a single double user preference value for a given context.

Specified by:

getUserPreferenceAsDouble in interface UserPreferencesStorage

Parameters:

user - the user.

storageContext - the preferences storage context.

contextVars - The context variables including environment elements

id - the preference ID.

Returns:

the user preference value as a Double.

Throws:

UserPreferencesException - if an error occurred