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

Provides services to work with identities.

eXo anchor for generated doc on REST API

IdentityRestService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IdentityRestService.UserId UserId class to be exposed

Constructor Summary

Constructors

Constructor and Description
IdentityRestService() constructor

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getId(javax.ws.rs.core.UriInfo uriInfo, String username, String portalName) Gets an identity by a user's name and returns in the 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 javax.ws.rs.core.Response getId(@Context
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       String username,
                                       String portalName)
                                throws Exception

Gets an identity by a user's name and returns in the JSON format.

Parameters:

uriInfo - The requested URI information.

username - The name of the target user.

portalName - The name of the current portal.

Returns:

UserId The information of provided user.

Throws:

Exception

eXo level API

Platform

eXo anchor for generated doc on REST API

IdentityRestService.getId