org.fcrepo.server.rest
Class DatastreamResource

java.lang.Object
  org.fcrepo.server.rest.BaseRestResource
      org.fcrepo.server.rest.DatastreamResource

public class DatastreamResource
extends BaseRestResource

A rest controller to handle CRUD operations for the Fedora datastream API (API-M) Request syntax:

GET,PUT,POST,DELETE prototol://hostname:port/fedora/objects/PID/datastreams/DSID/versions ? [dateTime][parmArray]

• protocol - either http or https.
• hostname - required hostname of the Fedora server.
• port - required port number on which the Fedora server is running.
• fedora - required path name for the Fedora access service.
• objects - required path name for the Fedora service.
• PID - required persistent idenitifer of the digital object.
• DSID - required datastream identifier for the datastream.
• dateTime - optional dateTime value indicating dissemination of a version of the digital object at the specified point in time.
• parmArray - optional array of method parameters consisting of name/value pairs in the form parm1=value1&parm2=value2...

Version:

$Id$

Author:

cuong.tran@yourmediashelf.com

Field Summary

Fields inherited from class org.fcrepo.server.rest.BaseRestResource

apiAService, apiMService, datastreamFilenameHelper, fedoraServer, fedoraServerHost, FORM, headers, HTML, mapper, servletRequest, TEXT_HTML, TEXT_XML, uriInfo, XML, ZIP

Constructor Summary

DatastreamResource()


Method Summary

javax.ws.rs.core.Response	addDatastream(String pid, String dsID, String controlGroup, String dsLocation, List<String> altIDs, String dsLabel, Boolean versionable, String dsState, String formatURI, String checksumType, String checksum, String mimeType, String logMessage) Add or modify a datastream.
protected javax.ws.rs.core.Response	addOrUpdateDatastream(boolean posted, String pid, String dsID, javax.ws.rs.core.MediaType mediaType, String mimeType, String controlGroup, String dsLocation, List<String> altIDList, String dsLabel, Boolean versionable, String dsState, String formatURI, String checksumType, String checksum, String logMessage, boolean ignoreContent, DateTimeParam lastModifiedDate)
javax.ws.rs.core.Response	deleteDatastream(String pid, String dsID, String startDT, String endDT, String logMessage) Invoke API-M.purgeDatastream DELETE /objects/{pid}/datastreams/{dsID} ? startDT endDT logMessage
javax.ws.rs.core.Response	getDatastream(String pid, String dsID, String dateTime, String download) Invoke API-A.getDatastreamDissemination(context, pid, dsID, asOfDateTime) GET /objects/{pid}/datastreams/{dsID}/content ? asOfDateTime
javax.ws.rs.core.Response	getDatastreamHistory(String pid, String dsID, String format) Invoke API-M.getDatastreamHistory(context,pid,dsId) GET /objects/{pid}/datastreams/{dsID}/history
javax.ws.rs.core.Response	getDatastreamProfile(String pid, String dsID, String dateTime, String format, boolean validateChecksum) Invoke API-M.getDatastream(context, pid, dsID, asOfDateTime) GET /objects/{pid}/datastreams/{dsID} ? asOfDateTime & validateChecksum=true|false
javax.ws.rs.core.Response	listDatastreams(String pid, String dateTime, String format) Inquires upon all object Datastreams to obtain datastreams contained by a digital object.
javax.ws.rs.core.Response	modifyDatastream(String pid, String dsID, String dsLocation, List<String> altIDs, String dsLabel, Boolean versionable, String dsState, String formatURI, String checksumType, String checksum, String mimeType, String logMessage, boolean ignoreContent, DateTimeParam lastModifiedDate) Modify an existing datastream.

Methods inherited from class org.fcrepo.server.rest.BaseRestResource

buildResponse, getContext, getSerializer, handleException, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

DatastreamResource

public DatastreamResource()

Method Detail

listDatastreams

public javax.ws.rs.core.Response listDatastreams(String pid,
                                                 String dateTime,
                                                 String format)

Inquires upon all object Datastreams to obtain datastreams contained by a digital object. This returns a set of datastream locations that represent all possible datastreams available in the object.

GET /objects/{pid}/datastreams ? asOfDateTime format

Parameters:

pid -

dateTime -

format -

getDatastreamProfile

public javax.ws.rs.core.Response getDatastreamProfile(String pid,
                                                      String dsID,
                                                      String dateTime,
                                                      String format,
                                                      boolean validateChecksum)

Invoke API-M.getDatastream(context, pid, dsID, asOfDateTime)

GET /objects/{pid}/datastreams/{dsID} ? asOfDateTime & validateChecksum=true|false

getDatastreamHistory

public javax.ws.rs.core.Response getDatastreamHistory(String pid,
                                                      String dsID,
                                                      String format)

Invoke API-M.getDatastreamHistory(context,pid,dsId) GET /objects/{pid}/datastreams/{dsID}/history

Parameters:

pid - the PID of the digital object

dsID - the ID of the datastream

format - the desired format. Either html or "xml"

Returns:

the response, either in XML or XHTML format

getDatastream

public javax.ws.rs.core.Response getDatastream(String pid,
                                               String dsID,
                                               String dateTime,
                                               String download)

Invoke API-A.getDatastreamDissemination(context, pid, dsID, asOfDateTime)

GET /objects/{pid}/datastreams/{dsID}/content ? asOfDateTime

deleteDatastream

public javax.ws.rs.core.Response deleteDatastream(String pid,
                                                  String dsID,
                                                  String startDT,
                                                  String endDT,
                                                  String logMessage)

Invoke API-M.purgeDatastream

DELETE /objects/{pid}/datastreams/{dsID} ? startDT endDT logMessage

modifyDatastream

public javax.ws.rs.core.Response modifyDatastream(String pid,
                                                  String dsID,
                                                  String dsLocation,
                                                  List<String> altIDs,
                                                  String dsLabel,
                                                  Boolean versionable,
                                                  String dsState,
                                                  String formatURI,
                                                  String checksumType,
                                                  String checksum,
                                                  String mimeType,
                                                  String logMessage,
                                                  boolean ignoreContent,
                                                  DateTimeParam lastModifiedDate)

Modify an existing datastream.

PUT /objects/{pid}/datastreams/{dsID} ? dsLocation altIDs dsLabel versionable dsState formatURI checksumType checksum logMessage

Successful Response: Status: 200 OK Content-Type: text/xml Body: XML datastream profile

addDatastream

public javax.ws.rs.core.Response addDatastream(String pid,
                                               String dsID,
                                               String controlGroup,
                                               String dsLocation,
                                               List<String> altIDs,
                                               String dsLabel,
                                               Boolean versionable,
                                               String dsState,
                                               String formatURI,
                                               String checksumType,
                                               String checksum,
                                               String mimeType,
                                               String logMessage)

Add or modify a datastream.

POST /objects/{pid}/datastreams/{dsID} ? controlGroup dsLocation altIDs dsLabel versionable dsState formatURI checksumType checksum logMessage

Successful Response: Status: 201 Created Location: Datastream profile URL Content-Type: text/xml Body: XML datastream profile

addOrUpdateDatastream

protected javax.ws.rs.core.Response addOrUpdateDatastream(boolean posted,
                                                          String pid,
                                                          String dsID,
                                                          javax.ws.rs.core.MediaType mediaType,
                                                          String mimeType,
                                                          String controlGroup,
                                                          String dsLocation,
                                                          List<String> altIDList,
                                                          String dsLabel,
                                                          Boolean versionable,
                                                          String dsState,
                                                          String formatURI,
                                                          String checksumType,
                                                          String checksum,
                                                          String logMessage,
                                                          boolean ignoreContent,
                                                          DateTimeParam lastModifiedDate)