com.atlassian.crowd.openid.server.manager.profile

Class ProfileManagerGeneric

java.lang.Object

com.atlassian.crowd.openid.server.manager.profile.ProfileManagerGeneric

All Implemented Interfaces:

ProfileManager

public class ProfileManagerGeneric
extends Object
implements ProfileManager

Constructor Summary

Constructors

Constructor and Description
ProfileManagerGeneric(ProfileDAO profileDAO, UserDAO userDAO, AttributeDAO attributeDAO, SiteApprovalDAO siteApprovalDAO)

Method Summary

Modifier and Type	Method and Description
Profile	addNewPopulatedProfile(User user, String profileName, Map<String,String> attributes) Adds a new profile based on attribute name/value pairs.
Profile	addNewProfile(User user, User principal, Locale locale, String profileName) Creates and adds a new profile to a given user.
void	deleteProfile(User user, long profileID) Deletes a the given profile from a user.
Profile	getProfile(User user, long profileID) Retrieves the requested profile from a user.
void	makeDefaultProfile(User user, long profileID) Changes the default profile of a user.
void	updateProfile(User user, long profileID, Map<String,String> attributes) Updates a user's profile given a map of attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProfileManagerGeneric

public ProfileManagerGeneric(ProfileDAO profileDAO,
                             UserDAO userDAO,
                             AttributeDAO attributeDAO,
                             SiteApprovalDAO siteApprovalDAO)

Method Detail

addNewProfile

public Profile addNewProfile(User user,
                             User principal,
                             Locale locale,
                             String profileName)
                      throws ProfileAlreadyExistsException

Description copied from interface: ProfileManager

Creates and adds a new profile to a given user. Default profile data is obtained from the principal/locale. The following mapping is used: 1. fullname = FirstName + " " + LastName 2. nickname = Username 3. email = Email 4. country = Locale.getCountry() 5. language = Locale.getLanguage()

Specified by:

addNewProfile in interface ProfileManager

Parameters:

user - the user object to add the new profile to.

principal - the principal which contains basic attribute data.

locale - the Locale of the user (to get country/language information).

profileName - the name of the new profile.

Returns:

new profile.

Throws:

ProfileAlreadyExistsException - if the user already has a profile with the given profile name.

addNewPopulatedProfile

public Profile addNewPopulatedProfile(User user,
                                      String profileName,
                                      Map<String,String> attributes)
                               throws ProfileAlreadyExistsException

Description copied from interface: ProfileManager

Adds a new profile based on attribute name/value pairs.

Specified by:

addNewPopulatedProfile in interface ProfileManager

Parameters:

user - user that owns the profile.

profileName - the name of the new profile.

attributes - Map<String attributeName, String attributeValue>

Returns:

newly created profile.

Throws:

ProfileAlreadyExistsException - if the user already has a profile with the given profile name.

updateProfile

public void updateProfile(User user,
                          long profileID,
                          Map<String,String> attributes)
                   throws ProfileDoesNotExistException,
                          ProfileAccessViolationException

Description copied from interface: ProfileManager

Updates a user's profile given a map of attributes. The user must own the profile referenced by the profileID. The map of attribute name-values must be non-null. Any attribute names (keys) which are stored in the profile but not the attribute map, will be deleted. All other attribute names will be updated or added.

Specified by:

updateProfile in interface ProfileManager

Parameters:

user - user that owns the profile.

profileID - profile ID of the profile to update.

attributes - Map<String attributeName, String attributeValue>

Throws:

ProfileDoesNotExistException - if profile with requested profileID does not exist.

ProfileAccessViolationException - if the user does not own the profile with the requested profileID.

makeDefaultProfile

public void makeDefaultProfile(User user,
                               long profileID)
                        throws ProfileDoesNotExistException,
                               ProfileAccessViolationException

Description copied from interface: ProfileManager

Changes the default profile of a user.

Specified by:

makeDefaultProfile in interface ProfileManager

Parameters:

user - user that owns the profile.

profileID - profile ID of the profile to set as default.

Throws:

ProfileDoesNotExistException - if profile with requested profileID does not exist.

ProfileAccessViolationException - if the user does not own the profile with the requested profileID.

deleteProfile

public void deleteProfile(User user,
                          long profileID)
                   throws ProfileDoesNotExistException,
                          ProfileAccessViolationException,
                          DefaultProfileDeleteException

Description copied from interface: ProfileManager

Deletes a the given profile from a user. Note: a user is not allowed to delete their default profile.

Specified by:

deleteProfile in interface ProfileManager

Parameters:

user - user that owns the profile.

profileID - profile ID of the profile to update.

Throws:

ProfileDoesNotExistException - if profile with requested profileID does not exist.

ProfileAccessViolationException - if the user does not own the profile with the requested profileID.

DefaultProfileDeleteException - if the profile requested for deletion is the default profile of the user.

getProfile

public Profile getProfile(User user,
                          long profileID)
                   throws ProfileDoesNotExistException,
                          ProfileAccessViolationException

Description copied from interface: ProfileManager

Retrieves the requested profile from a user.

Specified by:

getProfile in interface ProfileManager

Parameters:

user - user that owns the profile.

profileID - profile ID of the profile to retrieve.

Returns:

profile corresponding to profileID owned by user.

Throws:

ProfileDoesNotExistException - profile with given profileID does not exist.

ProfileAccessViolationException - profile with given profileID exists but is not owned by the user.