com.communote.server.core.user

Class UserProfileManagementBase

java.lang.Object

com.communote.server.core.user.UserProfileManagementBase

All Implemented Interfaces:

UserProfileManagement

Direct Known Subclasses:

UserProfileManagementImpl

public abstract class UserProfileManagementBase
extends Object
implements UserProfileManagement

Spring Service base class for com.communote.server.service.user.UserProfileManagement, provides access to all services and entities referenced by this service.

Author:

Communote GmbH - http://www.communote.com/

See Also:

UserProfileManagement

Constructor Summary

Constructors

Constructor and Description
UserProfileManagementBase()

Method Summary

Modifier and Type	Method and Description
void	addMessagingConnectorConfig(Long notificationConfigId, MessagerConnectorConfig config)
void	anonymizeUserProfile(Long profileId) Makes a user profile anonymous.
UserProfile	findUserProfileByUserId(Long userId) Finds the user profile to a user.
UserProfileDetailListItem	findUserProfileDetailListItemByUserId(Long userId)
UserProfileVO	findUserProfileVOByUserId(Long userId)
protected ContactDao	getContactDao() Gets the reference to contact's DAO.
protected MessagerConnectorConfigDao	getMessagerConnectorConfigDao() Gets the reference to messagerConnectorConfig's DAO.
List<MessagerConnectorConfigTO>	getMessagerConnectorConfigs() Returns the messager connector configurations of the current user.
protected NotificationConfigDao	getNotificationConfigDao() Gets the reference to notificationConfig's DAO.
protected Principal	getPrincipal() Gets the current principal if one has been set, otherwise returns null.
protected UserDao	getUserDao() Gets the reference to kenmeiUser's DAO.
protected UserImageDao	getUserImageDao() Gets the reference to userImage's DAO.
protected UserProfileDao	getUserProfileDao() Gets the reference to userProfile's DAO.
protected abstract void	handleAddMessagingConnectorConfig(Long notificationConfigId, MessagerConnectorConfig config) Performs the core logic for addMessagingConnectorConfig(Long, MessagerConnectorConfig)
protected abstract void	handleAnonymizeUserProfile(Long profileId) Performs the core logic for anonymizeUserProfile(Long)
protected abstract UserProfile	handleFindUserProfileByUserId(Long userId) Performs the core logic for findUserProfileByUserId(Long)
protected abstract UserProfileDetailListItem	handleFindUserProfileDetailListItemByUserId(Long userId) Performs the core logic for findUserProfileDetailListItemByUserId(Long)
protected abstract UserProfileVO	handleFindUserProfileVOByUserId(Long userId) Performs the core logic for findUserProfileVOByUserId(Long)
protected abstract List<MessagerConnectorConfigTO>	handleGetMessagerConnectorConfigs() Performs the core logic for getMessagerConnectorConfigs()
protected abstract boolean	handleHasCustomUserImage(Long userId)
protected abstract ImageVO	handleLoadImage(Long userId) Performs the core logic for #loadImage(Long, com.communote.server.persistence.user.ImageSizeType)
protected abstract boolean	handleRemoveUserImage(Long userId) Remove the image of a user.
protected abstract void	handleUpdateImage(Long userId, byte[] userImage) Update the image of a user.
protected abstract void	handleUpdateNotificationConfig(Map<MessagerConnectorType,MessagerConnectorConfigTO> connectorConfigs) Performs the core logic for updateNotificationConfig(Map)
protected abstract void	handleUpdateUserProfile(Long userId, UserProfileVO userProfile) Performs the core logic for updateUserProfile(Long, com.communote.server.persistence.user.UserProfileVO)
boolean	hasCustomUserImage(Long userId) Return whether a user uploaded a custom image.
ImageVO	loadImage(Long userId) Get the user image
boolean	removeUserImage(Long userId) Remove the image of a user.
void	setContactDao(ContactDao contactDao) Sets the reference to contact's DAO.
void	setMessagerConnectorConfigDao(MessagerConnectorConfigDao messagerConnectorConfigDao) Sets the reference to messagerConnectorConfig's DAO.
void	setNotificationConfigDao(NotificationConfigDao notificationConfigDao) Sets the reference to notificationConfig's DAO.
void	setUserDao(UserDao userDao) Sets the reference to kenmeiUser's DAO.
void	setUserImageDao(UserImageDao userImageDao) Sets the reference to userImage's DAO.
void	setUserProfileDao(UserProfileDao userProfileDao) Sets the reference to kenmeiUserProfile's DAO.
void	updateImage(Long userId, byte[] userImage) Update the image of a user.
void	updateNotificationConfig(Map<MessagerConnectorType,MessagerConnectorConfigTO> connectorConfigs) Updates the notification configuration of the current user by adding new, removing or updating existing messager connector configurations.
void	updateUserProfile(Long userId, UserProfileVO userProfile) Updates the user profile in the database.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.communote.server.core.user.UserProfileManagement

getUserProfileDetailsById, getUserProfileDetailsById

Constructor Detail

UserProfileManagementBase

public UserProfileManagementBase()

Method Detail

addMessagingConnectorConfig

public void addMessagingConnectorConfig(Long notificationConfigId,
                                        MessagerConnectorConfig config)

Specified by:

addMessagingConnectorConfig in interface UserProfileManagement

Parameters:

notificationConfigId - Id of the notification config.

config - The configuration.

See Also:

UserProfileManagement.addMessagingConnectorConfig(Long, MessagerConnectorConfig)

anonymizeUserProfile

public void anonymizeUserProfile(Long profileId)

Description copied from interface: UserProfileManagement

Makes a user profile anonymous.

Specified by:

anonymizeUserProfile in interface UserProfileManagement

Parameters:

profileId - Id of the profile.

See Also:

UserProfileManagement.anonymizeUserProfile(Long)

findUserProfileByUserId

public UserProfile findUserProfileByUserId(Long userId)

Description copied from interface: UserProfileManagement

Finds the user profile to a user.

Specified by:

findUserProfileByUserId in interface UserProfileManagement

Parameters:

userId - The users id.

Returns:

The profile.

See Also:

UserProfileManagement.findUserProfileByUserId(Long)

findUserProfileDetailListItemByUserId

public UserProfileDetailListItem findUserProfileDetailListItemByUserId(Long userId)

Specified by:

findUserProfileDetailListItemByUserId in interface UserProfileManagement

Parameters:

userId - The users id.

Returns:

The Profile.

findUserProfileVOByUserId

public UserProfileVO findUserProfileVOByUserId(Long userId)

Specified by:

findUserProfileVOByUserId in interface UserProfileManagement

Parameters:

userId - The users id.

Returns:

The profile.

See Also:

UserProfileManagement.findUserProfileVOByUserId(Long)

getContactDao

protected ContactDao getContactDao()

Gets the reference to contact's DAO.

getMessagerConnectorConfigDao

protected MessagerConnectorConfigDao getMessagerConnectorConfigDao()

Gets the reference to messagerConnectorConfig's DAO.

getMessagerConnectorConfigs

public List<MessagerConnectorConfigTO> getMessagerConnectorConfigs()

Returns the messager connector configurations of the current user.

Specified by:

getMessagerConnectorConfigs in interface UserProfileManagement

Returns:

the messager connector configurations of the current user

getNotificationConfigDao

protected NotificationConfigDao getNotificationConfigDao()

Gets the reference to notificationConfig's DAO.

getPrincipal

protected Principal getPrincipal()

Gets the current principal if one has been set, otherwise returns null.

Returns:

the current principal

getUserDao

protected UserDao getUserDao()

Gets the reference to kenmeiUser's DAO.

getUserImageDao

protected UserImageDao getUserImageDao()

Gets the reference to userImage's DAO.

getUserProfileDao

protected UserProfileDao getUserProfileDao()

Gets the reference to userProfile's DAO.

handleAddMessagingConnectorConfig

protected abstract void handleAddMessagingConnectorConfig(Long notificationConfigId,
                                                          MessagerConnectorConfig config)

Performs the core logic for addMessagingConnectorConfig(Long, MessagerConnectorConfig)

handleAnonymizeUserProfile

protected abstract void handleAnonymizeUserProfile(Long profileId)

Performs the core logic for anonymizeUserProfile(Long)

handleFindUserProfileByUserId

protected abstract UserProfile handleFindUserProfileByUserId(Long userId)

Performs the core logic for findUserProfileByUserId(Long)

handleFindUserProfileDetailListItemByUserId

protected abstract UserProfileDetailListItem handleFindUserProfileDetailListItemByUserId(Long userId)

Performs the core logic for findUserProfileDetailListItemByUserId(Long)

Parameters:

userId - the ID of the user

Returns:

the profile details of the user identified by the provided ID

handleFindUserProfileVOByUserId

protected abstract UserProfileVO handleFindUserProfileVOByUserId(Long userId)

Performs the core logic for findUserProfileVOByUserId(Long)

handleGetMessagerConnectorConfigs

protected abstract List<MessagerConnectorConfigTO> handleGetMessagerConnectorConfigs()

Performs the core logic for getMessagerConnectorConfigs()

Returns:

the messager connector configurations of the current user

handleHasCustomUserImage

protected abstract boolean handleHasCustomUserImage(Long userId)

Returns:

whether the user has a custom image

handleLoadImage

protected abstract ImageVO handleLoadImage(Long userId)

Performs the core logic for #loadImage(Long, com.communote.server.persistence.user.ImageSizeType)

Parameters:

userId - The users id.

Returns:

The image of the user.

handleRemoveUserImage

protected abstract boolean handleRemoveUserImage(Long userId)
                                          throws AuthorizationException,
                                                 UserNotFoundException

Remove the image of a user.

Parameters:

userId - The ID of the user whose image should be removed

Returns:

true if the image was removed or false if the user did not have a custom image

Throws:

AuthorizationException - in case the current user is not the user whose image should be removed or client manager or internal system user

UserNotFoundException - in case the user with ID userId does not exist

handleUpdateImage

protected abstract void handleUpdateImage(Long userId,
                                          byte[] userImage)
                                   throws UserNotFoundException,
                                          AuthorizationException

Update the image of a user.

Parameters:

userId - The users id.

largeUserImage - The user image as byte array.

Throws:

AuthorizationException - in case the current user is not the user whose image should be updated or the current user is not client manager or internal system user

UserNotFoundException - in case the user with ID userId does not exist

handleUpdateNotificationConfig

protected abstract void handleUpdateNotificationConfig(Map<MessagerConnectorType,MessagerConnectorConfigTO> connectorConfigs)

Performs the core logic for updateNotificationConfig(Map)

Parameters:

connectorConfigs - the new configuration data

handleUpdateUserProfile

protected abstract void handleUpdateUserProfile(Long userId,
                                                UserProfileVO userProfile)

Performs the core logic for updateUserProfile(Long, com.communote.server.persistence.user.UserProfileVO)

hasCustomUserImage

public boolean hasCustomUserImage(Long userId)

Description copied from interface: UserProfileManagement

Return whether a user uploaded a custom image.

Specified by:

hasCustomUserImage in interface UserProfileManagement

Parameters:

userId - the ID of the user

Returns:

true if the user exists and has a custom image, false otherwise

loadImage

public ImageVO loadImage(Long userId)

Description copied from interface: UserProfileManagement

Get the user image

Specified by:

loadImage in interface UserProfileManagement

Parameters:

userId - The users id.

Returns:

The image.

See Also:

com.communote.server.core.user.UserProfileManagement#loadImage(Long, com.communote.server.persistence.user.ImageSizeType)

removeUserImage

public boolean removeUserImage(Long userId)
                        throws UserNotFoundException,
                               AuthorizationException

Description copied from interface: UserProfileManagement

Remove the image of a user.

Specified by:

removeUserImage in interface UserProfileManagement

Parameters:

userId - The ID of the user whose image should be removed

Returns:

true if the image was removed or false if the user did not have a custom image

Throws:

UserNotFoundException - in case the user with ID userId does not exist

AuthorizationException - in case the current user is not the user whose image should be updated or the current user is not client manager or internal system user

setContactDao

public void setContactDao(ContactDao contactDao)

Sets the reference to contact's DAO.

setMessagerConnectorConfigDao

public void setMessagerConnectorConfigDao(MessagerConnectorConfigDao messagerConnectorConfigDao)

Sets the reference to messagerConnectorConfig's DAO.

setNotificationConfigDao

public void setNotificationConfigDao(NotificationConfigDao notificationConfigDao)

Sets the reference to notificationConfig's DAO.

setUserDao

public void setUserDao(UserDao userDao)

Sets the reference to kenmeiUser's DAO.

setUserImageDao

public void setUserImageDao(UserImageDao userImageDao)

Sets the reference to userImage's DAO.

setUserProfileDao

public void setUserProfileDao(UserProfileDao userProfileDao)

Sets the reference to kenmeiUserProfile's DAO.

updateImage

public void updateImage(Long userId,
                        byte[] userImage)
                 throws UserNotFoundException,
                        AuthorizationException

Description copied from interface: UserProfileManagement

Update the image of a user.

Specified by:

updateImage in interface UserProfileManagement

Parameters:

userId - The users id.

userImage - The user image as byte array.

Throws:

UserNotFoundException - in case the user with ID userId does not exist

AuthorizationException - in case the current user is not the user whose image should be updated or the current user is not client manager or internal system user

updateNotificationConfig

public void updateNotificationConfig(Map<MessagerConnectorType,MessagerConnectorConfigTO> connectorConfigs)

Updates the notification configuration of the current user by adding new, removing or updating existing messager connector configurations.

Specified by:

updateNotificationConfig in interface UserProfileManagement

Parameters:

connectorConfigs - a definition with the new connector configurations. Configurations for connector types that are not yet part of the notification configuration of the current user will be added. Configurations with connector types that are part of the current notification configuration but that are not listed in the mapping will be removed. All the the other configurations will be updated if necessary.

updateUserProfile

public void updateUserProfile(Long userId,
                              UserProfileVO userProfile)

Description copied from interface: UserProfileManagement

Updates the user profile in the database.

Specified by:

updateUserProfile in interface UserProfileManagement

Parameters:

userId - The users id.

userProfile - The profile.

See Also:

UserProfileManagement.updateUserProfile(Long, com.communote.server.persistence.user.UserProfileVO)