Interface UserProfileService
- All Known Implementing Classes:
UserProfileServiceImpl
public interface UserProfileService
A service to manage user profiles
- Since:
- 5.5
- Author:
- Quentin Lamerand
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Clears the user profile cache.Get the user profile XMap descriptor for the importer configgetUserProfile
(DocumentModel userModel, CoreSession session) Get a DocumentModel containing both user and user profile schemasgetUserProfileDocument
(String userName, CoreSession session) Get the profile of a specific user.getUserProfileDocument
(CoreSession session) Get the current user profile.
-
Method Details
-
getUserProfileDocument
Get the current user profile. It's stored in its user workspace.- Parameters:
session
- the current CoreSession- Returns:
- the user profile DocumentModel
-
getUserProfileDocument
Get the profile of a specific user. It's stored in its user workspace.- Parameters:
userName
- the user namesession
- the current CoreSession- Returns:
- the user profile DocumentModel
-
getUserProfile
Get a DocumentModel containing both user and user profile schemas- Parameters:
userModel
- the user DocumentModelsession
- the current CoreSession- Returns:
- a SimpleDocumentModel with the two schemas
-
clearCache
void clearCache()Clears the user profile cache. -
getImporterConfig
ImporterConfig getImporterConfig()Get the user profile XMap descriptor for the importer config- Returns:
- an XMap ImportConfig descriptor
-