org.exoplatform.social.service.rest.api
Class IdentityResources

java.lang.Object
  org.exoplatform.social.service.rest.api.IdentityResources

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class IdentityResources
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

Identity Resources end point.

Since:

1.2.2

Constructor Summary

IdentityResources()

Method Summary

javax.ws.rs.core.Response	getIdentityById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String identityId, String format) Gets the identity and its associated profile by the activity ID.
javax.ws.rs.core.Response	getIdentityProviderIdAndRemoteId(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String providerId, String remoteId, String format) Gets the identity and its associated profile by specifying its _providerId_ and _remoteId_.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityResources

public IdentityResources()

Method Detail

getIdentityById

public javax.ws.rs.core.Response getIdentityById(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 String portalContainerName,
                                                 String identityId,
                                                 String format)

Gets the identity and its associated profile by the activity ID.

Parameters:

uriInfo - The uri request uri.

portalContainerName - The associated portal container name.

identityId - The specified ID of identity.

format - The expected returned format.

Returns:

a response object

getIdentityProviderIdAndRemoteId

public javax.ws.rs.core.Response getIdentityProviderIdAndRemoteId(@Context
                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                  String portalContainerName,
                                                                  String providerId,
                                                                  String remoteId,
                                                                  String format)

Gets the identity and its associated profile by specifying its _providerId_ and _remoteId_. Every identity has its providerId and remoteId. There could be as many identities as possible. Currently, there are 2 built-in types of identities (user identities and space identities) in Social.

Parameters:

uriInfo - The uri request uri.

portalContainerName - The associated portal container name.

providerId - The providerId of Identity.

remoteId - The remoteId of Identity.

format - The expected returned format.

Returns:

a response object

Since:

1.2.2