API:EPrints/Apache/CRUD

From EPrints Documentation
Revision as of 10:25, 2 April 2012 by Tdb01r (talk | contribs)
Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


Warning This feature requires EPrints version 3.3.0 or later

NAME

EPrints::Apache::CRUD - Create, read, update and delete via HTTP


SYNOPSIS

$crud = EPrints::Apache::CRUD->new(
		repository => $repo,
		request => $r,
		datasetid => "eprint",
		dataobjid => "23",
	);


DESCRIPTION

The CRUD (Create/Read/Update/Delete) module provides the Web API for manipulating content on the server. The API is an AtomPub implementation that exposes Import and Export plugins via simple URLs and HTTP content type negotiation.

You should use the <link> entries in the repository's home page to locate the CRUD endpoint, as they may change in the future: 

  <link rel="Sword" href="https://myrepo/sword-app/servicedocument" />
  <link rel="SwordDeposit" href="https://myrepo/id/contents" />


Examples

Create a new eprint based on a single file: 

  curl -x POST \
    -i \
    -u user:password \
    -d 'Hello, World!' \
    -H 'Content-Type: text/plain' \
    https://myrepo/id/contents
  
  HTTP/1.1 201 Created
  Content-Type: application/atom+xml;charset=utf-8
  ...

Add a file to an existing eprint: 

  curl -X POST \
    -i \
    -u user:password \
    -d 'Hello, World!' \
    -H 'Content-Disposition: attachment; filename=hello.txt' \
    -H 'Content-Type: text/plain' \
    https://myrepo/id/eprint/23/contents
  
  HTTP/1.1 201 Created
  Content-Type: application/atom+xml;charset=utf-8
  ...

Get an eprint's metadata in Atom XML: 

  curl -X GET \
    -i \
    -u user:password \
    -H 'Accept: application/atom+xml' \
    https://myrepo/id/eprint/23
  
  HTTP/1.1 200 OK
  Content-Type: application/atom+xml;charset=utf-8
  ...

Get the list of contents (documents) of an eprint in Atom XML: 

  curl -X GET \
    -i \
    -u user:password \
    -H 'Accept: application/atom+xml' \
    https://myrepo/id/eprint/23/contents
  
  HTTP/1.1 200 OK
  Content-Type: application/atom+xml;charset=utf-8
  ...

You can find more examples in the tests/84_sword.t unit test.


URI layout

These URIs are relative to your EPrints HTTP/HTTPs root.

  • /id/contents GET,HEAD,OPTIONS,POST
Requires authentication.
GET a list of the eprints owned by the user. POST to create a new EPrint object.
  • /id/[datasetid]/[dataobjid] DELETE,GET,HEAD,OPTIONS,PUT
Requires authentication depending on user's privileges and object visibility.
GET an object's metadata or, for File objects, the file content. PUT to replace the metadata and/or contents (see Updating complex objects using PUT). If the object does not exist will attempt to create it with the given dataobjid (requires 'upsert' privilege).
  • /id/[datasetid]/[dataobjid]/contents DELETE,GET,HEAD,OPTIONS,POST,PUT
Requires authentication depending on user's privileges and object visibility.
GET the logical contents of the object: documents for eprints or files for documents. PUT to replace the existing contents or POST to add to the existing contents.


HTTP Content Negotiation

GET/HEAD requests are processed using Export plugins. POST/PUT requests are processed using Import plugins.

The plugin used depends on the request's Accept (GET/HEAD) or Content-Type (POST/PUT) header and the type of object being acted on. For example, the following request: 

  GET /id/eprint/23 HTTP/1.1
  Accept: application/vnd.eprints.data+xml

Will search for an Export plugin that accepts objects of type dataobj/eprint and can produce output in the MIME type application/vnd.eprints.data+xml. This will most likely be the Export::XML plugin.

In addition to the general plugin negotiation behaviour some special cases are supported to improve compatibility with Atom Pub/Web Browser clients:

  • /id/eprint/...
Requesting EPrint objects as text/html will result in a 303 Redirect to the eprint object's abstract page or, if the eprint is not public, its View page.
  • /id/document/.../contents
Requesting the /contents of a Document will return the content of the document's main file.
  • /id/file/...
Requesting a File object with no Accept header (or */*) will return the file's content.
  • POST /id/.../contents
When creating new records via POST content negotiation is performed against the Import plugins.
If no Import plugin supports the Content-Type header the content will be treated as application/octet-stream and stored in a new object. The resulting Atom entry will describe the new object (e.g. the eprint object in which the new document and file objects were created).
If an Import plugin matches the result will depend on the plugin's output. Import plugins may produce a single object, if the output is only an object, or an object plus content file(s).
  • Default MIME type and filename
If no Content-Type header is given the MIME type defaults to application/octet-stream. If no Content-Disposition header with a filename argument is given the filename will be set to main.bin.


Updating complex objects using PUT

Eprint objects contain zero or more documents, which each contain zero or more files. When you update (PUT) an eprint object the contained documents will only be replaced if the Import plugin defines new documents e.g. the Atom Import plugin will never define new documents so PUTing Atom content will only update the eprint's metadata. PUTing EP3 XML will replace the documents if you include a <documents> XML element.

PUTing to /contents will always replace all contents - PUTing to /eprint/23/contents is equivalent to DELETE /eprint/23/contents then POST /eprint/23/contents.


PUT/DELETE from Javascript

{{#if:{{{since}}}| * Requires version {{{since}}} or later|}}

Web browsers only allow GET and POST requests. To perform other requests use the 'X-Method' header with POST to specify the actual method you want: 

  POST /id/eprint/23 HTTP/1.1
  X-Method: PUT
  ...


Upserting objects with PUT

{{#if:{{{since}}}| * Requires version {{{since}}} or later|}}

If you have the upsert privilege objects will be created on demand, otherwise attempting to PUT to a non-existant object will result in an error.


METHODS

repository

$repo = $crud->repository()

Returns the current repository.


request

$r = $crud->request()

Returns the current Apache2::RequestUtil.


method

$method = $crud->method()

Returns the HTTP method.


scope

$scope = $crud->scope()

Returns the scope of the action being performed.


dataset

$dataset = $crud->dataset()

Returns the current dataset (if any).


dataobj

$dataobj = $crud->dataobj()

Returns the current dataobj (if any).


field

$field = $crud->field()

Returns the current field (if available);


headers

$headers = $crud->headers()

Get the processed headers.


options

@verbs = $crud->options()

Returns the available HTTP verbs for the current request.


plugin

$plugin = $crud->plugin()

Returns the current plugin (if available).


is_write

$bool = $crud->is_write()

Returns true if the request is not a read-only method.


accept_type

$accept_type = $crud->accept_type()

Returns the EPrints type for the current request.


check_packaging

$rc = $crud->check_packaging()

Check the Packaging header is ok, if given.


parse_input

$list = $crud->parse_input( $plugin, $f [, %params ] )

Parse the content submitted by the user using the given $plugin. $f is called by epdata_to_dataobj to convert epdata to a dataobj.  %params are passed to the plugin's input_fh method.

Returns undef on error.


import_plugins

@plugins = $crud->import_plugins( [ %params ] )

Returns all matching import plugins against %params ordered by descending 'q' score.


export_plugins

@plugins = $crud->export_plugins( [ %params ] )

Returns all matching export plugins against %params ordered by descending 'q' score.


content_negotiate_best_plugin

$plugin = $crud->content_negotiate_best_plugin()

Work out the best plugin to export/update an object based on the client-headers.


DELETE

$rc = $crud->DELETE()

Handle DELETE requests.

  • HTTP_METHOD_NOT_ALLOWED
Can't perform DELETE on /id/contents.
  • HTTP_NOT_FOUND
No such object.
  • HTTP_CONFLICT
Lock conflict with another user.
  • HTTP_NO_CONTENT
Successfully removed the object.


GET

$rc = $crud->GET( [ $owner ] )

Handle GET requests.

  • HTTP_NO_CONTENT
No sub-objects in /id/.../contents.
  • HTTP_NOT_ACCEPTABLE
More than one sub-object in /id/.../contents.
  • HTTP_UNSUPPORTED_MEDIA_TYPE
No Export plugin matches the Accept header/object type.
  • HTTP_SEE_OTHER
Redirect to a non-CRUD EPrints page.
  • HTTP_NOT_FOUND
Object not found.
  • HTTP_OK
Object outputted successfully.


POST

$rc = $crud->POST( [ $owner ] )

Handle POST requests.

  • HTTP_METHOD_NOT_ALLOWED
Can only POST to /id/.../contents.
  • HTTP_BAD_REQUEST
No plugin for the SWORD Packaging header.
  • HTTP_CREATED
Object(s) successfully created.


PUT

$rc = $crud->PUT( [ $owner ] )

Handle PUT requests.

  • HTTP_UNSUPPORTED_MEDIA_TYPE
No Import plugin matched the Content-Type header/object type.
  • HTTP_RANGE_NOT_SATISFIABLE
Range header is invalid or unsupported for the object type.
  • HTTP_FORBIDDEN
User does not have permission to create/update the object.
  • HTTP_CREATED
Object was successfully created.
  • HTTP_NO_CONTENT
Object was successfully updated.


PUT_contents

$rc = $crud->PUT_contents( [ $owner ] )

Equivalent to DELETE /id/.../contents then POST /id/.../contents.

See DELETE and POST.


SEE ALSO

http://en.wikipedia.org/wiki/Create,_read,_update_and_delete

http://en.wikipedia.org/wiki/Content_negotiation


COPYRIGHT

Copyright 2000-2011 University of Southampton.

This file is part of EPrints http://www.eprints.org/.

EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

EPrints is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints. If not, see http://www.gnu.org/licenses/.



Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:EPrints/Apache/CRUD&oldid=10405’