Difference between revisions of "API:EPrints/Storage"
| Line 12: | Line 12: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 31: | Line 34: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 42: | Line 48: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 51: | Line 60: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 63: | Line 75: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 77: | Line 92: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 87: | Line 105: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 99: | Line 120: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 111: | Line 135: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 127: | Line 154: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 141: | Line 171: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 153: | Line 186: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 167: | Line 203: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 179: | Line 218: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 191: | Line 233: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
| Line 203: | Line 248: | ||
<!-- Edit below this comment --> | <!-- Edit below this comment --> | ||
| + | |||
| + | <!-- Pod2Wiki= --> | ||
| + | </div> | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment --> | <!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment --> | ||
Revision as of 12:50, 25 February 2010
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
 |
The interface for this module has not been finalised and may change in the future. |
Contents
- 1 NAME
- 2 SYNOPSIS
- 3 DESCRIPTION
- 4 METHODS
- 4.1 $store = EPrints::Storage->new( $repository )
- 4.2 $len = $store->store( $fileobj, CODEREF )
- 4.3 $success = $store->retrieve( $fileobj, CALLBACK )
- 4.4 $success = $store->delete( $fileobj )
- 4.5 $ok = $store->delete_copy( $plugin, $fileobj )
- 4.6 $filename = $store->get_local_copy( $fileobj )
- 4.7 $url = $store->get_remote_copy( $fileobj )
- 4.8 @plugins = $store->get_plugins( $fileobj )
- 4.9 $ok = $store->copy( $plugin, $fileobj )
- 4.10 $ok = $storage->open_write( $fileobj )
- 4.11 $ok = $storage->write( $fileobj, $buffer )
- 4.12 $ok = $storage->close_write( $fileobj );
NAME
EPrints::Storage - store and retrieve objects in the storage engine
This should be inserted verbatum into the Wiki page.
SYNOPSIS
my $store = $repository->storage(); $store->store( $fileobj, # file object "diddle.pdf", # filename $fh # file handle );
DESCRIPTION
This module is the storage control layer which uses EPrints::Plugin::Storage plugins to support various storage back-ends. It enables the storage, retrieval and deletion of data streams. The maximum size of a stream is dependent on the back-end storage mechanism.
METHODS
$store = EPrints::Storage->new( $repository )
Create a new storage object for $repository. Should not be used directly, see EPrints::Session.
$len = $store->store( $fileobj, CODEREF )
Read from and store all data from CODEREF for $fileobj. The filesize field in $fileobj must be set at the expected number of bytes to read from CODEREF.
Returns undef if the file couldn't be stored, otherwise the number of bytes read.
$success = $store->retrieve( $fileobj, CALLBACK )
$success = $store->delete( $fileobj )
Delete all object copies stored for $fileobj.
$ok = $store->delete_copy( $plugin, $fileobj )
Delete the copy of this file stored in $plugin.
$filename = $store->get_local_copy( $fileobj )
Return the name of a local copy of the file.
Will retrieve and cache the remote object using File::Temp if necessary.
Returns undef if retrieval failed.
$url = $store->get_remote_copy( $fileobj )
Returns a URL from which this file can be accessed.
Returns undef if this file is not available via another service.
@plugins = $store->get_plugins( $fileobj )
Returns the EPrints::Plugin::Storage plugin(s) to use for $fileobj. If more than one plugin is returned they should be used in turn until one succeeds.
$ok = $store->copy( $plugin, $fileobj )
Copy the contents of $fileobj into another storage $plugin.
Returns 1 on success, 0 on failure and -1 if a copy already exists in $plugin.
$ok = $storage->open_write( $fileobj )
Start a write session for $fileobj. $fileobj must have at least the "filesize" property set (which is the number of bytes that will be written).
$ok = $storage->write( $fileobj, $buffer )
Write $buffer to the storage plugin(s).
$ok = $storage->close_write( $fileobj );
Finish writing to the storage plugin(s) for $fileobj.
