Package org.exoplatform.social.core.jpa.storage.dao

Interface IdentityDAO

All Superinterfaces:

org.exoplatform.commons.api.persistence.GenericDAO<IdentityEntity,Long>

All Known Implementing Classes:

IdentityDAOImpl

public interface IdentityDAO
extends org.exoplatform.commons.api.persistence.GenericDAO<IdentityEntity,Long>

Method Summary

Modifier and Type	Method	Description
long	countIdentityByProvider(String providerId)
org.exoplatform.commons.utils.ListAccess<Map.Entry<IdentityEntity,ConnectionEntity>>	findAllIdentitiesWithConnections(long identityId, String sortField, String sortDirection)
IdentityEntity	findByProviderAndRemoteId(String providerId, String remoteId)
default Long	findIdByProviderAndRemoteId(String providerId, String remoteId)
org.exoplatform.commons.utils.ListAccess<IdentityEntity>	findIdentities(ExtendProfileFilter filter)
List<Long>	getAllIds(int offset, int limit)
List<Long>	getAllIdsByProvider(String providerId, int offset, int limit)
default List<String>	getAllIdsByProviderSorted(String providerId, String sortField, String sortDirection, boolean enabled, String userType, Boolean isConnected, String enrollmentStatus, long offset, long limit)	Deprecated, for removal: This API element is subject to removal in a future version. The old getAllIdsByProviderSorted method without remoteIds no longer exists, use getAllIdsByProviderSorted with the remoteIds parameter instead.
default List<String>	getAllIdsByProviderSorted(String providerId, String sortField, String sortDirection, boolean enabled, String userType, Boolean isConnected, String enrollmentStatus, List<String> remoteIds, long offset, long limit)
default List<String>	getAllIdsByProviderSorted(String providerId, String sortField, String sortDirection, boolean enabled, String userType, Boolean isConnected, String enrollmentStatus, List<String> remoteIds, List<String> groupIds, String membershipType, boolean includeInheritedMemberships, long offset, long limit)
default List<String>	getAllIdsByProviderSorted(String providerId, String sortField, String sortDirection, boolean enabled, String userType, Boolean isConnected, String enrollmentStatus, List<String> remoteIds, List<String> groupIds, String membershipType, long offset, long limit)
default int	getAllIdsCountByProvider(String providerId, String userType, Boolean isConnected, boolean enabled, String enrollmentStatus)	Deprecated, for removal: This API element is subject to removal in a future version. The old getAllIdsCountByProvider method without remoteIds no longer exists, use getAllIdsCountByProvider with the remoteIds parameter instead.
default int	getAllIdsCountByProvider(String providerId, String userType, Boolean isConnected, boolean enabled, String enrollmentStatus, List<String> remoteIds)
default int	getAllIdsCountByProvider(String providerId, String userType, Boolean isConnected, boolean enabled, String enrollmentStatus, List<String> remoteIds, List<String> groupIds, String membershipType)
default int	getAllIdsCountByProvider(String providerId, String userType, Boolean isConnected, boolean enabled, String enrollmentStatus, List<String> remoteIds, List<String> groupIds, String membershipType, boolean includeInheritedMemberships)
List<String>	getEnabledRemoteIdsAfter(String providerId, boolean internalsOnly, String afterRemoteId, int limit)
default List<Long>	getIdentityIdsByProviderSorted(String providerId, String sortField, String sortDirection, boolean isEnabled, String userType, Boolean isConnected, String enrollmentStatus, long offset, long limit)	Deprecated, for removal: This API element is subject to removal in a future version. The old getIdentityIdsByProviderSorted method without remoteIds no longer exists, use getIdentityIdsByProviderSorted with the remoteIds parameter instead.
default List<Long>	getIdentityIdsByProviderSorted(String providerId, String sortField, String sortDirection, boolean isEnabled, String userType, Boolean isConnected, String enrollmentStatus, List<String> remoteIds, long offset, long limit)
default List<Long>	getIdentityIdsByProviderSorted(String providerId, String sortField, String sortDirection, boolean isEnabled, String userType, Boolean isConnected, String enrollmentStatus, List<String> remoteIds, List<String> groupIds, String membershipType, boolean includeInheritedMemberships, long offset, long limit)
default List<Long>	getIdentityIdsByProviderSorted(String providerId, String sortField, String sortDirection, boolean isEnabled, String userType, Boolean isConnected, String enrollmentStatus, List<String> remoteIds, List<String> groupIds, String membershipType, long offset, long limit)
List<Long>	getIdsByProviderAfterId(String providerId, long lastId, int limit)
void	hardDeleteIdentity(long identityId)	delete definitely an identity
void	setAsDeleted(long identityId)	set the DELETED flag to true

Methods inherited from interface org.exoplatform.commons.api.persistence.GenericDAO

count, create, createAll, delete, deleteAll, deleteAll, find, findAll, update, updateAll

Method Details

findByProviderAndRemoteId

IdentityEntity findByProviderAndRemoteId(String providerId,
 String remoteId)

countIdentityByProvider

long countIdentityByProvider(String providerId)

findIdentities

org.exoplatform.commons.utils.ListAccess<IdentityEntity> findIdentities(ExtendProfileFilter filter)

getAllIds

List<Long> getAllIds(int offset,
 int limit)

getAllIdsByProvider

List<Long> getAllIdsByProvider(String providerId,
 int offset,
 int limit)

getIdsByProviderAfterId

List<Long> getIdsByProviderAfterId(String providerId,
 long lastId,
 int limit)

Returns:

the non-deleted identity ids of a provider strictly greater than lastId, disabled ones included, in ascending id order — keyset iteration that never skips a row even when identities are soft-deleted while iterating

getEnabledRemoteIdsAfter

List<String> getEnabledRemoteIdsAfter(String providerId,
 boolean internalsOnly,
 String afterRemoteId,
 int limit)

Parameters:

providerId - the identity provider

internalsOnly - whether the identities marked external are left out

afterRemoteId - the remote id after which the list starts, excluded, or null to start from the first one

limit - the maximum number of remote ids returned, 0 for all

Returns:

the remote ids of the enabled, non-deleted identities of a provider, in ascending remote id order — keyset iteration over the provider's unique remote ids

findAllIdentitiesWithConnections

org.exoplatform.commons.utils.ListAccess<Map.Entry<IdentityEntity,ConnectionEntity>> findAllIdentitiesWithConnections(long identityId,
 String sortField,
 String sortDirection)

setAsDeleted

void setAsDeleted(long identityId)

set the DELETED flag to true

Parameters:

identityId - the identity Id

hardDeleteIdentity

void hardDeleteIdentity(long identityId)

delete definitely an identity

Parameters:

identityId - the identity Id

getAllIdsByProviderSorted

@Deprecated(forRemoval=true,
            since="7.2.0")
default List<String> getAllIdsByProviderSorted(String providerId,
 String sortField,
 String sortDirection,
 boolean enabled,
 String userType,
 Boolean isConnected,
 String enrollmentStatus,
 long offset,
 long limit)

Deprecated, for removal: This API element is subject to removal in a future version.

The old getAllIdsByProviderSorted method without remoteIds no longer exists, use getAllIdsByProviderSorted with the remoteIds parameter instead.

Get all identities by providerId sorted by sortField

Parameters:

providerId -

sortField -

sortDirection -

enabled -

userType -

isConnected -

enrollmentStatus -

offset -

limit -

Returns:

getAllIdsByProviderSorted

default List<String> getAllIdsByProviderSorted(String providerId,
 String sortField,
 String sortDirection,
 boolean enabled,
 String userType,
 Boolean isConnected,
 String enrollmentStatus,
 List<String> remoteIds,
 long offset,
 long limit)

getAllIdsByProviderSorted

default List<String> getAllIdsByProviderSorted(String providerId,
 String sortField,
 String sortDirection,
 boolean enabled,
 String userType,
 Boolean isConnected,
 String enrollmentStatus,
 List<String> remoteIds,
 List<String> groupIds,
 String membershipType,
 long offset,
 long limit)

getAllIdsByProviderSorted

default List<String> getAllIdsByProviderSorted(String providerId,
 String sortField,
 String sortDirection,
 boolean enabled,
 String userType,
 Boolean isConnected,
 String enrollmentStatus,
 List<String> remoteIds,
 List<String> groupIds,
 String membershipType,
 boolean includeInheritedMemberships,
 long offset,
 long limit)

getIdentityIdsByProviderSorted

@Deprecated(forRemoval=true,
            since="7.2.0")
default List<Long> getIdentityIdsByProviderSorted(String providerId,
 String sortField,
 String sortDirection,
 boolean isEnabled,
 String userType,
 Boolean isConnected,
 String enrollmentStatus,
 long offset,
 long limit)

Deprecated, for removal: This API element is subject to removal in a future version.

The old getIdentityIdsByProviderSorted method without remoteIds no longer exists, use getIdentityIdsByProviderSorted with the remoteIds parameter instead.

Get identity ids by providerId sorted by sortField

Parameters:

providerId -

sortField -

sortDirection -

isEnabled -

userType -

isConnected -

enrollmentStatus -

offset -

limit -

Returns:

getIdentityIdsByProviderSorted

default List<Long> getIdentityIdsByProviderSorted(String providerId,
 String sortField,
 String sortDirection,
 boolean isEnabled,
 String userType,
 Boolean isConnected,
 String enrollmentStatus,
 List<String> remoteIds,
 long offset,
 long limit)

getIdentityIdsByProviderSorted

default List<Long> getIdentityIdsByProviderSorted(String providerId,
 String sortField,
 String sortDirection,
 boolean isEnabled,
 String userType,
 Boolean isConnected,
 String enrollmentStatus,
 List<String> remoteIds,
 List<String> groupIds,
 String membershipType,
 long offset,
 long limit)

getIdentityIdsByProviderSorted

default List<Long> getIdentityIdsByProviderSorted(String providerId,
 String sortField,
 String sortDirection,
 boolean isEnabled,
 String userType,
 Boolean isConnected,
 String enrollmentStatus,
 List<String> remoteIds,
 List<String> groupIds,
 String membershipType,
 boolean includeInheritedMemberships,
 long offset,
 long limit)

getAllIdsCountByProvider

@Deprecated(forRemoval=true,
            since="7.2.0")
default int getAllIdsCountByProvider(String providerId,
 String userType,
 Boolean isConnected,
 boolean enabled,
 String enrollmentStatus)

Deprecated, for removal: This API element is subject to removal in a future version.

The old getAllIdsCountByProvider method without remoteIds no longer exists, use getAllIdsCountByProvider with the remoteIds parameter instead.

Count identities by providerId

Parameters:

providerId -

userType -

isConnected -

enabled -

Returns:

getAllIdsCountByProvider

default int getAllIdsCountByProvider(String providerId,
 String userType,
 Boolean isConnected,
 boolean enabled,
 String enrollmentStatus,
 List<String> remoteIds)

getAllIdsCountByProvider

default int getAllIdsCountByProvider(String providerId,
 String userType,
 Boolean isConnected,
 boolean enabled,
 String enrollmentStatus,
 List<String> remoteIds,
 List<String> groupIds,
 String membershipType)

getAllIdsCountByProvider

default int getAllIdsCountByProvider(String providerId,
 String userType,
 Boolean isConnected,
 boolean enabled,
 String enrollmentStatus,
 List<String> remoteIds,
 List<String> groupIds,
 String membershipType,
 boolean includeInheritedMemberships)

findIdByProviderAndRemoteId

default Long findIdByProviderAndRemoteId(String providerId,
 String remoteId)