Package org.exoplatform.social.rest.impl.identity

Class IdentityRestResourcesV1

java.lang.Object

org.exoplatform.social.rest.impl.identity.IdentityRestResourcesV1

All Implemented Interfaces:

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

public class IdentityRestResourcesV1
extends Object
implements IdentityRestResources

Constructor Summary

Constructors

Constructor	Description
IdentityRestResourcesV1(org.exoplatform.social.core.manager.IdentityManager identityManager, org.exoplatform.social.core.profileproperty.ProfilePropertyService profilePropertyService)

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	getCommonConnectionsWithIdentity(javax.ws.rs.core.UriInfo uriInfo, String id, int offset, int limit, boolean returnSize, String expand)
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	getIdentityAvatarById(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String id)
javax.ws.rs.core.Response	getIdentityBannerById(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String id)
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	getIdentityByProviderIdAndRemoteIdInQuery(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String providerId, String remoteId, String expand)
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

Methods inherited from class java.lang.Object

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

Constructor Details

IdentityRestResourcesV1

public IdentityRestResourcesV1(org.exoplatform.social.core.manager.IdentityManager identityManager,
 org.exoplatform.social.core.profileproperty.ProfilePropertyService profilePropertyService)

Method Details

getIdentities

@RolesAllowed("users")
public 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

Specified by:

getIdentities in interface IdentityRestResources

Returns:

Throws:

Exception

getIdentityById

@RolesAllowed("users")
public 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

Specified by:

getIdentityById in interface IdentityRestResources

Returns:

Throws:

Exception

getIdentityByProviderIdAndRemoteIdInQuery

@RolesAllowed("users")
public javax.ws.rs.core.Response getIdentityByProviderIdAndRemoteIdInQuery(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.Request request,
 String providerId,
 String remoteId,
 String expand)

getIdentityByProviderIdAndRemoteId

@RolesAllowed("users")
public 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)

Description copied from interface: IdentityRestResources

Return an identity identified by its providerId and remoteId

Specified by:

getIdentityByProviderIdAndRemoteId in interface IdentityRestResources

Returns:

Response containing IdentityEntity

getIdentityAvatarById

@RolesAllowed("users")
public javax.ws.rs.core.Response getIdentityAvatarById(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.Request request,
 String id)
                                                throws IOException

Parameters:

uriInfo -

id -

Returns:

Throws:

IOException

getIdentityBannerById

@RolesAllowed("users")
public javax.ws.rs.core.Response getIdentityBannerById(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 @Context
 javax.ws.rs.core.Request request,
 String id)
                                                throws IOException

Parameters:

uriInfo -

id -

Returns:

Throws:

IOException

getRelationshipsOfIdentity

@RolesAllowed("users")
public 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

Specified by:

getRelationshipsOfIdentity in interface IdentityRestResources

Returns:

Throws:

Exception

getCommonConnectionsWithIdentity

@RolesAllowed("users")
public javax.ws.rs.core.Response getCommonConnectionsWithIdentity(@Context
 javax.ws.rs.core.UriInfo uriInfo,
 String id,
 int offset,
 int limit,
 boolean returnSize,
 String expand)
                                                           throws Exception

Throws:

Exception