org.exoplatform.social.core.manager

Interface IdentityManager

public interface IdentityManager

Provides APIs to manage identities. APIs provide capability of getting, creating or updating identities and profile information.

One identity is got by Id and allows the profile to be loaded or not. With a list of identities, the type of returned result is ListAccess which is used for lazy loading. Also, the API which adds or removes the provider information is provided.

Method Summary

Modifier and Type	Method and Description
void	addIdentityProvider(org.exoplatform.social.core.identity.IdentityProvider<?> identityProvider) Adds an identity provider to an identity manager.
void	addOrModifyProfileProperties(org.exoplatform.social.core.identity.model.Profile profile) Deprecated. Will be removed by 4.0.x.
void	addProfileListener(org.exoplatform.social.core.profile.ProfileListenerPlugin plugin) Deprecated. Use registerProfileListener(org.exoplatform.social.core.profile.ProfileListenerPlugin) instead. Will be removed by 4.0.x.
void	deleteIdentity(org.exoplatform.social.core.identity.model.Identity identity) Deletes an identity.
InputStream	getAvatarInputStream(org.exoplatform.social.core.identity.model.Identity identity) Gets a profile avatar associated with a provided identity
InputStream	getBannerInputStream(org.exoplatform.social.core.identity.model.Identity identity) Gets a profile banner associated with a provided identity
List<org.exoplatform.social.core.identity.model.Identity>	getConnections(org.exoplatform.social.core.identity.model.Identity ownerIdentity) Deprecated. Use getConnectionsWithListAccess(org.exoplatform.social.core.identity.model.Identity) instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.identity.model.Identity>	getConnectionsWithListAccess(org.exoplatform.social.core.identity.model.Identity identity) Gets a list access which contains all identities connected to the provided identity.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentities(String providerId) Deprecated. Use getIdentities(String, boolean) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentities(String providerId, boolean loadProfile) Deprecated. Use getIdentities(String, boolean) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesByProfileFilter(org.exoplatform.social.core.profile.ProfileFilter profileFilter) Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesByProfileFilter(org.exoplatform.social.core.profile.ProfileFilter profileFilter, long offset, long limit) Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesByProfileFilter(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter) Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesByProfileFilter(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter, boolean isProfileLoaded) Gets a list access which contains all identities from a given provider.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesByProfileFilter(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter, long offset, long limit) Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.
long	getIdentitiesCount(String providerId) Deprecated. Will be removed by 4.0.x.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesFilterByAlphaBet(org.exoplatform.social.core.profile.ProfileFilter profileFilter) Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesFilterByAlphaBet(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter) Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.
List<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesFilterByAlphaBet(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter, long offset, long limit) Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.
ListAccess<org.exoplatform.social.core.identity.model.Identity>	getIdentitiesForUnifiedSearch(String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter) Gets a list access which contains identities matching with the Unified Search condition.
org.exoplatform.social.core.identity.model.Identity	getIdentity(String id) Deprecated. Use getIdentity(String, boolean) instead. Will be removed by 4.0.x.
org.exoplatform.social.core.identity.model.Identity	getIdentity(String identityId, boolean isProfileLoaded) Gets an identity by a given Id.
org.exoplatform.social.core.identity.model.Identity	getIdentity(String providerId, String remoteId, boolean loadProfile) Deprecated. Use getOrCreateIdentity(String, String, boolean) instead. Will be removed by 4.0.x.
org.exoplatform.social.core.storage.api.IdentityStorage	getIdentityStorage() Deprecated. Will be removed by 4.0.x.
List<org.exoplatform.social.core.identity.model.Identity>	getLastIdentities(int limit) Gets the last identities that have been created.
org.exoplatform.social.core.identity.model.Identity	getOrCreateIdentity(String providerId, String remoteId) Deprecated. Use getOrCreateIdentity(String, String, boolean) instead. Will be moved by 1.3.x.
org.exoplatform.social.core.identity.model.Identity	getOrCreateIdentity(String providerId, String remoteId, boolean isProfileLoaded) Gets or creates an identity provided by an identity provider and an identity Id.
org.exoplatform.social.core.identity.model.Profile	getProfile(org.exoplatform.social.core.identity.model.Identity identity) Gets a profile associated with a provided identity.
ListAccess<org.exoplatform.social.core.identity.model.Identity>	getSpaceIdentityByProfileFilter(org.exoplatform.social.core.space.model.Space space, org.exoplatform.social.core.profile.ProfileFilter profileFilter, org.exoplatform.social.core.identity.SpaceMemberFilterListAccess.Type type, boolean isProfileLoaded) Gets space identities by filter information.
org.exoplatform.social.core.storage.api.IdentityStorage	getStorage() Deprecated. Will be removed by 4.0.x.
void	hardDeleteIdentity(org.exoplatform.social.core.identity.model.Identity identity) Cleans all data related to a specific identity.
boolean	identityExisted(String providerId, String remoteId) Deprecated. Will be removed by 4.0.x.
void	processEnabledIdentity(String remoteId, boolean isEnable) Process status of Identity when enable/disable user.
void	registerIdentityProviders(org.exoplatform.social.core.identity.IdentityProviderPlugin plugin) Registers one or more identity providers through IdentityProviderPlugin.
void	registerProfileListener(org.exoplatform.social.core.profile.ProfileListener listener) Deprecated. Will be removed by 4.0.x.
void	registerProfileListener(org.exoplatform.social.core.profile.ProfileListenerPlugin profileListenerPlugin) Registers a profile listener plugin by an external component plugin mechanism.
void	removeIdentityProvider(org.exoplatform.social.core.identity.IdentityProvider<?> identityProvider) Removes a specific identity provider.
void	saveIdentity(org.exoplatform.social.core.identity.model.Identity identity) Deprecated. Use getOrCreateIdentity(String, String, boolean) instead. Will be removed by 4.0.x.
void	saveProfile(org.exoplatform.social.core.identity.model.Profile profile) Deprecated. Use updateProfile(org.exoplatform.social.core.identity.model.Profile) instead. Will be removed by 4.0.x.
List<String>	sortIdentities(List<String> identityRemoteIds, String sortField) Sorts a list of user identities using a field
void	unregisterProfileListener(org.exoplatform.social.core.profile.ProfileListener listener) Deprecated. Will be removed by 4.0.x.
void	updateAvatar(org.exoplatform.social.core.identity.model.Profile p) Deprecated. Will be removed by 4.0.x.
void	updateBasicInfo(org.exoplatform.social.core.identity.model.Profile p) Deprecated. Will be removed by 4.0.x.
void	updateContactSection(org.exoplatform.social.core.identity.model.Profile p) Deprecated. Will be removed by 4.0.x.
void	updateExperienceSection(org.exoplatform.social.core.identity.model.Profile p) Deprecated. Will be removed by 4.0.x.
void	updateHeaderSection(org.exoplatform.social.core.identity.model.Profile p) Deprecated. Will be removed by 4.0.x.
org.exoplatform.social.core.identity.model.Identity	updateIdentity(org.exoplatform.social.core.identity.model.Identity identity) Updates specific properties of an identity.
void	updateProfile(org.exoplatform.social.core.identity.model.Profile specificProfile) Updates a specific profile.

Method Detail

getLastIdentities

List<org.exoplatform.social.core.identity.model.Identity> getLastIdentities(int limit)

Gets the last identities that have been created.

Parameters:

limit - the limit of identities to provide.

Returns:

The last identities.

Since:

4.0.x

Level API:

Experimental

getOrCreateIdentity

org.exoplatform.social.core.identity.model.Identity getOrCreateIdentity(String providerId,
                                                                        String remoteId,
                                                                        boolean isProfileLoaded)

Gets or creates an identity provided by an identity provider and an identity Id.

Parameters:

providerId - Id of the identity provider.

remoteId - The user remote Id.

isProfileLoaded - Is profile loaded or not.

Returns:

The identity.

Level API:

Platform

getIdentity

org.exoplatform.social.core.identity.model.Identity getIdentity(String identityId,
                                                                boolean isProfileLoaded)

Gets an identity by a given Id. This Id is UUID stored by JCR.

Parameters:

identityId - Id of the identity.

isProfileLoaded - Is profile loaded or not.

Returns:

The identity.

Level API:

Platform

updateIdentity

org.exoplatform.social.core.identity.model.Identity updateIdentity(org.exoplatform.social.core.identity.model.Identity identity)

Updates specific properties of an identity.

Parameters:

identity - The identity.

Returns:

The updated identity.

Since:

1.2.0-GA

Level API:

Platform

deleteIdentity

void deleteIdentity(org.exoplatform.social.core.identity.model.Identity identity)

Deletes an identity.

Parameters:

identity - The identity to be deleted.

Level API:

Platform

hardDeleteIdentity

void hardDeleteIdentity(org.exoplatform.social.core.identity.model.Identity identity)

Cleans all data related to a specific identity.

Parameters:

identity - The identity whose all data is cleaned.

Level API:

Platform

getConnectionsWithListAccess

ListAccess<org.exoplatform.social.core.identity.model.Identity> getConnectionsWithListAccess(org.exoplatform.social.core.identity.model.Identity identity)

Gets a list access which contains all identities connected to the provided identity. The type of returned result is ListAccess which can be lazy loaded.

Parameters:

identity - The provided identity.

Returns:

The identities which have connected to the provided identity.

Since:

1.2.0-GA

Level API:

Platform

getProfile

org.exoplatform.social.core.identity.model.Profile getProfile(org.exoplatform.social.core.identity.model.Identity identity)

Gets a profile associated with a provided identity.

Parameters:

identity - The provided identity.

Returns:

The profile.

Since:

1.2.0-GA

Level API:

Platform

getAvatarInputStream

InputStream getAvatarInputStream(org.exoplatform.social.core.identity.model.Identity identity)
                          throws IOException

Gets a profile avatar associated with a provided identity

Parameters:

identity -

Returns:

Throws:

IOException

getBannerInputStream

InputStream getBannerInputStream(org.exoplatform.social.core.identity.model.Identity identity)
                          throws IOException

Gets a profile banner associated with a provided identity

Parameters:

identity -

Returns:

Throws:

IOException

updateProfile

void updateProfile(org.exoplatform.social.core.identity.model.Profile specificProfile)
            throws org.exoplatform.webui.exception.MessageException

Updates a specific profile.

Parameters:

specificProfile - The specific profile.

Throws:

org.exoplatform.webui.exception.MessageException

Since:

1.2.0-GA

Level API:

Platform

getIdentitiesByProfileFilter

ListAccess<org.exoplatform.social.core.identity.model.Identity> getIdentitiesByProfileFilter(String providerId,
                                                                                             org.exoplatform.social.core.profile.ProfileFilter profileFilter,
                                                                                             boolean isProfileLoaded)

Gets a list access which contains all identities from a given provider. These identities are filtered by the profile filter. The type of returned result is ListAccess which can be lazy loaded.

Parameters:

providerId - Id of the provider.

profileFilter - The filter.

isProfileLoaded - Is profile loaded or not.

Returns:

The identities.

Since:

1.2.0-GA

Level API:

Platform

getIdentitiesForUnifiedSearch

ListAccess<org.exoplatform.social.core.identity.model.Identity> getIdentitiesForUnifiedSearch(String providerId,
                                                                                              org.exoplatform.social.core.profile.ProfileFilter profileFilter)

Gets a list access which contains identities matching with the Unified Search condition.

Parameters:

providerId - Id of the provider.

profileFilter - The filter.

Returns:

The identities.

Since:

4.0.x

getSpaceIdentityByProfileFilter

ListAccess<org.exoplatform.social.core.identity.model.Identity> getSpaceIdentityByProfileFilter(org.exoplatform.social.core.space.model.Space space,
                                                                                                org.exoplatform.social.core.profile.ProfileFilter profileFilter,
                                                                                                org.exoplatform.social.core.identity.SpaceMemberFilterListAccess.Type type,
                                                                                                boolean isProfileLoaded)

Gets space identities by filter information. The type of returned result is ListAccess which can be lazy loaded.

Parameters:

space - The space in which identities are got.

profileFilter - The filter information.

type - Type of identities to find.

isProfileLoaded - Is profile loaded or not.

Returns:

The space identities.

Level API:

Platform

addIdentityProvider

void addIdentityProvider(org.exoplatform.social.core.identity.IdentityProvider<?> identityProvider)

Adds an identity provider to an identity manager.

Parameters:

identityProvider - The identity provider.

Level API:

Platform

removeIdentityProvider

void removeIdentityProvider(org.exoplatform.social.core.identity.IdentityProvider<?> identityProvider)

Removes a specific identity provider.

Parameters:

identityProvider - The specific identity provider.

Since:

1.2.0-GA

Level API:

Platform

registerProfileListener

void registerProfileListener(org.exoplatform.social.core.profile.ProfileListenerPlugin profileListenerPlugin)

Registers a profile listener plugin by an external component plugin mechanism. For example:

  <external-component-plugins>
    <target-component>org.exoplatform.social.core.manager.IdentityManager</target-component>
    <component-plugin>
      <name>ProfileUpdatesPublisher</name>
      <set-method>registerProfileListener</set-method>
      <type>org.exoplatform.social.core.application.ProfileUpdatesPublisher</type>
    </component-plugin>
  </external-component-plugins>

Parameters:

profileListenerPlugin - The profile listener plugin.

Since:

1.2.0-GA

Level API:

Platform

registerIdentityProviders

void registerIdentityProviders(org.exoplatform.social.core.identity.IdentityProviderPlugin plugin)

Registers one or more identity providers through IdentityProviderPlugin.

Parameters:

plugin - The identity provider plugin.

Level API:

Platform

processEnabledIdentity

void processEnabledIdentity(String remoteId,
                            boolean isEnable)

Process status of Identity when enable/disable user.

Parameters:

remoteId - The user remote id

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

Since:

4.1.x

Level API:

Platform

getIdentity

org.exoplatform.social.core.identity.model.Identity getIdentity(String id)

Deprecated. Use getIdentity(String, boolean) instead. Will be removed by 4.0.x.

Gets an identity by Id and also loads his profile.

Parameters:

id - Id of a Social identity (such as GlobalId) or a raw identity (such as Identity.getId()).

Returns:

Null if nothing is found, or the Identity object.

See Also:

getIdentity(String, boolean)

Level API:

Provisional

getOrCreateIdentity

org.exoplatform.social.core.identity.model.Identity getOrCreateIdentity(String providerId,
                                                                        String remoteId)

Deprecated. Use getOrCreateIdentity(String, String, boolean) instead. Will be moved by 1.3.x.

Gets an identity by a remote Id.

Parameters:

providerId - Id of the provider.

remoteId - The remote Id.

Returns:

The identity.

Level API:

Provisional

getIdentitiesByProfileFilter

List<org.exoplatform.social.core.identity.model.Identity> getIdentitiesByProfileFilter(String providerId,
                                                                                       org.exoplatform.social.core.profile.ProfileFilter profileFilter)
                                                                                throws Exception

Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.

Gets identities by a profile filter.

Parameters:

providerId - Id of the provider.

profileFilter - The profile filter.

Returns:

The identities.

Throws:

Exception - the exception

Level API:

Provisional

getIdentitiesByProfileFilter

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

Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.

Gets identities by a profile filter.

Parameters:

providerId - Id of the provider.

profileFilter - The profile filter.

offset - The starting point from which the identities are got.

limit - The limitation of identities.

Returns:

The identities.

Throws:

Exception

Level API:

Provisional

getIdentitiesByProfileFilter

List<org.exoplatform.social.core.identity.model.Identity> getIdentitiesByProfileFilter(org.exoplatform.social.core.profile.ProfileFilter profileFilter)
                                                                                throws Exception

Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.

Gets identities by the profile filter.

Parameters:

profileFilter - The profile filter.

Returns:

The identities.

Throws:

Exception - the exception

Level API:

Provisional

getIdentitiesByProfileFilter

List<org.exoplatform.social.core.identity.model.Identity> getIdentitiesByProfileFilter(org.exoplatform.social.core.profile.ProfileFilter profileFilter,
                                                                                       long offset,
                                                                                       long limit)
                                                                                throws Exception

Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.

Gets identities by the profile filter.

Parameters:

profileFilter - The profile filter.

offset - The starting point from which the identities are got.

limit - The limitation of identities.

Returns:

The identities by the profile filter.

Throws:

Exception

Level API:

Provisional

getIdentitiesFilterByAlphaBet

List<org.exoplatform.social.core.identity.model.Identity> getIdentitiesFilterByAlphaBet(String providerId,
                                                                                        org.exoplatform.social.core.profile.ProfileFilter profileFilter)
                                                                                 throws Exception

Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.

Gets identities by the alphabetical filter.

Parameters:

providerId - Id of the provider.

profileFilter - The profile filter.

Returns:

The identities.

Throws:

Exception - the exception

Level API:

Provisional

getIdentitiesFilterByAlphaBet

List<org.exoplatform.social.core.identity.model.Identity> getIdentitiesFilterByAlphaBet(String providerId,
                                                                                        org.exoplatform.social.core.profile.ProfileFilter profileFilter,
                                                                                        long offset,
                                                                                        long limit)
                                                                                 throws Exception

Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.

Gets identities by the alphabetical filter with offset and limit points.

Parameters:

providerId - Id of the provider.

profileFilter - The profile filter.

offset - The starting point from which identities are got.

limit - The limitation of identities.

Returns:

The identities.

Throws:

Exception

Level API:

Provisional

getIdentitiesFilterByAlphaBet

List<org.exoplatform.social.core.identity.model.Identity> getIdentitiesFilterByAlphaBet(org.exoplatform.social.core.profile.ProfileFilter profileFilter)
                                                                                 throws Exception

Deprecated. Use getIdentitiesByProfileFilter(String, org.exoplatform.social.core.profile.ProfileFilter, boolean) instead. Will be removed by 4.0.x.

Gets identities by the alphabetical filter.

Parameters:

profileFilter - The profile filter.

Returns:

The identities.

Throws:

Exception - the exception

Level API:

Provisional

getIdentity

org.exoplatform.social.core.identity.model.Identity getIdentity(String providerId,
                                                                String remoteId,
                                                                boolean loadProfile)

Deprecated. Use getOrCreateIdentity(String, String, boolean) instead. Will be removed by 4.0.x.

Gets an identity from the provider, not in JCR. To make sure to get information from JCR, use getOrCreateIdentity(String, String, boolean).

Parameters:

providerId - Id of the provider.

remoteId - The remote Id.

loadProfile - Load the identity profile or not.

Returns:

The identity.

Level API:

Provisional

getIdentitiesCount

long getIdentitiesCount(String providerId)

Deprecated. Will be removed by 4.0.x.

Gets a count of identities.

Returns:

The count of identities.

Level API:

Provisional

identityExisted

boolean identityExisted(String providerId,
                        String remoteId)

Deprecated. Will be removed by 4.0.x.

Checks if an identity has already existed or not.

Parameters:

providerId - Id of the provider.

remoteId - The remote Id.

Returns:

"True" if the checked identity has already existed. Otherwise, it returns "false".

Level API:

Provisional

saveIdentity

void saveIdentity(org.exoplatform.social.core.identity.model.Identity identity)

Deprecated. Use getOrCreateIdentity(String, String, boolean) instead. Will be removed by 4.0.x.

Saves an identity.

Parameters:

identity - The identity to be saved.

Level API:

Provisional

saveProfile

void saveProfile(org.exoplatform.social.core.identity.model.Profile profile)

Deprecated. Use updateProfile(org.exoplatform.social.core.identity.model.Profile) instead. Will be removed by 4.0.x.

Saves a profile.

Parameters:

profile - The profile to be saved.

Level API:

Provisional

addOrModifyProfileProperties

void addOrModifyProfileProperties(org.exoplatform.social.core.identity.model.Profile profile)
                           throws Exception

Deprecated. Will be removed by 4.0.x.

Adds or modifies properties of a profile. The profile parameter is lightweight that contains only the property you want to add or modify. NOTE: The method will not delete properties from the old profile when the param profile has not those keys.

Parameters:

profile - The identity profile containing information which is added or modified.

Throws:

Exception

Level API:

Provisional

updateAvatar

void updateAvatar(org.exoplatform.social.core.identity.model.Profile p)
           throws org.exoplatform.webui.exception.MessageException

Deprecated. Will be removed by 4.0.x.

Updates an avatar.

Parameters:

p - The profile containing its avatar which is updated.

Throws:

org.exoplatform.webui.exception.MessageException

Level API:

Provisional

updateBasicInfo

void updateBasicInfo(org.exoplatform.social.core.identity.model.Profile p)
              throws Exception

Deprecated. Will be removed by 4.0.x.

Updates the basic information.

Parameters:

p - The profile containing its basic information which is updated.

Throws:

Exception

Level API:

Provisional

updateContactSection

void updateContactSection(org.exoplatform.social.core.identity.model.Profile p)
                   throws Exception

Deprecated. Will be removed by 4.0.x.

Updates the contact section of a profile.

Parameters:

p - The profile containing its contact section which is updated.

Throws:

Exception

Level API:

Provisional

updateExperienceSection

void updateExperienceSection(org.exoplatform.social.core.identity.model.Profile p)
                      throws Exception

Deprecated. Will be removed by 4.0.x.

Updates the experience section of a profile.

Parameters:

p - The profile containing the experience section which is updated.

Throws:

Exception

Level API:

Provisional

updateHeaderSection

void updateHeaderSection(org.exoplatform.social.core.identity.model.Profile p)
                  throws Exception

Deprecated. Will be removed by 4.0.x.

Updates the header section of profile.

Parameters:

p - The profile containing the header section which is updated.

Throws:

Exception

Level API:

Provisional

getIdentities

List<org.exoplatform.social.core.identity.model.Identity> getIdentities(String providerId)
                                                                 throws Exception

Deprecated. Use getIdentities(String, boolean) instead. Will be removed by 4.0.x.

Gets identities.

Parameters:

providerId - Id of the provider.

Returns:

The identities.

Throws:

Exception - the exception

Level API:

Provisional

getIdentities

List<org.exoplatform.social.core.identity.model.Identity> getIdentities(String providerId,
                                                                        boolean loadProfile)
                                                                 throws Exception

Deprecated. Use getIdentities(String, boolean) instead. Will be removed by 4.0.x.

Gets all identities from a provider Id.

Parameters:

providerId - Id of the provider.

loadProfile - The load profile.

Returns:

The identities.

Throws:

Exception

Level API:

Provisional

getConnections

List<org.exoplatform.social.core.identity.model.Identity> getConnections(org.exoplatform.social.core.identity.model.Identity ownerIdentity)
                                                                  throws Exception

Deprecated. Use getConnectionsWithListAccess(org.exoplatform.social.core.identity.model.Identity) instead. Will be removed by 4.0.x.

Gets connections of an identity.

Parameters:

ownerIdentity - The identity.

Returns:

The list of identities.

Throws:

Exception

Since:

1.1.1

Level API:

Provisional

getIdentityStorage

org.exoplatform.social.core.storage.api.IdentityStorage getIdentityStorage()

Deprecated. Will be removed by 4.0.x.

Gets the identity storage.

Returns:

The identity storage.

Level API:

Provisional

getStorage

org.exoplatform.social.core.storage.api.IdentityStorage getStorage()

Deprecated. Will be removed by 4.0.x.

Gets the identity storage.

Returns:

The identity storage.

Level API:

Provisional

registerProfileListener

void registerProfileListener(org.exoplatform.social.core.profile.ProfileListener listener)

Deprecated. Will be removed by 4.0.x.

Registers a profile listener.

Parameters:

listener - The profile listener to be registered.

Level API:

Provisional

unregisterProfileListener

void unregisterProfileListener(org.exoplatform.social.core.profile.ProfileListener listener)

Deprecated. Will be removed by 4.0.x.

Unregisters a profile listener.

Parameters:

listener - The listener to be unregistered.

Level API:

Provisional

addProfileListener

void addProfileListener(org.exoplatform.social.core.profile.ProfileListenerPlugin plugin)

Deprecated. Use registerProfileListener(org.exoplatform.social.core.profile.ProfileListenerPlugin) instead. Will be removed by 4.0.x.

Registers a profile listener component plugin.

Parameters:

plugin - The plugin to be registered.

Level API:

Provisional

sortIdentities

List<String> sortIdentities(List<String> identityRemoteIds,
                            String sortField)

Sorts a list of user identities using a field

Parameters:

identityRemoteIds -

sortField -

Returns: