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

Provides API to access the identity resources.

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 provider Id and user/space Id.

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 requested URI information.

portalContainerName - The associated portal container name.

identityId - The Id of the specified identity.

format - The format of the returned result, for example, JSON or XML.

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 provider Id and user/space Id. There can be many identities, such as, user identities, and space identities.

Parameters:

uriInfo - The requested URI information.

portalContainerName - The associated portal container name.

providerId - The provider Id of the identity.

remoteId - The user/space Id.

format - The format of the returned result, for example, JSON or XML.

Returns:

a response object

Since:

1.2.2 *user identities*: _providerId_ = organization; _remoteId_ = portal user name. *space identities:* _providerId_ = space; _remoteId_ = space's pretty name.