Class: Moab::StorageServices

Inherits:
Object
  • Object
show all
Defined in:
lib/moab/storage_services.rb

Overview

Note:

Copyright © 2012 by The Board of Trustees of the Leland Stanford Junior University. All rights reserved. See LICENSE for details.

An interface class to support access to SDR storage via a RESTful server

Data Model

  • StorageRepository = represents a digital object repository storage node

    • StorageServices = supports application layer access to the repository’s objects, data, and metadata

    • StorageObject = represents a digital object’s repository storage location and ingest/dissemination methods

      • StorageObjectVersion [1..*] = represents a version subdirectory within an object’s home directory

        • Bagger [1] = utility for creating bagit packages for ingest or dissemination

Direct Known Subclasses

Stanford::StorageServices

Constant Summary collapse

@@repository = 
Moab::StorageRepository.new

Class Method Summary collapse

Class Method Details

.current_version(object_id) ⇒ Integer 



82
83
84
 
# File 'lib/moab/storage_services.rb', line 82

def self.current_version(object_id)
  @@repository.storage_object(object_id).current_version_id
end

.deposit_branch(object_id) ⇒ Pathname 



35
36
37
 
# File 'lib/moab/storage_services.rb', line 35

def self.deposit_branch(object_id)
  @@repository.deposit_branch(object_id)
end

.deposit_trunk ⇒ String 



29
30
31
 
# File 'lib/moab/storage_services.rb', line 29

def self.deposit_trunk
  @@repository.deposit_trunk
end

.find_storage_object(object_id, include_deposit = false) ⇒ StorageObject 



42
43
44
 
# File 'lib/moab/storage_services.rb', line 42

def self.find_storage_object(object_id, include_deposit = false)
  @@repository.find_storage_object(object_id, include_deposit)
end

.object_path(object_id) ⇒ String 



69
70
71
 
# File 'lib/moab/storage_services.rb', line 69

def self.object_path(object_id)
  @@repository.storage_object(object_id).object_pathname.to_s
end

.object_size(object_id, include_deposit = false) ⇒ Integer 



56
57
58
 
# File 'lib/moab/storage_services.rb', line 56

def self.object_size(object_id, include_deposit = false)
  @@repository.object_size(object_id, include_deposit)
end

.object_version_path(object_id, version_id = nil) ⇒ String 



76
77
78
 
# File 'lib/moab/storage_services.rb', line 76

def self.object_version_path(object_id, version_id = nil)
  @@repository.storage_object(object_id).find_object_version(version_id).version_pathname.to_s
end

.repository ⇒ Object 



19
20
21
 
# File 'lib/moab/storage_services.rb', line 19

def self.repository
  @@repository
end

.retrieve_file(file_category, file_id, object_id, version_id = nil) ⇒ Pathname 



105
106
107
108
 
# File 'lib/moab/storage_services.rb', line 105

def self.retrieve_file(file_category, file_id, object_id, version_id = nil)
  storage_object_version = @@repository.storage_object(object_id).find_object_version(version_id)
  storage_object_version.find_filepath(file_category, file_id)
end

.retrieve_file_group(file_category, object_id, version_id = nil) ⇒ FileInventory 



89
90
91
92
93
94
95
96
97
98
 
# File 'lib/moab/storage_services.rb', line 89

def self.retrieve_file_group(file_category, object_id, version_id = nil)
  storage_object_version = @@repository.storage_object(object_id).find_object_version(version_id)
  inventory_type = if file_category =~ /manifest/
                     file_category = 'manifests'
                   else
                     'version'
                   end
  inventory = storage_object_version.file_inventory(inventory_type)
  inventory.group(file_category)
end

.retrieve_file_signature(file_category, file_id, object_id, version_id = nil) ⇒ FileSignature 



125
126
127
128
 
# File 'lib/moab/storage_services.rb', line 125

def self.retrieve_file_signature(file_category, file_id, object_id, version_id = nil)
  storage_object_version = @@repository.storage_object(object_id).find_object_version(version_id)
  storage_object_version.find_signature(file_category, file_id)
end

.retrieve_file_using_signature(file_category, file_signature, object_id, version_id = nil) ⇒ Pathname 



115
116
117
118
 
# File 'lib/moab/storage_services.rb', line 115

def self.retrieve_file_using_signature(file_category, file_signature, object_id, version_id = nil)
  storage_object_version = @@repository.storage_object(object_id).find_object_version(version_id)
  storage_object_version.find_filepath_using_signature(file_category, file_signature)
end

.search_storage_objects(object_id, include_deposit = false) ⇒ Array<StorageObject> 



49
50
51
 
# File 'lib/moab/storage_services.rb', line 49

def self.search_storage_objects(object_id, include_deposit = false)
  @@repository.search_storage_objects(object_id, include_deposit)
end

.storage_object(object_id, create = false) ⇒ StorageObject 



63
64
65
 
# File 'lib/moab/storage_services.rb', line 63

def self.storage_object(object_id, create = false)
  @@repository.storage_object(object_id, create)
end

.storage_roots ⇒ Array<Pathname> 



24
25
26
 
# File 'lib/moab/storage_services.rb', line 24

def self.storage_roots
  @@repository.storage_roots
end

.version_differences(object_id, base_version_id, compare_version_id) ⇒ FileInventoryDifference 



134
135
136
137
138
139
140
 
# File 'lib/moab/storage_services.rb', line 134

def self.version_differences(object_id, base_version_id, compare_version_id)
  base_version = @@repository.storage_object(object_id).storage_object_version(base_version_id)
  compare_version = @@repository.storage_object(object_id).storage_object_version(compare_version_id)
  base_inventory = base_version.file_inventory('version')
  compare_inventory = compare_version.file_inventory('version')
  FileInventoryDifference.new.compare(base_inventory, compare_inventory)
end