org.exoplatform.social.addons.storage

Class RDBMSIdentityStorageImpl

java.lang.Object

org.exoplatform.container.component.BaseComponentPlugin

org.exoplatform.social.core.storage.impl.AbstractStorage

org.exoplatform.social.core.storage.impl.IdentityStorageImpl

org.exoplatform.social.addons.storage.RDBMSIdentityStorageImpl

All Implemented Interfaces:

org.exoplatform.container.component.ComponentPlugin, org.exoplatform.social.core.storage.api.IdentityStorage

public class RDBMSIdentityStorageImpl
extends org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Created by The eXo Platform SAS Author : eXoPlatform exo@exoplatform.com Oct 5, 2015

Field Summary

Fields inherited from class org.exoplatform.social.core.storage.impl.AbstractStorage

lifeCycle, NODETYPE_PROVIDERS, NODETYPE_SPACES, NS_EXO, NS_JCR, RECEIVER, SENDER, SPACE_NODETYPE_PATH

Fields inherited from class org.exoplatform.container.component.BaseComponentPlugin

desc, name

Constructor Summary

Constructors

Constructor and Description
RDBMSIdentityStorageImpl(IdentityDAO identityDAO, SpaceDAO spaceDAO, ActivityDAO activityDAO, org.exoplatform.commons.file.services.FileService fileService, ProfileSearchConnector profileSearchConnector, org.exoplatform.services.organization.OrganizationService orgService)

Method Summary

Modifier and Type	Method and Description
void	addOrModifyProfileProperties(org.exoplatform.social.core.identity.model.Profile profile) Add or modify properties of profile and persist to JCR.
void	deleteIdentity(org.exoplatform.social.core.identity.model.Identity identity) Deletes an identity from JCR
org.exoplatform.commons.utils.ListAccess<org.exoplatform.social.core.identity.model.Identity>	findByFilter(ExtendProfileFilter filter)
org.exoplatform.social.core.identity.model.Identity	findIdentity(String providerId, String remoteId) Gets the identity by remote id.
org.exoplatform.social.core.identity.model.Identity	findIdentityById(String nodeId) Gets the identity by his id.
Set<String>	getActiveUsers(org.exoplatform.social.core.identity.model.ActiveIdentityFilter filter) Gets the active user list base on the given ActiveIdentityFilter.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesByFirstCharacterOfName(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter, long offset, long limit, boolean forceLoadOrReloadProfile)
int	getIdentitiesByFirstCharacterOfNameCount(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter)
List<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesByProfileFilter(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter, long offset, long limit, boolean forceLoadOrReloadProfile)
int	getIdentitiesByProfileFilterCount(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter)
int	getIdentitiesCount(String providerId) Gets total number of identities in storage depend on providerId.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesForMentions(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter, long offset, long limit, boolean forceLoadOrReloadProfile)
List<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesForUnifiedSearch(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter, long offset, long limit)
String	getProfileActivityId(org.exoplatform.social.core.identity.model.Profile profile, org.exoplatform.social.core.identity.model.Profile.AttachedActivityType type) Gets profile activity id by type.
List<org.exoplatform.social.core.identity.model.Identity>	getSpaceMemberIdentitiesByProfileFilter(org.exoplatform.social.core.space.model.Space space, org.exoplatform.social.core.profile.ProfileFilter profileFilter, org.exoplatform.social.core.identity.SpaceMemberFilterListAccess.Type type, long offset, long limit)
String	getType(String nodetype, String property) Gets the type.
void	hardDeleteIdentity(org.exoplatform.social.core.identity.model.Identity identity) Hard delete an identity from JCR
org.exoplatform.social.core.identity.model.Profile	loadProfile(org.exoplatform.social.core.identity.model.Profile profile) Load profile.
void	processEnabledIdentity(org.exoplatform.social.core.identity.model.Identity identity, boolean isEnable) Process enable/disable Identity
void	removeIdentity(org.exoplatform.social.core.identity.model.Identity identity) This method is introduced to clean totally identity from database It's used in unit test
void	saveIdentity(org.exoplatform.social.core.identity.model.Identity identity) Saves identity.
void	saveProfile(org.exoplatform.social.core.identity.model.Profile profile) Saves profile.
void	setProfileSearchConnector(ProfileSearchConnector profileSearchConnector)
org.exoplatform.social.core.identity.model.Identity	updateIdentity(org.exoplatform.social.core.identity.model.Identity identity) Updates existing identity's properties.
void	updateIdentityMembership(String remoteId) Updates existing identity's membership in OrganizationService.
void	updateProfile(org.exoplatform.social.core.identity.model.Profile profile) Updates profile.
void	updateProfileActivityId(org.exoplatform.social.core.identity.model.Identity identity, String activityId, org.exoplatform.social.core.identity.model.Profile.AttachedActivityType type) Updates profile activity id by type.

Methods inherited from class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

_createIdentity, _createProfile, _deleteIdentity, _findIdentity, _findIdentityEntity, _findIdentityEntity, _hardDeleteIdentity, _loadProfile, _removeRelationshipList, _removeSpaceMembership, _saveIdentity, _saveProfile, getSpaceMemberIdentitiesByProfileFilterCount, setStorage

Methods inherited from class org.exoplatform.social.core.storage.impl.AbstractStorage

_findById, _findByPath, _getMixin, _hasMixin, _removeById, _removeMixin, _skip, getProviderRoot, getSession, getSpaceRoot, getStatus, isJcrProperty, lifecycleLookup, node, nodes, nodes, startSynchronization, stopSynchronization

Methods inherited from class org.exoplatform.container.component.BaseComponentPlugin

getDescription, getName, setDescription, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

RDBMSIdentityStorageImpl

public RDBMSIdentityStorageImpl(IdentityDAO identityDAO,
                                SpaceDAO spaceDAO,
                                ActivityDAO activityDAO,
                                org.exoplatform.commons.file.services.FileService fileService,
                                ProfileSearchConnector profileSearchConnector,
                                org.exoplatform.services.organization.OrganizationService orgService)

Method Detail

setProfileSearchConnector

public void setProfileSearchConnector(ProfileSearchConnector profileSearchConnector)

saveIdentity

public void saveIdentity(org.exoplatform.social.core.identity.model.Identity identity)
                  throws org.exoplatform.social.core.storage.IdentityStorageException

Saves identity.

Specified by:

saveIdentity in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

saveIdentity in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

identity - the identity

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

updateIdentity

public org.exoplatform.social.core.identity.model.Identity updateIdentity(org.exoplatform.social.core.identity.model.Identity identity)
                                                                   throws org.exoplatform.social.core.storage.IdentityStorageException

Updates existing identity's properties.

Specified by:

updateIdentity in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

updateIdentity in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

identity - the identity to be updated.

Returns:

the updated identity.

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

Since:

1.2.0-GA

updateIdentityMembership

public void updateIdentityMembership(String remoteId)
                              throws org.exoplatform.social.core.storage.IdentityStorageException

Updates existing identity's membership in OrganizationService.

Specified by:

updateIdentityMembership in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

updateIdentityMembership in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

remoteId - the remoteId to be updated membership.

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

Since:

4.0.0

findIdentityById

public org.exoplatform.social.core.identity.model.Identity findIdentityById(String nodeId)
                                                                     throws org.exoplatform.social.core.storage.IdentityStorageException

Gets the identity by his id.

Specified by:

findIdentityById in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

findIdentityById in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

nodeId - the id of identity

Returns:

the identity

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

deleteIdentity

public void deleteIdentity(org.exoplatform.social.core.identity.model.Identity identity)
                    throws org.exoplatform.social.core.storage.IdentityStorageException

Deletes an identity from JCR

Specified by:

deleteIdentity in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

deleteIdentity in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

identity - the Identity to be deleted

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

hardDeleteIdentity

public void hardDeleteIdentity(org.exoplatform.social.core.identity.model.Identity identity)
                        throws org.exoplatform.social.core.storage.IdentityStorageException

Hard delete an identity from JCR

Specified by:

hardDeleteIdentity in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

hardDeleteIdentity in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

identity - the identity to be deleted

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

loadProfile

public org.exoplatform.social.core.identity.model.Profile loadProfile(org.exoplatform.social.core.identity.model.Profile profile)
                                                               throws org.exoplatform.social.core.storage.IdentityStorageException

Load profile.

Specified by:

loadProfile in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

loadProfile in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

profile - the profile

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

findIdentity

public org.exoplatform.social.core.identity.model.Identity findIdentity(String providerId,
                                                                        String remoteId)
                                                                 throws org.exoplatform.social.core.storage.IdentityStorageException

Gets the identity by remote id.

Specified by:

findIdentity in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

findIdentity in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

providerId - the identity provider

remoteId - the id

Returns:

the identity by remote id

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

saveProfile

public void saveProfile(org.exoplatform.social.core.identity.model.Profile profile)
                 throws org.exoplatform.social.core.storage.IdentityStorageException

Saves profile.

Specified by:

saveProfile in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

saveProfile in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

profile - the profile

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

updateProfile

public void updateProfile(org.exoplatform.social.core.identity.model.Profile profile)
                   throws org.exoplatform.social.core.storage.IdentityStorageException

Updates profile.

Specified by:

updateProfile in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

updateProfile in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

profile - the profile

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

Since:

1.2.0-GA

getIdentitiesCount

public int getIdentitiesCount(String providerId)
                       throws org.exoplatform.social.core.storage.IdentityStorageException

Gets total number of identities in storage depend on providerId.

Specified by:

getIdentitiesCount in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

getIdentitiesCount in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

getType

public String getType(String nodetype,
                      String property)

Gets the type.

Specified by:

getType in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

getType in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

nodetype - the nodetype

property - the property

Returns:

the type

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

addOrModifyProfileProperties

public void addOrModifyProfileProperties(org.exoplatform.social.core.identity.model.Profile profile)
                                  throws org.exoplatform.social.core.storage.IdentityStorageException

Add or modify properties of profile and persist to JCR. Profile parameter is a lightweight that contains only the property that you want to add or modify. NOTE: The method will not delete the properties on old profile when the param profile have not those keys.

Specified by:

addOrModifyProfileProperties in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

addOrModifyProfileProperties in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

profile - the profile

Throws:

org.exoplatform.social.core.storage.IdentityStorageException - if has any error

updateProfileActivityId

public void updateProfileActivityId(org.exoplatform.social.core.identity.model.Identity identity,
                                    String activityId,
                                    org.exoplatform.social.core.identity.model.Profile.AttachedActivityType type)

Updates profile activity id by type.

Specified by:

updateProfileActivityId in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

updateProfileActivityId in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

identity - the identity

activityId - the activity id

type - Type of activity id to get.

Since:

4.0.0.Alpha1

getProfileActivityId

public String getProfileActivityId(org.exoplatform.social.core.identity.model.Profile profile,
                                   org.exoplatform.social.core.identity.model.Profile.AttachedActivityType type)

Gets profile activity id by type.

Specified by:

getProfileActivityId in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

getProfileActivityId in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

profile - the Profile

type - Type of activity id to get.

Returns:

Profile activity id.

Since:

4.0.0.Alpha1

getActiveUsers

public Set<String> getActiveUsers(org.exoplatform.social.core.identity.model.ActiveIdentityFilter filter)

Gets the active user list base on the given ActiveIdentityFilter. 1. N days who last login less than N days. 2. UserGroup who belongs to this group.

Specified by:

getActiveUsers in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

getActiveUsers in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

filter - the filter

Returns:

set of identity ids

Since:

4.1.0

processEnabledIdentity

public void processEnabledIdentity(org.exoplatform.social.core.identity.model.Identity identity,
                                   boolean isEnable)

Process enable/disable Identity

Specified by:

processEnabledIdentity in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

processEnabledIdentity in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Parameters:

identity - The Identity enable

isEnable - true if the user is enable, false if not

Since:

4.2.x

getIdentitiesByFirstCharacterOfName

public List<org.exoplatform.social.core.identity.model.Identity> getIdentitiesByFirstCharacterOfName(String providerId,
                                                                                                     org.exoplatform.social.core.profile.ProfileFilter profileFilter,
                                                                                                     long offset,
                                                                                                     long limit,
                                                                                                     boolean forceLoadOrReloadProfile)
                                                                                              throws org.exoplatform.social.core.storage.IdentityStorageException

Specified by:

getIdentitiesByFirstCharacterOfName in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

getIdentitiesByFirstCharacterOfName in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Throws:

org.exoplatform.social.core.storage.IdentityStorageException

getIdentitiesForMentions

public List<org.exoplatform.social.core.identity.model.Identity> getIdentitiesForMentions(String providerId,
                                                                                          org.exoplatform.social.core.profile.ProfileFilter profileFilter,
                                                                                          long offset,
                                                                                          long limit,
                                                                                          boolean forceLoadOrReloadProfile)
                                                                                   throws org.exoplatform.social.core.storage.IdentityStorageException

Specified by:

getIdentitiesForMentions in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

getIdentitiesForMentions in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Throws:

org.exoplatform.social.core.storage.IdentityStorageException

getIdentitiesByProfileFilterCount

public int getIdentitiesByProfileFilterCount(String providerId,
                                             org.exoplatform.social.core.profile.ProfileFilter profileFilter)
                                      throws org.exoplatform.social.core.storage.IdentityStorageException

Specified by:

getIdentitiesByProfileFilterCount in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

getIdentitiesByProfileFilterCount in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Throws:

org.exoplatform.social.core.storage.IdentityStorageException

getIdentitiesByFirstCharacterOfNameCount

public int getIdentitiesByFirstCharacterOfNameCount(String providerId,
                                                    org.exoplatform.social.core.profile.ProfileFilter profileFilter)
                                             throws org.exoplatform.social.core.storage.IdentityStorageException

Specified by:

getIdentitiesByFirstCharacterOfNameCount in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

getIdentitiesByFirstCharacterOfNameCount in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Throws:

org.exoplatform.social.core.storage.IdentityStorageException

getIdentitiesForUnifiedSearch

public List<org.exoplatform.social.core.identity.model.Identity> getIdentitiesForUnifiedSearch(String providerId,
                                                                                               org.exoplatform.social.core.profile.ProfileFilter profileFilter,
                                                                                               long offset,
                                                                                               long limit)
                                                                                        throws org.exoplatform.social.core.storage.IdentityStorageException

Specified by:

getIdentitiesForUnifiedSearch in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

getIdentitiesForUnifiedSearch in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Throws:

org.exoplatform.social.core.storage.IdentityStorageException

getSpaceMemberIdentitiesByProfileFilter

public List<org.exoplatform.social.core.identity.model.Identity> getSpaceMemberIdentitiesByProfileFilter(org.exoplatform.social.core.space.model.Space space,
                                                                                                         org.exoplatform.social.core.profile.ProfileFilter profileFilter,
                                                                                                         org.exoplatform.social.core.identity.SpaceMemberFilterListAccess.Type type,
                                                                                                         long offset,
                                                                                                         long limit)
                                                                                                  throws org.exoplatform.social.core.storage.IdentityStorageException

Specified by:

getSpaceMemberIdentitiesByProfileFilter in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

getSpaceMemberIdentitiesByProfileFilter in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Throws:

org.exoplatform.social.core.storage.IdentityStorageException

getIdentitiesByProfileFilter

public List<org.exoplatform.social.core.identity.model.Identity> getIdentitiesByProfileFilter(String providerId,
                                                                                              org.exoplatform.social.core.profile.ProfileFilter profileFilter,
                                                                                              long offset,
                                                                                              long limit,
                                                                                              boolean forceLoadOrReloadProfile)
                                                                                       throws org.exoplatform.social.core.storage.IdentityStorageException

Specified by:

getIdentitiesByProfileFilter in interface org.exoplatform.social.core.storage.api.IdentityStorage

Overrides:

getIdentitiesByProfileFilter in class org.exoplatform.social.core.storage.impl.IdentityStorageImpl

Throws:

org.exoplatform.social.core.storage.IdentityStorageException

findByFilter

public org.exoplatform.commons.utils.ListAccess<org.exoplatform.social.core.identity.model.Identity> findByFilter(ExtendProfileFilter filter)

removeIdentity

public void removeIdentity(org.exoplatform.social.core.identity.model.Identity identity)

This method is introduced to clean totally identity from database It's used in unit test

Parameters:

identity - the Identity