org.exoplatform.social.rest.impl.user

Class UserRestResourcesV1

java.lang.Object

org.exoplatform.social.rest.impl.user.UserRestResourcesV1

All Implemented Interfaces:

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

public class UserRestResourcesV1
extends Object
implements UserRestResources

Provides REST Services for manipulating jobs related to users.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserRestResourcesV1.ACTIVITY_STREAM_TYPE

Constructor Summary

Constructors

Constructor and Description
UserRestResourcesV1(org.exoplatform.portal.config.UserACL userACL, org.exoplatform.social.core.manager.IdentityManager identityManager)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addActivityByUser(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, ActivityEntity model)
javax.ws.rs.core.Response	addUser(javax.ws.rs.core.UriInfo uriInfo, String expand, UserEntity model) Creates an user
javax.ws.rs.core.Response	deleteUserById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand)
javax.ws.rs.core.Response	getActivitiesOfUser(javax.ws.rs.core.UriInfo uriInfo, String id, String type, int offset, int limit, String before, String after, boolean returnSize, String expand)
javax.ws.rs.core.Response	getConnectionOfUser(javax.ws.rs.core.UriInfo uriInfo, String id, boolean returnSize, String expand)
javax.ws.rs.core.Response	getSpacesOfUser(javax.ws.rs.core.UriInfo uriInfo, String id, int offset, int limit, boolean returnSize, String expand)
javax.ws.rs.core.Response	getUserAvatarById(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String id, String defaultAvatar)
javax.ws.rs.core.Response	getUserBannerById(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String id, String defaultBanner)
static org.exoplatform.services.organization.User	getUserByEmail(String email) Checks if input email is existing already or not.
javax.ws.rs.core.Response	getUserById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand)
javax.ws.rs.core.Response	getUsers(javax.ws.rs.core.UriInfo uriInfo, String q, int offset, int limit, boolean returnSize, String expand) Get all users, filter by name if exists.
javax.ws.rs.core.Response	updateUserById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, UserEntity model)

Methods inherited from class java.lang.Object

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

Constructor Detail

UserRestResourcesV1

public UserRestResourcesV1(org.exoplatform.portal.config.UserACL userACL,
                           org.exoplatform.social.core.manager.IdentityManager identityManager)

Method Detail

getUsers

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

Description copied from interface: UserRestResources

Get all users, filter by name if exists.

Specified by:

getUsers in interface UserRestResources

q - value that an user's name match

Returns:

List of users in json format.

Throws:

Exception

addUser

@RolesAllowed(value="users")
public javax.ws.rs.core.Response addUser(@Context
                                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                                      String expand,
                                                                      UserEntity model)
                                                               throws Exception

Description copied from interface: UserRestResources

Creates an user

Specified by:

addUser in interface UserRestResources

Returns:

user created in json format

Throws:

Exception

getUserById

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getUserById(@Context
                                                                          javax.ws.rs.core.UriInfo uriInfo,
                                                                          String id,
                                                                          String expand)
                                                                   throws Exception

Specified by:

getUserById in interface UserRestResources

Throws:

Exception

getUserAvatarById

public javax.ws.rs.core.Response getUserAvatarById(@Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   @Context
                                                   javax.ws.rs.core.Request request,
                                                   String id,
                                                   String defaultAvatar)
                                            throws IOException

Parameters:

uriInfo -

id -

Returns:

Throws:

IOException

getUserBannerById

public javax.ws.rs.core.Response getUserBannerById(@Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   @Context
                                                   javax.ws.rs.core.Request request,
                                                   String id,
                                                   String defaultBanner)
                                            throws IOException

Parameters:

uriInfo -

id -

Returns:

Throws:

IOException

deleteUserById

@RolesAllowed(value="users")
public javax.ws.rs.core.Response deleteUserById(@Context
                                                                             javax.ws.rs.core.UriInfo uriInfo,
                                                                             String id,
                                                                             String expand)
                                                                      throws Exception

Specified by:

deleteUserById in interface UserRestResources

Throws:

Exception

updateUserById

@RolesAllowed(value="users")
public javax.ws.rs.core.Response updateUserById(@Context
                                                                             javax.ws.rs.core.UriInfo uriInfo,
                                                                             String id,
                                                                             String expand,
                                                                             UserEntity model)
                                                                      throws Exception

Specified by:

updateUserById in interface UserRestResources

Throws:

Exception

getConnectionOfUser

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getConnectionOfUser(@Context
                                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                                  String id,
                                                                                  boolean returnSize,
                                                                                  String expand)
                                                                           throws Exception

Specified by:

getConnectionOfUser in interface UserRestResources

Throws:

Exception

getSpacesOfUser

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

Specified by:

getSpacesOfUser in interface UserRestResources

Throws:

Exception

getActivitiesOfUser

@RolesAllowed(value="users")
public javax.ws.rs.core.Response getActivitiesOfUser(@Context
                                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                                  String id,
                                                                                  String type,
                                                                                  int offset,
                                                                                  int limit,
                                                                                  String before,
                                                                                  String after,
                                                                                  boolean returnSize,
                                                                                  String expand)
                                                                           throws Exception

Specified by:

getActivitiesOfUser in interface UserRestResources

Throws:

Exception

addActivityByUser

@RolesAllowed(value="users")
public javax.ws.rs.core.Response addActivityByUser(@Context
                                                                                javax.ws.rs.core.UriInfo uriInfo,
                                                                                String id,
                                                                                String expand,
                                                                                ActivityEntity model)
                                                                         throws Exception

Specified by:

addActivityByUser in interface UserRestResources

Throws:

Exception

getUserByEmail

public static org.exoplatform.services.organization.User getUserByEmail(String email)

Checks if input email is existing already or not.

Parameters:

email - Input email to check.

Returns:

true if email is existing in system.