org.exoplatform.social.service.rest
Class IdentityRestService

java.lang.Object
  org.exoplatform.social.service.rest.IdentityRestService

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

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

The class IdentityRestService provides API to work with identity. Url template: {rest_context_name}/social/identity/{username}/id
GET: /{rest_context_name}/social/identity/{username}/id/show.{format}

Nested Class Summary

class

IdentityRestService.UserId UserId class to be exposed

Constructor Summary

IdentityRestService()
constructor

Method Summary

IdentityRestService.UserId

getId(javax.ws.rs.core.UriInfo uriInfo, String username, String portalName) Gets identity by user's name and return in json format.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityRestService

public IdentityRestService()

constructor

Method Detail

getId

public IdentityRestService.UserId getId(@Context
                                        javax.ws.rs.core.UriInfo uriInfo,
                                        String username,
                                        String portalName)
                                 throws Exception

Gets identity by user's name and return in json format.

Parameters:

uriInfo - The request URI information.

username - The name of target user.

Returns:

UserId The information of provided user.

Throws:

Exception