Package org.nuxeo.user.preferences.directory

Class UserPreferencesServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.user.preferences.directory.UserPreferencesServiceImpl

All Implemented Interfaces:

Adaptable, Component, Extensible, TimestampedService, UserPreferencesService

public class UserPreferencesServiceImpl
extends DefaultComponent
implements UserPreferencesService

Directory based implementation of UserPreferencesService.

Both UserPreference and UserPreferences are stored in the same DIRECTORY_NAME directory and have the following fields:

• userId
• repository
• key
• value

UserPreferences has the docId additional field.

Since:

2025.16

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DIRECTORY_NAME

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
UserPreferencesServiceImpl()

Method Summary

Modifier and Type	Method	Description
protected static void	checkMaxPreferences(CoreSession session, Session dirSession, int nbNew)
UserPreference	create(CoreSession session, String key, String value)	Creates a current user's preference value for the given key.
UserPreferences	create(CoreSession session, DocumentRef docRef, Map<String,String> preferences)	Creates current user's document preferences.
UserPreference	createOrUpdate(CoreSession session, String key, String value)	Creates or updates a current user's preference.
void	delete(CoreSession session, String key)	Deletes the current user's preference for the given key.
void	delete(CoreSession session, DocumentRef docRef)	Deletes all the current user's preferences for the given document reference.
void	deleteAllForDocument(CoreSession session, IdRef idRef)	Internal use.
void	deleteAllForUser(CoreSession session, String userId)	Internal use.
protected void	doBatchDelete(QueryBuilder queryBuilder)
protected UserPreference	doCreate(CoreSession session, Session dirSession, String key, String value)
protected UserPreferences	doCreate(CoreSession session, Session dirSession, DocumentRef docRef, Map<String,String> preferences)
protected Optional<DocumentModel>	doGet(CoreSession session, Session dirSession, String key)
UserPreferences	doGet(CoreSession session, Session dirSession, IdRef idRef)
protected UserPreference	doUpdate(Session dirSession, DocumentModel docModel, String value)
Optional<UserPreference>	get(CoreSession session, String key)	Gets an optional current user's preference for the given key.
UserPreferences	get(CoreSession session, DocumentRef docRef)	Gets current user's preferences for the given document reference.
Optional<UserPreference>	get(CoreSession session, DocumentRef docRef, String key)	Gets optional current user's preference for the given document reference and key.
protected static IdRef	getDocId(CoreSession session, DocumentRef documentRef)
protected static Map<String,Object>	getFieldMap(CoreSession session, IdRef idRef, String key, String value)
protected static boolean	hasPreferences(CoreSession session, Session dirSession, IdRef idRef)
UserPreferences	list(CoreSession session)	Lists all current user's global preferences.
protected static UserPreference	newUserPreference(DocumentModel document)
UserPreferences	putAll(CoreSession session, DocumentRef docRef, UserPreferences docPreferences)	Puts all current user's document preferences.
protected static DocumentModelList	queryPreferences(CoreSession session, Session dirSession, IdRef idRef, String key, long limit)
UserPreferences	remove(CoreSession session, DocumentRef docRef, String key)	Removes the current user's preference for the given document reference and key.
protected static DocumentModelList	retrieveAllDocPreferences(CoreSession session, Session dirSession, IdRef idRef)
protected static DocumentModelList	retrieveAllPreferencesForUser(CoreSession session, Session dirSession)
protected static Optional<DocumentModel>	retrieveDocPreferenceForKey(CoreSession session, Session dirSession, IdRef idRef, String key)
UserPreference	update(CoreSession session, String key, String value)	Updates a current user's preference value.
UserPreferences	update(CoreSession session, DocumentRef docRef, UserPreferences docPreferences)	Updates a current user's document preferences.
protected static void	validatePreferences(Map<String,String> preferences)
protected static void	withDirectorySession(Consumer<Session> consumer)
protected static <R> R	withDirectorySession(Function<Session,R> function)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerContribution, registerExtension, setLastModified, setModifiedNow, setName, start, stop, unregister, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.runtime.model.Component

getApplicationStartedOrder

Field Details

DIRECTORY_NAME

protected static final String DIRECTORY_NAME

See Also:

• Constant Field Values

Constructor Details

UserPreferencesServiceImpl

public UserPreferencesServiceImpl()

Method Details

get

public Optional<UserPreference> get(CoreSession session,
 @Nonnull
 String key)

Description copied from interface: UserPreferencesService

Gets an optional current user's preference for the given key.

Specified by:

get in interface UserPreferencesService

Parameters:

session - the core session

key - the preference key

Returns:

the user preference entity if any

doGet

protected Optional<DocumentModel> doGet(CoreSession session,
 Session dirSession,
 String key)

get

public UserPreferences get(CoreSession session,
 @Nonnull
 DocumentRef docRef)

Description copied from interface: UserPreferencesService

Gets current user's preferences for the given document reference.

Specified by:

get in interface UserPreferencesService

Parameters:

session - the core session

docRef - the document reference

Returns:

the user document preferences entity

doGet

public UserPreferences doGet(CoreSession session,
 Session dirSession,
 IdRef idRef)

get

public Optional<UserPreference> get(CoreSession session,
 @Nonnull
 DocumentRef docRef,
 @Nonnull
 String key)

Description copied from interface: UserPreferencesService

Gets optional current user's preference for the given document reference and key.

Specified by:

get in interface UserPreferencesService

Parameters:

session - the core session

docRef - the document reference

key - the user preference key

Returns:

the user document preferences entity if any

list

public UserPreferences list(CoreSession session)

Description copied from interface: UserPreferencesService

Lists all current user's global preferences.

Specified by:

list in interface UserPreferencesService

Parameters:

session - the core session

Returns:

all the user preference entities

create

public UserPreference create(CoreSession session,
 @Nonnull
 String key,
 @Nonnull
 String value)

Description copied from interface: UserPreferencesService

Creates a current user's preference value for the given key.

Specified by:

create in interface UserPreferencesService

Parameters:

session - the core session

key - the preference key

value - the preference value

Returns:

the created user preference

doCreate

protected UserPreference doCreate(CoreSession session,
 Session dirSession,
 String key,
 String value)

createOrUpdate

public UserPreference createOrUpdate(CoreSession session,
 @Nonnull
 String key,
 @Nonnull
 String value)

Description copied from interface: UserPreferencesService

Creates or updates a current user's preference.

Specified by:

createOrUpdate in interface UserPreferencesService

Parameters:

session - the core session

key - the user preference key

value - the preference value

Returns:

the updated user preference

create

public UserPreferences create(CoreSession session,
 @Nonnull
 DocumentRef docRef,
 @Nonnull
 Map<String,String> preferences)

Description copied from interface: UserPreferencesService

Creates current user's document preferences.

Specified by:

create in interface UserPreferencesService

Parameters:

session - the core session

docRef - the document reference

preferences - the key / preferences map

Returns:

the created user document preferences

doCreate

protected UserPreferences doCreate(CoreSession session,
 Session dirSession,
 DocumentRef docRef,
 Map<String,String> preferences)

hasPreferences

protected static boolean hasPreferences(CoreSession session,
 Session dirSession,
 IdRef idRef)

update

public UserPreference update(CoreSession session,
 @Nonnull
 String key,
 @Nonnull
 String value)

Description copied from interface: UserPreferencesService

Updates a current user's preference value.

Specified by:

update in interface UserPreferencesService

Parameters:

session - the core session

key - the user preference key

value - the preference new value

Returns:

the updated user preference

doUpdate

protected UserPreference doUpdate(Session dirSession,
 DocumentModel docModel,
 String value)

update

public UserPreferences update(CoreSession session,
 @Nonnull
 DocumentRef docRef,
 @Nonnull
 UserPreferences docPreferences)

Description copied from interface: UserPreferencesService

Updates a current user's document preferences.

Existing document preferences are erased unlike UserPreferencesService.putAll(org.nuxeo.ecm.core.api.CoreSession, org.nuxeo.ecm.core.api.DocumentRef, org.nuxeo.user.preferences.api.UserPreferences) which preserves existing document preferences.

Specified by:

update in interface UserPreferencesService

Parameters:

session - the core session

docPreferences - the user preferences to be updated

Returns:

the updated user document preferences

putAll

public UserPreferences putAll(CoreSession session,
 @Nonnull
 DocumentRef docRef,
 @Nonnull
 UserPreferences docPreferences)

Description copied from interface: UserPreferencesService

Puts all current user's document preferences. If no UserPreferences exists for current user and document reference, it is created.

Existing document preferences are preserved unless explicitly overwritten by the given UserPreferences.

Specified by:

putAll in interface UserPreferencesService

Parameters:

session - the core session

docPreferences - the user preferences

Returns:

the created or updated user document preferences

remove

public UserPreferences remove(CoreSession session,
 @Nonnull
 DocumentRef docRef,
 @Nonnull
 String key)

Description copied from interface: UserPreferencesService

Removes the current user's preference for the given document reference and key.

Specified by:

remove in interface UserPreferencesService

Parameters:

session - the core session

docRef - the document reference

key - the preference key

Returns:

the updated user preferences

delete

public void delete(CoreSession session,
 @Nonnull
 String key)

Description copied from interface: UserPreferencesService

Deletes the current user's preference for the given key.

Specified by:

delete in interface UserPreferencesService

Parameters:

session - the core session

key - the user preference key

delete

public void delete(CoreSession session,
 @Nonnull
 DocumentRef docRef)

Description copied from interface: UserPreferencesService

Deletes all the current user's preferences for the given document reference.

Specified by:

delete in interface UserPreferencesService

Parameters:

session - the core session

docRef - the user preferences document reference

deleteAllForDocument

public void deleteAllForDocument(CoreSession session,
 @Nonnull
 IdRef idRef)

Description copied from interface: UserPreferencesService

Internal use.

Deletes all user preferences for the given document reference. The core session must have sufficient privileges to delete preferences of all users.

Specified by:

deleteAllForDocument in interface UserPreferencesService

Parameters:

session - the core session

idRef - the document id reference

deleteAllForUser

public void deleteAllForUser(CoreSession session,
 @Nonnull
 String userId)

Description copied from interface: UserPreferencesService

Internal use.

Deletes all preferences for the given user id. The core session must have sufficient privileges to delete preferences of the given user id.

Specified by:

deleteAllForUser in interface UserPreferencesService

Parameters:

session - the core session

userId - the user id

doBatchDelete

protected void doBatchDelete(QueryBuilder queryBuilder)

checkMaxPreferences

protected static void checkMaxPreferences(CoreSession session,
 Session dirSession,
 int nbNew)

getDocId

protected static IdRef getDocId(CoreSession session,
 DocumentRef documentRef)

getFieldMap

protected static Map<String,Object> getFieldMap(CoreSession session,
 IdRef idRef,
 String key,
 String value)

newUserPreference

protected static UserPreference newUserPreference(DocumentModel document)

queryPreferences

protected static DocumentModelList queryPreferences(CoreSession session,
 Session dirSession,
 IdRef idRef,
 String key,
 long limit)

retrieveAllDocPreferences

protected static DocumentModelList retrieveAllDocPreferences(CoreSession session,
 Session dirSession,
 IdRef idRef)

retrieveAllPreferencesForUser

protected static DocumentModelList retrieveAllPreferencesForUser(CoreSession session,
 Session dirSession)

retrieveDocPreferenceForKey

protected static Optional<DocumentModel> retrieveDocPreferenceForKey(CoreSession session,
 Session dirSession,
 IdRef idRef,
 String key)

validatePreferences

protected static void validatePreferences(Map<String,String> preferences)

withDirectorySession

protected static <R> R withDirectorySession(Function<Session,R> function)

withDirectorySession

protected static void withDirectorySession(Consumer<Session> consumer)