Package dev.getelements.elements.service.profile

Class SuperUserProfileService

java.lang.Object

dev.getelements.elements.service.profile.SuperUserProfileService

All Implemented Interfaces:

ProfileService

public class SuperUserProfileService
extends Object
implements ProfileService

Provides full access to the Profile and related types. Should be used in conjunction with users SUPERUSER level access. Created by patricktwohig on 6/28/17.

Field Summary

Fields inherited from interface dev.getelements.elements.sdk.service.profile.ProfileService

PROFILE_CREATED_EVENT

Constructor Summary

Constructors

Constructor	Description
SuperUserProfileService()

Method Summary

Modifier and Type	Method	Description
Profile	createProfile(CreateProfileRequest createProfileRequest)	Creates a new profile.
void	deleteProfile(String profileId)	Deletes the Profile with the supplied profile ID.
Optional<Profile>	findCurrentProfile()	Finds the currently active profile, if any.
ApplicationDao	getApplicationDao()
Profile	getCurrentProfile()	Returns the Profile of the currently logged-in user.
Optional<Profile>	getCurrentProfileOptional()
Supplier<Profile>	getCurrentProfileSupplier()
ElementRegistry	getElementRegistry()
LargeObjectDao	getLargeObjectDao()
NameService	getNameService()
Profile	getProfile(String profileId)	Fetches a specific Profile instance based on ID.
ProfileDao	getProfileDao()
ProfileImageObjectUtils	getProfileImageObjectUtils()
Pagination<Profile>	getProfiles(int offset, int count, String search)	Lists all Profile instances, specifying a search query.
Pagination<Profile>	getProfiles(int offset, int count, String applicationNameOrId, String userId, Long lowerBoundTimestamp, Long upperBoundTimestamp)	Lists all Profile instances starting with the offset and count.
ProfileServiceUtils	getProfileServiceUtils()
UserDao	getUserDao()
void	setApplicationDao(ApplicationDao applicationDao)
void	setCurrentProfileOptional(Optional<Profile> currentProfileOptional)
void	setCurrentProfileSupplier(Supplier<Profile> currentProfileSupplier)
void	setElementRegistry(ElementRegistry elementRegistry)
void	setLargeObjectDao(LargeObjectDao largeObjectDao)
void	setNameService(NameService nameService)
void	setProfileDao(ProfileDao profileDao)
void	setProfileImageObjectUtils(ProfileImageObjectUtils profileImageObjectUtils)
void	setProfileServiceUtils(ProfileServiceUtils profileServiceUtils)
void	setUserDao(UserDao userDao)
Profile	updateProfile(String profileId, UpdateProfileRequest profileRequest)	Updates the supplied Profile.
Profile	updateProfileImage(String profileId, UpdateProfileImageRequest updateProfileImageRequest)	Update profile image related fields

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.getelements.elements.sdk.service.profile.ProfileService

redactPrivateInformation

Constructor Details

SuperUserProfileService

public SuperUserProfileService()

Method Details

getProfiles

public Pagination<Profile> getProfiles(int offset,
 int count,
 String applicationNameOrId,
 String userId,
 Long lowerBoundTimestamp,
 Long upperBoundTimestamp)

Description copied from interface: ProfileService

Lists all Profile instances starting with the offset and count.

Specified by:

getProfiles in interface ProfileService

Parameters:

offset - the offset

count - the count

applicationNameOrId - the application name or ID to use when fetching the profiles

userId - the userId which to use when filtering. If null, then no filtering will be applied.

lowerBoundTimestamp -

upperBoundTimestamp -

Returns:

a Pagination of Profile instances

getProfiles

public Pagination<Profile> getProfiles(int offset,
 int count,
 String search)

Description copied from interface: ProfileService

Lists all Profile instances, specifying a search query.

Specified by:

getProfiles in interface ProfileService

Parameters:

offset -

count -

search -

Returns:

getProfile

public Profile getProfile(String profileId)

Description copied from interface: ProfileService

Fetches a specific Profile instance based on ID. If not found, an exception is raised.

Specified by:

getProfile in interface ProfileService

Parameters:

profileId - the profile ID

Returns:

the Profile, never null

getCurrentProfile

public Profile getCurrentProfile()

Description copied from interface: ProfileService

Returns the Profile of the currently logged-in user. If the user has no profile, or that information is not available, then this will throw an exception. Using a profile is not required for all calls. Therefore, it should be expected that this will throw NotFoundException under normal circumstances.

Specified by:

getCurrentProfile in interface ProfileService

Returns:

the Profile, or null, if no profile is found.

findCurrentProfile

public Optional<Profile> findCurrentProfile()

Description copied from interface: ProfileService

Finds the currently active profile, if any.

Specified by:

findCurrentProfile in interface ProfileService

Returns:

an Optional<Profile>

updateProfile

public Profile updateProfile(String profileId,
 UpdateProfileRequest profileRequest)

Description copied from interface: ProfileService

Updates the supplied Profile. The Profile.getId() method is used to key the Profile.

Specified by:

updateProfile in interface ProfileService

Parameters:

profileId - the profile id of the Profile to update

profileRequest - the UpdateProfileRequest with the information to update

Returns:

the Profile as it was changed by the service.

createProfile

public Profile createProfile(CreateProfileRequest createProfileRequest)

Description copied from interface: ProfileService

Creates a new profile. The ID of the profile, as specified by Profile.getId(), should be null and will be assigned.

Specified by:

createProfile in interface ProfileService

Parameters:

createProfileRequest - the CreateProfileRequest with the information to create

Returns:

the Profile as it was created by the service.

deleteProfile

public void deleteProfile(String profileId)

Description copied from interface: ProfileService

Deletes the Profile with the supplied profile ID.

Specified by:

deleteProfile in interface ProfileService

Parameters:

profileId - the profile ID.

updateProfileImage

public Profile updateProfileImage(String profileId,
 UpdateProfileImageRequest updateProfileImageRequest)
                           throws IOException

Description copied from interface: ProfileService

Update profile image related fields

Specified by:

updateProfileImage in interface ProfileService

Parameters:

updateProfileImageRequest - request with image object values

Throws:

IOException

getProfileDao

public ProfileDao getProfileDao()

getUserDao

public UserDao getUserDao()

setUserDao

@Inject
public void setUserDao(UserDao userDao)

setProfileDao

@Inject
public void setProfileDao(ProfileDao profileDao)

getApplicationDao

public ApplicationDao getApplicationDao()

getNameService

public NameService getNameService()

setNameService

@Inject
public void setNameService(@Named("dev.getelements.elements.service.unscoped")
 NameService nameService)

setApplicationDao

@Inject
public void setApplicationDao(ApplicationDao applicationDao)

getCurrentProfileOptional

public Optional<Profile> getCurrentProfileOptional()

setCurrentProfileOptional

@Inject
public void setCurrentProfileOptional(Optional<Profile> currentProfileOptional)

getCurrentProfileSupplier

public Supplier<Profile> getCurrentProfileSupplier()

setCurrentProfileSupplier

@Inject
public void setCurrentProfileSupplier(Supplier<Profile> currentProfileSupplier)

getProfileServiceUtils

public ProfileServiceUtils getProfileServiceUtils()

setProfileServiceUtils

@Inject
public void setProfileServiceUtils(ProfileServiceUtils profileServiceUtils)

getProfileImageObjectUtils

public ProfileImageObjectUtils getProfileImageObjectUtils()

setProfileImageObjectUtils

@Inject
public void setProfileImageObjectUtils(ProfileImageObjectUtils profileImageObjectUtils)

getLargeObjectDao

public LargeObjectDao getLargeObjectDao()

setLargeObjectDao

@Inject
public void setLargeObjectDao(LargeObjectDao largeObjectDao)

getElementRegistry

public ElementRegistry getElementRegistry()

setElementRegistry

@Inject
public void setElementRegistry(ElementRegistry elementRegistry)