com.googlecode.fascinator.storage.filesystem

Class FileSystemStorage

java.lang.Object

com.googlecode.fascinator.storage.filesystem.FileSystemStorage

All Implemented Interfaces:

com.googlecode.fascinator.api.Plugin, com.googlecode.fascinator.api.storage.Storage

public class FileSystemStorage
extends Object
implements com.googlecode.fascinator.api.storage.Storage

This plugin is implemeted based on Dflat/Pairtree which storaes the DigitalObjects in the local file system.

Configuration

Standard configuration table:

Option	Description	Required	Default
home	Location where the files are stored	Yes	${fascinator.home}/storage

Examples

1. Using Filesystem Storage plugin in The Fascinator

         {
        "storage": {
            "type": "file-system",
            "file-system": {
                "home": "${fascinator.home}/storage"
            }
    }
    
    

Wiki Link

None

Author:

Oliver Lucido

Constructor Summary

Constructors

Constructor and Description
FileSystemStorage()

Method Summary

Methods

Modifier and Type	Method and Description
com.googlecode.fascinator.api.storage.DigitalObject	createObject(String oid)
File	getHomeDir()
String	getId()
String	getName()
com.googlecode.fascinator.api.storage.DigitalObject	getObject(String oid)
Set<String>	getObjectIdList()
com.googlecode.fascinator.api.PluginDescription	getPluginDetails() Gets a PluginDescription object relating to this plugin.
void	init(File jsonFile)
void	init(String jsonString)
void	removeObject(String oid)
void	shutdown()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemStorage

public FileSystemStorage()

Method Detail

getId

public String getId()

Specified by:

getId in interface com.googlecode.fascinator.api.Plugin

getName

public String getName()

Specified by:

getName in interface com.googlecode.fascinator.api.Plugin

getPluginDetails

public com.googlecode.fascinator.api.PluginDescription getPluginDetails()

Gets a PluginDescription object relating to this plugin.

Specified by:

getPluginDetails in interface com.googlecode.fascinator.api.Plugin

Returns:

a PluginDescription

getHomeDir

public File getHomeDir()

init

public void init(String jsonString)
          throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

init in interface com.googlecode.fascinator.api.Plugin

Throws:

com.googlecode.fascinator.api.storage.StorageException

init

public void init(File jsonFile)
          throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

init in interface com.googlecode.fascinator.api.Plugin

Throws:

com.googlecode.fascinator.api.storage.StorageException

shutdown

public void shutdown()
              throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

shutdown in interface com.googlecode.fascinator.api.Plugin

Throws:

com.googlecode.fascinator.api.storage.StorageException

createObject

public com.googlecode.fascinator.api.storage.DigitalObject createObject(String oid)
                                                                 throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

createObject in interface com.googlecode.fascinator.api.storage.Storage

Throws:

com.googlecode.fascinator.api.storage.StorageException

getObject

public com.googlecode.fascinator.api.storage.DigitalObject getObject(String oid)
                                                              throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

getObject in interface com.googlecode.fascinator.api.storage.Storage

Throws:

com.googlecode.fascinator.api.storage.StorageException

removeObject

public void removeObject(String oid)
                  throws com.googlecode.fascinator.api.storage.StorageException

Specified by:

removeObject in interface com.googlecode.fascinator.api.storage.Storage

Throws:

com.googlecode.fascinator.api.storage.StorageException

getObjectIdList

public Set<String> getObjectIdList()

Specified by:

getObjectIdList in interface com.googlecode.fascinator.api.storage.Storage