Package org.exoplatform.social.rest.api

Interface IdentityRestResources

All Superinterfaces:

org.exoplatform.services.rest.resource.ResourceContainer, SocialRest

All Known Implementing Classes:

IdentityRestResourcesV1

public interface IdentityRestResources
extends SocialRest

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getIdentities(javax.ws.rs.core.UriInfo uriInfo, String type, int offset, int limit, boolean returnSize, String expand)	Process to return a list of identities in json format
javax.ws.rs.core.Response	getIdentityById(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String id, String expand)	Process to return an identity in json format
javax.ws.rs.core.Response	getIdentityByProviderIdAndRemoteId(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String providerId, String remoteId, String expand)	Return an identity identified by its providerId and remoteId
javax.ws.rs.core.Response	getRelationshipsOfIdentity(javax.ws.rs.core.UriInfo uriInfo, String id, String with, boolean returnSize, int offset, int limit, String expand)	Process to return all relationships of an identity in json format

Method Details

getIdentities

javax.ws.rs.core.Response getIdentities(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 String type,
 int offset,
 int limit,
 boolean returnSize,
 String expand)
                                 throws Exception

Process to return a list of identities in json format

Parameters:

uriInfo -

Returns:

Throws:

Exception

getIdentityById

javax.ws.rs.core.Response getIdentityById(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.Request request,
 String id,
 String expand)
                                   throws Exception

Process to return an identity in json format

Parameters:

uriInfo -

request -

id -

expand -

Returns:

Throws:

Exception

getIdentityByProviderIdAndRemoteId

javax.ws.rs.core.Response getIdentityByProviderIdAndRemoteId(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.Request request,
 String providerId,
 String remoteId,
 String expand)

Return an identity identified by its providerId and remoteId

Parameters:

uriInfo -

request -

providerId -

remoteId -

expand -

Returns:

Response containing IdentityEntity

getRelationshipsOfIdentity

javax.ws.rs.core.Response getRelationshipsOfIdentity(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 String id,
 String with,
 boolean returnSize,
 int offset,
 int limit,
 String expand)
                                              throws Exception

Process to return all relationships of an identity in json format

Parameters:

uriInfo -

Returns:

Throws:

Exception