org.dspace.rest

Class BitstreamResource

java.lang.Object

org.dspace.rest.Resource

org.dspace.rest.BitstreamResource

public class BitstreamResource
extends Resource

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
BitstreamResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addBitstreamPolicy(Integer bitstreamId, ResourcePolicy policy, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Add bitstream policy to all bundles containing the bitstream.
javax.ws.rs.core.Response	deleteBitstream(Integer bitstreamId, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Delete bitstream from all bundles in DSpace.
javax.ws.rs.core.Response	deleteBitstreamPolicy(Integer bitstreamId, Integer policyId, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Delete policy.
Bitstream	getBitstream(Integer bitstreamId, String expand, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Return bitstream properties without file data.
javax.ws.rs.core.Response	getBitstreamData(Integer bitstreamId, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Read bitstream data.
ResourcePolicy[]	getBitstreamPolicies(Integer bitstreamId, javax.ws.rs.core.HttpHeaders headers) Return all bitstream resource policies from all bundles, in which the bitstream is present.
Bitstream[]	getBitstreams(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) Read list of bitstreams.
javax.ws.rs.core.Response	updateBitstream(Integer bitstreamId, Bitstream bitstream, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Update bitstream metadata.
javax.ws.rs.core.Response	updateBitstreamData(Integer bitstreamId, InputStream is, String user_ip, String user_agent, String xforwardedfor, javax.ws.rs.core.HttpHeaders headers, javax.servlet.http.HttpServletRequest request) Update bitstream data.

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

BitstreamResource

public BitstreamResource()

Method Detail

getBitstream

public Bitstream getBitstream(Integer bitstreamId,
                     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

Return bitstream properties without file data. It can throw WebApplicationException with three response codes. Response code NOT_FOUND(404) or UNAUTHORIZED(401) or INTERNAL_SERVER_ERROR(500). Bad request is when the bitstream id does not exist. UNAUTHORIZED if the user logged into the DSpace context does not have the permission to access the bitstream. Server error when something went wrong.

Parameters:

bitstreamId - Id of bitstream in DSpace.

expand - This string defines which additional optional fields will be added to bitstream response. Individual options are separated by commas without spaces. The options are: "all", "parent".

headers - If you want to access the item as the user logged into the context. The header "rest-dspace-token" with the token passed from the login method must be set.

Returns:

If user is allowed to read bitstream, it returns instance of bitstream. Otherwise, it throws WebApplicationException with response code UNAUTHORIZED.

Throws:

javax.ws.rs.WebApplicationException - It can happen on: Bad request, unauthorized, SQL exception and context exception(could not create context).

getBitstreamPolicies

public ResourcePolicy[] getBitstreamPolicies(Integer bitstreamId,
                                    @Context
                                    javax.ws.rs.core.HttpHeaders headers)

Return all bitstream resource policies from all bundles, in which the bitstream is present.

Parameters:

bitstreamId - Id of bitstream in DSpace.

headers - If you want to access the item as the user logged into the context. The header "rest-dspace-token" with the token passed from the login method must be set.

Returns:

Returns an array of ResourcePolicy objects.

getBitstreams

public Bitstream[] getBitstreams(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

Read list of bitstreams. It throws WebApplicationException with response code INTERNAL_SERVER_ERROR(500), if there was problem while reading bitstreams from database.

Parameters:

limit - How many bitstreams will be in the list. Default value is 100.

offset - On which offset (item) the list starts. Default value is 0.

headers - If you want to access the item as the user logged into the context. The header "rest-dspace-token" with the token passed from the login method must be set.

Returns:

Returns an array of bistreams. Array doesn't contain bitstreams for which the user doesn't have read permission.

Throws:

javax.ws.rs.WebApplicationException - Thrown in case of a problem with reading the database or with creating a context.

getBitstreamData

public javax.ws.rs.core.Response getBitstreamData(Integer bitstreamId,
                                         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

Read bitstream data. May throw WebApplicationException with the INTERNAL_SERVER_ERROR(500) code. Caused by three exceptions: IOException if there was a problem with reading bitstream file. SQLException if there was a problem while reading from database. And AuthorizeException if there was a problem with authorization of user logged to DSpace context.

Parameters:

bitstreamId - Id of the bitstream, whose data will be read.

headers - If you want to access the item as the user logged into the context. The header "rest-dspace-token" with the token passed from the login method must be set.

Returns:

Returns response with data with file content type. It can return the NOT_FOUND(404) response code in case of wrong bitstream id. Or response code UNAUTHORIZED(401) if user is not allowed to read bitstream.

Throws:

javax.ws.rs.WebApplicationException - Thrown if there was a problem: reading the file data; or reading the database; or creating the context; or with authorization.

addBitstreamPolicy

public javax.ws.rs.core.Response addBitstreamPolicy(Integer bitstreamId,
                                           ResourcePolicy policy,
                                           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

Add bitstream policy to all bundles containing the bitstream.

Parameters:

bitstreamId - Id of bitstream in DSpace.

policy - Policy to be added. The following attributes are not applied: epersonId,

headers - If you want to access the item as the user logged into the context. The header "rest-dspace-token" with the token passed from the login method must be set.

Returns:

Returns ok, if all was ok. Otherwise status code 500.

Throws:

javax.ws.rs.WebApplicationException

updateBitstream

public javax.ws.rs.core.Response updateBitstream(Integer bitstreamId,
                                        Bitstream bitstream,
                                        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 bitstream metadata. Replaces everything on targeted bitstream. May throw WebApplicationException caused by two exceptions: SQLException, if there was a problem with the database. AuthorizeException if there was a problem with the authorization to edit bitstream metadata.

Parameters:

bitstreamId - Id of bistream to be updated.

bitstream - Bitstream with will be placed. It must have filled user credentials.

headers - If you want to access the item as the user logged into the context. The header "rest-dspace-token" with the token passed from the login method must be set.

Returns:

Return response codes: OK(200), NOT_FOUND(404) if bitstream does not exist and UNAUTHORIZED(401) if user is not allowed to write to bitstream.

Throws:

javax.ws.rs.WebApplicationException - Thrown when: Error reading from database; or error creating context; or error regarding bitstream authorization.

updateBitstreamData

public javax.ws.rs.core.Response updateBitstreamData(Integer bitstreamId,
                                            InputStream is,
                                            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 bitstream data. Changes bitstream data by editing database rows. May throw WebApplicationException caused by: SQLException if there was a problem editing or reading the database, IOException if there was a problem with reading from InputStream, Exception if there was another problem.

Parameters:

bitstreamId - Id of bistream to be updated.

is - InputStream filled with new data.

headers - If you want to access the item as the user logged into the context. The header "rest-dspace-token" with the token passed from the login method must be set.

Returns:

Return response if bitstream was updated. Response codes: OK(200), NOT_FOUND(404) if id of bitstream was bad. And UNAUTHORIZED(401) if user is not allowed to update bitstream.

Throws:

javax.ws.rs.WebApplicationException - This exception can be thrown in this cases: Problem with reading or writing to database. Or problem with reading from InputStream.

deleteBitstream

public javax.ws.rs.core.Response deleteBitstream(Integer bitstreamId,
                                        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 bitstream from all bundles in DSpace. May throw WebApplicationException, which can be caused by three exceptions. SQLException if there was a problem reading from database or removing from database. AuthorizeException, if user doesn't have permission to delete the bitstream or file. IOException, if there was a problem deleting the file.

Parameters:

bitstreamId - Id of bitstream to be deleted.

headers - If you want to access the item as the user logged into the context. The header "rest-dspace-token" with the token passed from the login method must be set.

Returns:

Return response codes: OK(200), NOT_FOUND(404) if bitstream of that id does not exist and UNAUTHORIZED(401) if user is not allowed to delete bitstream.

Throws:

javax.ws.rs.WebApplicationException - Can be thron if there was a problem reading or editting the database. Or problem deleting the file. Or problem with authorization to bitstream and bundles. Or problem with creating context.

deleteBitstreamPolicy

public javax.ws.rs.core.Response deleteBitstreamPolicy(Integer bitstreamId,
                                              Integer policyId,
                                              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 policy.

Parameters:

bitstreamId - Id of the DSpace bitstream whose policy will be deleted.

policyId - Id of the policy to delete.

headers - If you want to access the item as the user logged into the context. The header "rest-dspace-token" with the token passed from the login method must be set.

Returns:

It returns Ok, if was all ok. Otherwise status code 500.

Throws:

javax.ws.rs.WebApplicationException