org.dspace.rest

Class CommunitiesResource

java.lang.Object

org.dspace.rest.Resource

org.dspace.rest.CommunitiesResource

public class CommunitiesResource
extends Resource

Class which provides CRUD methods over communities.

Author:

Rostislav Novak (Computing and Information Centre, CTU in Prague)

Field Summary

Fields inherited from class org.dspace.rest.Resource

servletContext

Constructor Summary

Constructors

Constructor and Description
CommunitiesResource()

Method Summary

Methods

Modifier and Type	Method and Description
Collection	addCommunityCollection(Integer communityId, Collection collection, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Create collection in community.
Community	addCommunityCommunity(Integer communityId, Community community, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Create subcommunity in community.
Community	createCommunity(Community community, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Create community at top level.
javax.ws.rs.core.Response	deleteCommunity(Integer communityId, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Delete community from DSpace.
javax.ws.rs.core.Response	deleteCommunityCollection(Integer communityId, Integer collectionId, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Delete collection in community.
javax.ws.rs.core.Response	deleteCommunityCommunity(Integer parentCommunityId, Integer subcommunityId, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Delete subcommunity in community.
Community[]	getCommunities(String expand, Integer limit, Integer offset, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Return all communities in DSpace.
Community	getCommunity(Integer communityId, String expand, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Returns community with basic properties.
Collection[]	getCommunityCollections(Integer communityId, String expand, Integer limit, Integer offset, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Return all collections of community.
Community[]	getCommunityCommunities(Integer communityId, String expand, Integer limit, Integer offset, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Return all subcommunities of community.
Community[]	getTopCommunities(String expand, Integer limit, Integer offset, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Return all top communities in DSpace.
javax.ws.rs.core.Response	updateCommunity(Integer communityId, Community community, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Update community.

Methods inherited from class org.dspace.rest.Resource

createContext, getActionString, getServletContextPath, getToken, getUser, mySplit, processException, processFinally, writeStats

Methods inherited from class java.lang.Object

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

Constructor Detail

CommunitiesResource

public CommunitiesResource()

Method Detail

getCommunity

public Community getCommunity(Integer communityId,
                     String expand,
                     String user_ip,
                     String user_agent,
                     String xforwardedfor,
                     @Context
                     javax.ws.rs.core.HttpHeaders headers,
                     @Context
                     javax.servlet.http.HttpServletRequest request)
                       throws javax.ws.rs.WebApplicationException

Returns community with basic properties. If you want more, use expand parameter or method for community collections or subcommunities.

Parameters:

communityId - Id of community in DSpace.

expand - String in which is what you want to add to returned instance of community. Options are: "all", "parentCommunity", "collections", "subCommunities" and "logo". If you want to use multiple options, it must be separated by commas.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Return instance of org.dspace.rest.common.Community.

Throws:

javax.ws.rs.WebApplicationException - It is throw when was problem with creating context or problem with database reading. Also if id of community is incorrect or logged user into context has no permission to read.

getCommunities

public Community[] getCommunities(String expand,
                         Integer limit,
                         Integer offset,
                         String user_ip,
                         String user_agent,
                         String xforwardedfor,
                         @Context
                         javax.ws.rs.core.HttpHeaders headers,
                         @Context
                         javax.servlet.http.HttpServletRequest request)
                           throws javax.ws.rs.WebApplicationException

Return all communities in DSpace.

Parameters:

expand - String in which is what you want to add to returned instance of community. Options are: "all", "parentCommunity", "collections", "subCommunities" and "logo". If you want to use multiple options, it must be separated by commas.

limit - Maximum communities in array. Default value is 100.

offset - Index from which will start array of communities.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Return array of communities.

Throws:

javax.ws.rs.WebApplicationException - It can be caused by creating context or while was problem with reading community from database(SQLException).

getTopCommunities

public Community[] getTopCommunities(String expand,
                            Integer limit,
                            Integer offset,
                            String user_ip,
                            String user_agent,
                            String xforwardedfor,
                            @Context
                            javax.ws.rs.core.HttpHeaders headers,
                            @Context
                            javax.servlet.http.HttpServletRequest request)
                              throws javax.ws.rs.WebApplicationException

Return all top communities in DSpace. Top communities are communities on the root of tree.

Parameters:

expand - String in which is what you want to add to returned instance of community. Options are: "all", "parentCommunity", "collections", "subCommunities" and "logo". If you want to use multiple options, it must be separated by commas.

limit - Maximum communities in array. Default value is 100.

offset - Index from which will start array of communities. Default value is 0.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Return array of top communities.

Throws:

javax.ws.rs.WebApplicationException - It can be caused by creating context or while was problem with reading community from database(SQLException).

getCommunityCollections

public Collection[] getCommunityCollections(Integer communityId,
                                   String expand,
                                   Integer limit,
                                   Integer offset,
                                   String user_ip,
                                   String user_agent,
                                   String xforwardedfor,
                                   @Context
                                   javax.ws.rs.core.HttpHeaders headers,
                                   @Context
                                   javax.servlet.http.HttpServletRequest request)
                                     throws javax.ws.rs.WebApplicationException

Return all collections of community.

Parameters:

communityId - Id of community in DSpace.

expand - String in which is what you want to add to returned instance of collection. Options are: "all", "parentCommunityList", "parentCommunity", "items", "license" and "logo". If you want to use multiple options, it must be separated by commas.

limit - Maximum collection in array. Default value is 100.

offset - Index from which will start array of collections. Default value is 0.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Return array of collections of community.

Throws:

javax.ws.rs.WebApplicationException - It can be caused by creating context or while was problem with reading community from database(SQLException).

getCommunityCommunities

public Community[] getCommunityCommunities(Integer communityId,
                                  String expand,
                                  Integer limit,
                                  Integer offset,
                                  String user_ip,
                                  String user_agent,
                                  String xforwardedfor,
                                  @Context
                                  javax.ws.rs.core.HttpHeaders headers,
                                  @Context
                                  javax.servlet.http.HttpServletRequest request)
                                    throws javax.ws.rs.WebApplicationException

Return all subcommunities of community.

Parameters:

communityId - Id of community in DSpace.

expand - String in which is what you want to add to returned instance of community. Options are: "all", "parentCommunity", "collections", "subCommunities" and "logo". If you want to use multiple options, it must be separated by commas.

limit - Maximum communities in array. Default value is 20.

offset - Index from which will start array of communities. Default value is 0.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Return array of subcommunities of community.

Throws:

javax.ws.rs.WebApplicationException - It can be caused by creating context or while was problem with reading community from database(SQLException).

createCommunity

public Community createCommunity(Community community,
                        String user_ip,
                        String user_agent,
                        String xforwardedfor,
                        @Context
                        javax.ws.rs.core.HttpHeaders headers,
                        @Context
                        javax.servlet.http.HttpServletRequest request)
                          throws javax.ws.rs.WebApplicationException

Create community at top level. Creating community at top level has permission only admin.

Parameters:

community - Community which will be created at top level of communities.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Returns response with handle of community, if was all ok.

Throws:

javax.ws.rs.WebApplicationException - It can be thrown by SQLException, AuthorizeException and ContextException.

addCommunityCollection

public Collection addCommunityCollection(Integer communityId,
                                Collection collection,
                                String user_ip,
                                String user_agent,
                                String xforwardedfor,
                                @Context
                                javax.ws.rs.core.HttpHeaders headers,
                                @Context
                                javax.servlet.http.HttpServletRequest request)
                                  throws javax.ws.rs.WebApplicationException

Create collection in community.

Parameters:

communityId - Id of community in DSpace.

collection - Collection which will be added into community.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Return response 200 if was everything all right. Otherwise 400 when id of community was incorrect or 401 if was problem with permission to write into collection.

Throws:

javax.ws.rs.WebApplicationException - It is thrown when was problem with database reading or writing. Or problem with authorization to community. Or problem with creating context.

addCommunityCommunity

public Community addCommunityCommunity(Integer communityId,
                              Community community,
                              String user_ip,
                              String user_agent,
                              String xforwardedfor,
                              @Context
                              javax.ws.rs.core.HttpHeaders headers,
                              @Context
                              javax.servlet.http.HttpServletRequest request)
                                throws javax.ws.rs.WebApplicationException

Create subcommunity in community.

Parameters:

communityId - Id of community in DSpace, in which will be created subcommunity.

community - Community which will be added into community.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Return response 200 if was everything all right. Otherwise 400 when id of community was incorrect or 401 if was problem with permission to write into collection.

Throws:

javax.ws.rs.WebApplicationException - It is thrown when was problem with database reading or writing. Or problem with authorization to community. Or problem with creating context.

updateCommunity

public javax.ws.rs.core.Response updateCommunity(Integer communityId,
                                        Community community,
                                        String user_ip,
                                        String user_agent,
                                        String xforwardedfor,
                                        @Context
                                        javax.ws.rs.core.HttpHeaders headers,
                                        @Context
                                        javax.servlet.http.HttpServletRequest request)
                                          throws javax.ws.rs.WebApplicationException

Update community. Replace all information about community except: id, handle and expandle items.

Parameters:

communityId - Id of community in DSpace.

community - Instance of community which will replace actual community in DSpace.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Response 200 if was all ok. Otherwise 400 if was id incorrect or 401 if logged user has no permission to delete community.

Throws:

javax.ws.rs.WebApplicationException - It is throw when was problem with creating context or problem with database reading or writing. Or problem with writing to community caused by authorization.

deleteCommunity

public javax.ws.rs.core.Response deleteCommunity(Integer communityId,
                                        String user_ip,
                                        String user_agent,
                                        String xforwardedfor,
                                        @Context
                                        javax.ws.rs.core.HttpHeaders headers,
                                        @Context
                                        javax.servlet.http.HttpServletRequest request)
                                          throws javax.ws.rs.WebApplicationException

Delete community from DSpace. It delete it everything with community!

Parameters:

communityId - Id of community in DSpace.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Return response code OK(200) if was everything all right. Otherwise return NOT_FOUND(404) if was id of community incorrect. Or (UNAUTHORIZED)401 if was problem with permission to community.

Throws:

javax.ws.rs.WebApplicationException - It is throw when was problem with creating context or problem with database reading or deleting. Or problem with deleting community caused by IOException or authorization.

deleteCommunityCollection

public javax.ws.rs.core.Response deleteCommunityCollection(Integer communityId,
                                                  Integer collectionId,
                                                  String user_ip,
                                                  String user_agent,
                                                  String xforwardedfor,
                                                  @Context
                                                  javax.ws.rs.core.HttpHeaders headers,
                                                  @Context
                                                  javax.servlet.http.HttpServletRequest request)
                                                    throws javax.ws.rs.WebApplicationException

Delete collection in community.

Parameters:

communityId - Id of community in DSpace.

collectionId - Id of collection which will be deleted.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Return response code OK(200) if was everything all right. Otherwise return NOT_FOUND(404) if was id of community or collection incorrect. Or (UNAUTHORIZED)401 if was problem with permission to community or collection.

Throws:

javax.ws.rs.WebApplicationException - It is throw when was problem with creating context or problem with database reading or deleting. Or problem with deleting collection caused by IOException or authorization.

deleteCommunityCommunity

public javax.ws.rs.core.Response deleteCommunityCommunity(Integer parentCommunityId,
                                                 Integer subcommunityId,
                                                 String user_ip,
                                                 String user_agent,
                                                 String xforwardedfor,
                                                 @Context
                                                 javax.ws.rs.core.HttpHeaders headers,
                                                 @Context
                                                 javax.servlet.http.HttpServletRequest request)
                                                   throws javax.ws.rs.WebApplicationException

Delete subcommunity in community.

Parameters:

parentCommunityId - Id of community in DSpace.

subcommunityId - Id of community which will be deleted.

headers - If you want to access to community under logged user into context. In headers must be set header "rest-dspace-token" with passed token from login method.

Returns:

Return response code OK(200) if was everything all right. Otherwise return NOT_FOUND(404) if was id of community or subcommunity incorrect. Or (UNAUTHORIZED)401 if was problem with permission to community or subcommunity.

Throws:

javax.ws.rs.WebApplicationException - It is throw when was problem with creating context or problem with database reading or deleting. Or problem with deleting subcommunity caused by IOException or authorization.