org.dspace.rest

Class CollectionsResource

java.lang.Object

org.dspace.rest.Resource

org.dspace.rest.CollectionsResource

@Path(value="/collections")
public class CollectionsResource
extends Resource

This class provides all CRUD operation over collections.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorizeService	authorizeService
protected CollectionService	collectionService
protected InstallItemService	installItemService
protected ItemService	itemService
protected WorkspaceItemService	workspaceItemService

Fields inherited from class org.dspace.rest.Resource

servletContext

Constructor Summary

Constructors

Constructor and Description
CollectionsResource()

Method Summary

Modifier and Type	Method and Description
Item	addCollectionItem(String collectionId, Item item, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Create item in collection.
javax.ws.rs.core.Response	deleteCollection(String collectionId, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Delete collection.
javax.ws.rs.core.Response	deleteCollectionItem(String collectionId, String itemId, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Delete item in collection.
Collection	findCollectionByName(String name, javax.ws.rs.core.HttpHeaders headers) Search for first collection with passed name.
Collection	getCollection(String collectionId, 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 instance of collection with passed id.
Item[]	getCollectionItems(String collectionId, 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 array of items in collection.
Collection[]	getCollections(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 array of all collections in DSpace.
javax.ws.rs.core.Response	updateCollection(String collectionId, Collection collection, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Update collection.

Methods inherited from class org.dspace.rest.Resource

createContext, getActionString, mySplit, processException, processFinally, writeStats

Methods inherited from class java.lang.Object

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

Field Detail

collectionService

protected CollectionService collectionService

itemService

protected ItemService itemService

authorizeService

protected AuthorizeService authorizeService

workspaceItemService

protected WorkspaceItemService workspaceItemService

installItemService

protected InstallItemService installItemService

Constructor Detail

CollectionsResource

public CollectionsResource()

Method Detail

getCollection

@GET
 @Path(value="/{collection_id}")
 @Produces(value={"application/json","application/xml"})
public Collection getCollection(@PathParam(value="collection_id")
                                                                                                                               String collectionId,
                                                                                                                               @QueryParam(value="expand")
                                                                                                                               String expand,
                                                                                                                               @QueryParam(value="limit") @DefaultValue(value="100")
                                                                                                                               Integer limit,
                                                                                                                               @QueryParam(value="offset") @DefaultValue(value="0")
                                                                                                                               Integer offset,
                                                                                                                               @QueryParam(value="userIP")
                                                                                                                               String user_ip,
                                                                                                                               @QueryParam(value="userAgent")
                                                                                                                               String user_agent,
                                                                                                                               @QueryParam(value="xforwardedfor")
                                                                                                                               String xforwardedfor,
                                                                                                                               @Context
                                                                                                                               javax.ws.rs.core.HttpHeaders headers,
                                                                                                                               @Context
                                                                                                                               javax.servlet.http.HttpServletRequest request)
                                                                                                                        throws javax.ws.rs.WebApplicationException

Return instance of collection with passed id. You can add more properties through expand parameter.

Parameters:

collectionId - Id of collection 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 - Limit value for items in list in collection. Default value is 100.

offset - Offset of start index in list of items of collection. Default value is 0.

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

Returns:

Return instance of collection. It can also return status code NOT_FOUND(404) if id of collection is incorrect or status code UNATHORIZED(401) if user has no permission to read collection.

Throws:

javax.ws.rs.WebApplicationException - It is thrown when was problem with database reading (SQLException) or problem with creating context(ContextException). It is thrown by NOT_FOUND and UNATHORIZED status codes, too.

getCollections

@GET
 @Produces(value={"application/json","application/xml"})
public Collection[] getCollections(@QueryParam(value="expand")
                                                                                                 String expand,
                                                                                                 @QueryParam(value="limit") @DefaultValue(value="100")
                                                                                                 Integer limit,
                                                                                                 @QueryParam(value="offset") @DefaultValue(value="0")
                                                                                                 Integer offset,
                                                                                                 @QueryParam(value="userIP")
                                                                                                 String user_ip,
                                                                                                 @QueryParam(value="userAgent")
                                                                                                 String user_agent,
                                                                                                 @QueryParam(value="xforwardedfor")
                                                                                                 String xforwardedfor,
                                                                                                 @Context
                                                                                                 javax.ws.rs.core.HttpHeaders headers,
                                                                                                 @Context
                                                                                                 javax.servlet.http.HttpServletRequest request)
                                                                                          throws javax.ws.rs.WebApplicationException

Return array of all collections in DSpace. You can add more properties through expand parameter.

Parameters:

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 - Limit value for items in list in collection. Default value is 100.

offset - Offset of start index in list of items of collection. Default value is 0.

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

Returns:

Return array of collection, on which has logged user permission to view.

Throws:

javax.ws.rs.WebApplicationException - It is thrown when was problem with database reading (SQLException) or problem with creating context(ContextException).

getCollectionItems

@GET
 @Path(value="/{collection_id}/items")
 @Produces(value={"application/json","application/xml"})
public Item[] getCollectionItems(@PathParam(value="collection_id")
                                                                                                                                      String collectionId,
                                                                                                                                      @QueryParam(value="expand")
                                                                                                                                      String expand,
                                                                                                                                      @QueryParam(value="limit") @DefaultValue(value="100")
                                                                                                                                      Integer limit,
                                                                                                                                      @QueryParam(value="offset") @DefaultValue(value="0")
                                                                                                                                      Integer offset,
                                                                                                                                      @QueryParam(value="userIP")
                                                                                                                                      String user_ip,
                                                                                                                                      @QueryParam(value="userAgent")
                                                                                                                                      String user_agent,
                                                                                                                                      @QueryParam(value="xforwardedfor")
                                                                                                                                      String xforwardedfor,
                                                                                                                                      @Context
                                                                                                                                      javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                      @Context
                                                                                                                                      javax.servlet.http.HttpServletRequest request)
                                                                                                                               throws javax.ws.rs.WebApplicationException

Return array of items in collection. You can add more properties to items with expand parameter.

Parameters:

collectionId - Id of collection in DSpace.

expand - String which define, what additional properties will be in returned item. Options are separeted by commas and are: "all", "metadata", "parentCollection", "parentCollectionList", "parentCommunityList" and "bitstreams".

limit - Limit value for items in array. Default value is 100.

offset - Offset of start index in array of items of collection. Default value is 0.

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

Returns:

Return array of items, on which has logged user permission to read. It can also return status code NOT_FOUND(404) if id of collection is incorrect or status code UNATHORIZED(401) if user has no permission to read collection.

Throws:

javax.ws.rs.WebApplicationException - It is thrown when was problem with database reading (SQLException) or problem with creating context(ContextException). It is thrown by NOT_FOUND and UNATHORIZED status codes, too.

addCollectionItem

@POST
 @Path(value="/{collection_id}/items")
 @Consumes(value={"application/json","application/xml"})
public Item addCollectionItem(@PathParam(value="collection_id")
                                                                                                                                    String collectionId,
                                                                                                                                    Item item,
                                                                                                                                    @QueryParam(value="userIP")
                                                                                                                                    String user_ip,
                                                                                                                                    @QueryParam(value="userAgent")
                                                                                                                                    String user_agent,
                                                                                                                                    @QueryParam(value="xforwardedfor")
                                                                                                                                    String xforwardedfor,
                                                                                                                                    @Context
                                                                                                                                    javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                    @Context
                                                                                                                                    javax.servlet.http.HttpServletRequest request)
                                                                                                                             throws javax.ws.rs.WebApplicationException

Create item in collection. Item can be without filled metadata.

Parameters:

collectionId - Id of collection in which will be item created.

item - Item filled only with metadata, other variables are ignored.

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

Returns:

Return status code with item. Return status (OK)200 if item was created. NOT_FOUND(404) if id of collection does not exists. UNAUTHORIZED(401) if user have not permission to write items in collection.

Throws:

javax.ws.rs.WebApplicationException - It is thrown when was problem with database reading or writing (SQLException) or problem with creating context(ContextException) or problem with authorization to collection or IOException or problem with index item into browse index. It is thrown by NOT_FOUND and UNATHORIZED status codes, too.

updateCollection

@PUT
 @Path(value="/{collection_id}")
 @Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response updateCollection(@PathParam(value="collection_id")
                                                                                                                                                 String collectionId,
                                                                                                                                                 Collection collection,
                                                                                                                                                 @QueryParam(value="userIP")
                                                                                                                                                 String user_ip,
                                                                                                                                                 @QueryParam(value="userAgent")
                                                                                                                                                 String user_agent,
                                                                                                                                                 @QueryParam(value="xforwardedfor")
                                                                                                                                                 String xforwardedfor,
                                                                                                                                                 @Context
                                                                                                                                                 javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                 @Context
                                                                                                                                                 javax.servlet.http.HttpServletRequest request)
                                                                                                                                          throws javax.ws.rs.WebApplicationException

Update collection. It replace all properties.

Parameters:

collectionId - Id of collection in DSpace.

collection - Collection which will replace properties of actual collection.

headers - If you want to access to collection 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 collection. Or problem with creating context.

deleteCollection

@DELETE
 @Path(value="/{collection_id}")
 @Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response deleteCollection(@PathParam(value="collection_id")
                                                                                                                                                    String collectionId,
                                                                                                                                                    @QueryParam(value="userIP")
                                                                                                                                                    String user_ip,
                                                                                                                                                    @QueryParam(value="userAgent")
                                                                                                                                                    String user_agent,
                                                                                                                                                    @QueryParam(value="xforwardedfor")
                                                                                                                                                    String xforwardedfor,
                                                                                                                                                    @Context
                                                                                                                                                    javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                    @Context
                                                                                                                                                    javax.servlet.http.HttpServletRequest request)
                                                                                                                                             throws javax.ws.rs.WebApplicationException

Delete collection.

Parameters:

collectionId - Id of collection which will be deleted.

headers - If you want to access to collection 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 writing. Or problem with deleting collection caused by IOException or authorization.

deleteCollectionItem

@DELETE
 @Path(value="/{collection_id}/items/{item_id}")
 @Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response deleteCollectionItem(@PathParam(value="collection_id")
                                                                                                                                                                        String collectionId,
                                                                                                                                                                        @PathParam(value="item_id")
                                                                                                                                                                        String itemId,
                                                                                                                                                                        @QueryParam(value="userIP")
                                                                                                                                                                        String user_ip,
                                                                                                                                                                        @QueryParam(value="userAgent")
                                                                                                                                                                        String user_agent,
                                                                                                                                                                        @QueryParam(value="xforwardedfor")
                                                                                                                                                                        String xforwardedfor,
                                                                                                                                                                        @Context
                                                                                                                                                                        javax.ws.rs.core.HttpHeaders headers,
                                                                                                                                                                        @Context
                                                                                                                                                                        javax.servlet.http.HttpServletRequest request)
                                                                                                                                                                 throws javax.ws.rs.WebApplicationException

Delete item in collection.

Parameters:

collectionId - Id of collection which will be deleted.

itemId - Id of item in colletion.

Returns:

It returns status code: OK(200). NOT_FOUND(404) if item or collection was not found, UNAUTHORIZED(401) if user is not allowed to delete item or permission to write into collection.

Throws:

javax.ws.rs.WebApplicationException - It can be thrown by: SQLException, when was problem with database reading or writting. AuthorizeException, when was problem with authorization to item or collection. IOException, when was problem with removing item. ContextException, when was problem with creating context of DSpace.

findCollectionByName

@POST
 @Path(value="/find-collection")
 @Consumes(value={"application/json","application/xml"})
 @Produces(value={"application/json","application/xml"})
public Collection findCollectionByName(String name,
                                                                                                                                                                                                @Context
                                                                                                                                                                                                javax.ws.rs.core.HttpHeaders headers)
                                                                                                                                                                                         throws javax.ws.rs.WebApplicationException

Search for first collection with passed name.

Parameters:

name - Name of collection.

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

Returns:

It returns null if collection was not found. Otherwise returns first founded collection.

Throws:

javax.ws.rs.WebApplicationException