Difference between revisions of "API:EPrints/Storage"
| Line 1: | Line 1: | ||
<!-- Pod2Wiki=_preamble_ | <!-- Pod2Wiki=_preamble_ | ||
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost. | This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost. | ||
| − | -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Storage.pm|package_name=EPrints::Storage}}[[Category:API|Storage]]<div><!-- Edit below this comment --> | + | -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Storage.pm|package_name=EPrints::Storage}}[[Category:API|STORAGE]][[Category:API:EPrints/Storage|STORAGE]]<div><!-- Edit below this comment --> |
Revision as of 15:12, 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
NAME
EPrints::Storage - store and retrieve objects in the storage engine
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
new
$store = EPrints::Storage->new( $repository )
Create a new storage object for $repository. Should not be used directly, see EPrints::Session.
store
$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.
retrieve
$success = $store->retrieve( $fileobj, CALLBACK )
delete
$success = $store->delete( $fileobj )
Delete all object copies stored for $fileobj.
delete_copy
$ok = $store->delete_copy( $plugin, $fileobj )
Delete the copy of this file stored in $plugin.
get_local_copy
$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.
get_remote_copy
$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.
get_plugins
@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.
copy
$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.
open_write
$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).
write
$ok = $storage->write( $fileobj, $buffer )
Write $buffer to the storage plugin(s).
close_write
$ok = $storage->close_write( $fileobj );
Finish writing to the storage plugin(s) for $fileobj.
