org.exoplatform.social.rest.impl.space

Class SpaceRestResourcesV1

java.lang.Object

org.exoplatform.social.rest.impl.space.SpaceRestResourcesV1

All Implemented Interfaces:

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

public class SpaceRestResourcesV1
extends Object
implements SpaceRestResources

Constructor Summary

Constructors

Constructor and Description
SpaceRestResourcesV1(org.exoplatform.social.core.manager.IdentityManager identityManager)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createSpace(javax.ws.rs.core.UriInfo uriInfo, String expand, SpaceEntity model) Process to create a new space
javax.ws.rs.core.Response	deleteSpaceById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand) Process to delete a space by id
javax.ws.rs.core.Response	getSpaceActivitiesById(javax.ws.rs.core.UriInfo uriInfo, String id, int offset, int limit, String before, String after, boolean returnSize, String expand) Process to return a space by id
javax.ws.rs.core.Response	getSpaceAvatarById(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String id)
javax.ws.rs.core.Response	getSpaceBannerById(javax.ws.rs.core.UriInfo uriInfo, javax.ws.rs.core.Request request, String id)
javax.ws.rs.core.Response	getSpaceById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand) Process to return a space by id
javax.ws.rs.core.Response	getSpaceMembers(javax.ws.rs.core.UriInfo uriInfo, String id, String role, int offset, int limit, boolean returnSize, String expand) Process to return a space by id
javax.ws.rs.core.Response	getSpaces(javax.ws.rs.core.UriInfo uriInfo, String q, int offset, int limit, boolean returnSize, String expand) Process to return a list of space in json format
javax.ws.rs.core.Response	postActivityOnSpace(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, ActivityRestIn model)
javax.ws.rs.core.Response	updateSpaceById(javax.ws.rs.core.UriInfo uriInfo, String id, String expand, SpaceEntity model) Process to update a space by id

Methods inherited from class java.lang.Object

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

Constructor Detail

SpaceRestResourcesV1

public SpaceRestResourcesV1(org.exoplatform.social.core.manager.IdentityManager identityManager)

Method Detail

getSpaces

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

Process to return a list of space in json format

Specified by:

getSpaces in interface SpaceRestResources

Returns:

Throws:

Exception

createSpace

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

Process to create a new space

Specified by:

createSpace in interface SpaceRestResources

Returns:

Throws:

Exception

getSpaceById

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

Process to return a space by id

Specified by:

getSpaceById in interface SpaceRestResources

Returns:

Throws:

Exception

getSpaceAvatarById

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

Parameters:

uriInfo -

id -

Returns:

Throws:

IOException

getSpaceBannerById

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

Parameters:

uriInfo -

id -

Returns:

Throws:

IOException

updateSpaceById

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

Process to update a space by id

Specified by:

updateSpaceById in interface SpaceRestResources

Returns:

Throws:

Exception

deleteSpaceById

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

Process to delete a space by id

Specified by:

deleteSpaceById in interface SpaceRestResources

Returns:

Throws:

Exception

getSpaceMembers

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

Process to return a space by id

Specified by:

getSpaceMembers in interface SpaceRestResources

Returns:

Throws:

Exception

getSpaceActivitiesById

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

Process to return a space by id

Specified by:

getSpaceActivitiesById in interface SpaceRestResources

Returns:

Throws:

Exception

postActivityOnSpace

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

Specified by:

postActivityOnSpace in interface SpaceRestResources

Throws:

Exception