@Path(value="/items") public class ItemsResource extends Resource
| Modifier and Type | Field and Description |
|---|---|
protected AuthorizeService |
authorizeService |
protected BitstreamFormatService |
bitstreamFormatService |
protected BitstreamService |
bitstreamService |
protected BundleService |
bundleService |
protected CollectionService |
collectionService |
protected GroupService |
groupService |
protected ItemService |
itemService |
protected ResourcePolicyService |
resourcePolicyService |
servletContext| Constructor and Description |
|---|
ItemsResource() |
| Modifier and Type | Method and Description |
|---|---|
Bitstream |
addItemBitstream(String itemId,
InputStream inputStream,
String name,
String description,
String groupId,
Integer year,
Integer month,
Integer day,
String user_ip,
String user_agent,
String xforwardedfor,
javax.ws.rs.core.HttpHeaders headers,
javax.servlet.http.HttpServletRequest request)
Create bitstream in item.
|
javax.ws.rs.core.Response |
addItemMetadata(String itemId,
List<MetadataEntry> metadata,
String user_ip,
String user_agent,
String xforwardedfor,
javax.ws.rs.core.HttpHeaders headers,
javax.servlet.http.HttpServletRequest request)
Adding metadata fields to item.
|
javax.ws.rs.core.Response |
deleteItem(String itemId,
String user_ip,
String user_agent,
String xforwardedfor,
javax.ws.rs.core.HttpHeaders headers,
javax.servlet.http.HttpServletRequest request)
Delete item from DSpace.
|
javax.ws.rs.core.Response |
deleteItemBitstream(String itemId,
String bitstreamId,
String user_ip,
String user_agent,
String xforwardedfor,
javax.ws.rs.core.HttpHeaders headers,
javax.servlet.http.HttpServletRequest request)
Delete bitstream from item bundle.
|
javax.ws.rs.core.Response |
deleteItemMetadata(String itemId,
String user_ip,
String user_agent,
String xforwardedfor,
javax.ws.rs.core.HttpHeaders headers,
javax.servlet.http.HttpServletRequest request)
Delete all item metadata.
|
Item[] |
findItemsByMetadataField(MetadataEntry metadataEntry,
String expand,
String user_ip,
String user_agent,
String xforwardedfor,
javax.ws.rs.core.HttpHeaders headers,
javax.servlet.http.HttpServletRequest request)
Find items by one metadata field.
|
Item |
getItem(String itemId,
String expand,
String user_ip,
String user_agent,
String xforwardedfor,
javax.ws.rs.core.HttpHeaders headers,
javax.servlet.http.HttpServletRequest request)
Return item properties without metadata and bitstreams.
|
Bitstream[] |
getItemBitstreams(String itemId,
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 bitstreams in item.
|
MetadataEntry[] |
getItemMetadata(String itemId,
String user_ip,
String user_agent,
String xforwardedfor,
javax.ws.rs.core.HttpHeaders headers,
javax.servlet.http.HttpServletRequest request)
Returns item metadata in list.
|
Item[] |
getItems(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)
It returns an array of items in DSpace.
|
javax.ws.rs.core.Response |
updateItemMetadata(String itemId,
MetadataEntry[] metadata,
String user_ip,
String user_agent,
String xforwardedfor,
javax.ws.rs.core.HttpHeaders headers,
javax.servlet.http.HttpServletRequest request)
Replace all metadata in item with new passed metadata.
|
createContext, getActionString, mySplit, processException, processFinally, writeStatsprotected CollectionService collectionService
protected ItemService itemService
protected AuthorizeService authorizeService
protected BitstreamService bitstreamService
protected BitstreamFormatService bitstreamFormatService
protected BundleService bundleService
protected ResourcePolicyService resourcePolicyService
protected GroupService groupService
@GET
@Path(value="/{item_id}")
@Produces(value={"application/json","application/xml"})
public Item getItem(@PathParam(value="item_id")
String itemId,
@QueryParam(value="expand")
String expand,
@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
itemId - Id of item 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".headers - If you want to access to item under logged user into context.
In headers must be set header "rest-dspace-token" with passed
token from login method.javax.ws.rs.WebApplicationException - This exception can be throw by NOT_FOUND(bad id of item),
UNAUTHORIZED, SQLException if wasproblem with reading from
database and ContextException, if there was problem with
creating context of DSpace.@GET
@Produces(value={"application/json","application/xml"})
public Item[] getItems(@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
limit - How many items in array will be. Default value is 100.offset - On which index will array start. Default value is 0.headers - If you want to access to item under logged user into context.
In headers must be set header "rest-dspace-token" with passed
token from login method.javax.ws.rs.WebApplicationException - It can be thrown by SQLException, when was problem with
reading items from database or ContextException, when was
problem with creating context of DSpace.@GET
@Path(value="/{item_id}/metadata")
@Produces(value={"application/json","application/xml"})
public MetadataEntry[] getItemMetadata(@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
itemId - Id of item in DSpace.headers - If you want to access to item under logged user into context.
In headers must be set header "rest-dspace-token" with passed
token from login method.javax.ws.rs.WebApplicationException - It can be thrown by two exceptions: SQLException if was
problem wtih reading item from database and ContextException,
if was problem with creating context of DSpace. And can be
thrown by NOT_FOUND and UNAUTHORIZED too.@GET
@Path(value="/{item_id}/bitstreams")
@Produces(value={"application/json","application/xml"})
public Bitstream[] getItemBitstreams(@PathParam(value="item_id")
String itemId,
@QueryParam(value="limit") @DefaultValue(value="20")
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
itemId - Id of item in DSpace.limit - How many items will be in array.offset - On which index will start array.headers - If you want to access to item under logged user into context.
In headers must be set header "rest-dspace-token" with passed
token from login method.javax.ws.rs.WebApplicationException - It can be throw by NOT_FOUND, UNAUTHORIZED, SQLException if
was problem with reading from database and ContextException
if was problem with creating context of DSpace.@POST
@Path(value="/{item_id}/metadata")
@Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response addItemMetadata(@PathParam(value="item_id")
String itemId,
List<MetadataEntry> metadata,
@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
itemId - Id of item in DSpace.metadata - List of metadata fields, which will be added into item.headers - If you want to access to item under logged user into context.
In headers must be set header "rest-dspace-token" with passed
token from login method.javax.ws.rs.WebApplicationException - It is throw by these exceptions: SQLException, if was problem
with reading from database or writing to database.
AuthorizeException, if was problem with authorization to item
fields. ContextException, if was problem with creating
context of DSpace.@POST
@Path(value="/{item_id}/bitstreams")
public Bitstream addItemBitstream(@PathParam(value="item_id")
String itemId,
InputStream inputStream,
@QueryParam(value="name")
String name,
@QueryParam(value="description")
String description,
@QueryParam(value="groupId")
String groupId,
@QueryParam(value="year")
Integer year,
@QueryParam(value="month")
Integer month,
@QueryParam(value="day")
Integer day,
@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
itemId - Id of item in DSpace.inputStream - Data of bitstream in inputStream.headers - If you want to access to item under logged user into context.
In headers must be set header "rest-dspace-token" with passed
token from login method.javax.ws.rs.WebApplicationException - It is thrown by these exceptions: SQLException, when was
problem with reading/writing from/to database.
AuthorizeException, when was problem with authorization to
item and add bitstream to item. IOException, when was problem
with creating file or reading from inpustream.
ContextException. When was problem with creating context of
DSpace.@PUT
@Path(value="/{item_id}/metadata")
@Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response updateItemMetadata(@PathParam(value="item_id")
String itemId,
MetadataEntry[] metadata,
@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
itemId - Id of item in DSpace.metadata - List of metadata fields, which will replace old metadata in
item.headers - If you want to access to item under logged user into context.
In headers must be set header "rest-dspace-token" with passed
token from login method.javax.ws.rs.WebApplicationException - It is thrown by: SQLException, when was problem with database
reading or writting, AuthorizeException when was problem with
authorization to item and metadata fields. And
ContextException, when was problem with creating context of
DSpace.@DELETE
@Path(value="/{item_id}")
public javax.ws.rs.core.Response deleteItem(@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
itemId - Id of item which will be deleted.headers - If you want to access to item under logged user into context.
In headers must be set header "rest-dspace-token" with passed
token from login method.javax.ws.rs.WebApplicationException - It can be thrown by: SQLException, when was problem with
database reading. AuthorizeException, when was problem with
authorization to item.(read and delete) IOException, when was
problem with deleting bitstream file. ContextException, when
was problem with creating context of DSpace.@DELETE
@Path(value="/{item_id}/metadata")
public javax.ws.rs.core.Response deleteItemMetadata(@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
itemId - Id of item in DSpace.headers - If you want to access to item under logged user into context.
In headers must be set header "rest-dspace-token" with passed
token from login method.javax.ws.rs.WebApplicationException - Thrown by three exceptions. SQLException, when there was
a problem reading item from database or editing metadata
fields. AuthorizeException, when there was a problem with
authorization to item. And ContextException, when there was a problem
with creating a DSpace context.@DELETE
@Path(value="/{item_id}/bitstreams/{bitstream_id}")
public javax.ws.rs.core.Response deleteItemBitstream(@PathParam(value="item_id")
String itemId,
@PathParam(value="bitstream_id")
String bitstreamId,
@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
itemId - Id of item in DSpace.headers - If you want to access to item under logged user into context.
In headers must be set header "rest-dspace-token" with passed
token from login method.bitstreamId - Id of bitstream, which will be deleted from bundle.javax.ws.rs.WebApplicationException - It is thrown, when: Was problem with edditting database,
SQLException. Or problem with authorization to item, bundle
or bitstream, AuthorizeException. When was problem with
deleting file IOException. Or problem with creating context
of DSpace, ContextException.@POST
@Path(value="/find-by-metadata-field")
@Produces(value={"application/json","application/xml"})
public Item[] findItemsByMetadataField(MetadataEntry metadataEntry,
@QueryParam(value="expand")
String expand,
@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
metadataEntry - Metadata field to search by.headers - If you want to access the item as the user logged into context,
header "rest-dspace-token" must be set to token value retrieved
from the login method.javax.ws.rs.WebApplicationException - Can be thrown: SQLException - problem with
database reading. AuthorizeException - problem with
authorization to item. IOException - problem with
reading from metadata field. ContextException -
problem with creating DSpace context.Copyright © 2016 DuraSpace. All rights reserved.