org.icatproject.ids.plugin

Class AbstractArchiveStorage

java.lang.Object

org.icatproject.ids.plugin.AbstractArchiveStorage

All Implemented Interfaces:

ArchiveStorageInterface

public abstract class AbstractArchiveStorage
extends Object
implements ArchiveStorageInterface

This is a partial implementation of an ArchiveStorageInterface providing dummy implementations of those operations not needed for certain IDS deployments.

Constructor Summary

Constructors

Constructor and Description
AbstractArchiveStorage()

Method Summary

Modifier and Type	Method and Description
void	delete(DsInfo dsInfo) This is a dummy implementation.
void	delete(String location) This is a dummy implementation.
void	get(DsInfo dsInfo, Path path) This is a dummy implementation.
void	put(DsInfo dsInfo, InputStream inputStream) This is a dummy implementation.
void	put(InputStream inputStream, String location) This is a dummy implementation.
Set<DfInfo>	restore(MainStorageInterface mainStorageInterface, List<DfInfo> dfInfos) This is a dummy implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractArchiveStorage

public AbstractArchiveStorage()

Method Detail

delete

public void delete(DsInfo dsInfo)
            throws IOException

This is a dummy implementation. You need to override it if you want to support StorageUnit DATASET with readOnly set to false.

Specified by:

delete in interface ArchiveStorageInterface

Parameters:

dsInfo - describes the data set

Throws:

IOException - to indicate failure

delete

public void delete(String location)
            throws IOException

This is a dummy implementation. You need to override it if you want to support StorageUnit DATAFILE with readOnly set to false.

Specified by:

delete in interface ArchiveStorageInterface

Parameters:

location - where to store the file

Throws:

IOException - to indicate failure

get

public void get(DsInfo dsInfo,
                Path path)
         throws IOException

This is a dummy implementation. You need to override it if you want to support StorageUnit DATASET.

Specified by:

get in interface ArchiveStorageInterface

Parameters:

dsInfo - describes the data set

path - path of the file to write to (it will be overwritten if it already exists)

Throws:

IOException - to indicate failure

put

public void put(DsInfo dsInfo,
                InputStream inputStream)
         throws IOException

This is a dummy implementation. You need to override it if you want to support StorageUnit DATASET with readOnly set to false.

Specified by:

put in interface ArchiveStorageInterface

Parameters:

dsInfo - describes the data set

inputStream - stream of data to store

Throws:

IOException - to indicate failure

put

public void put(InputStream inputStream,
                String location)
         throws IOException

This is a dummy implementation. You need to override it if you want to support StorageUnit DATAFILE with readOnly set to false.

Specified by:

put in interface ArchiveStorageInterface

Parameters:

inputStream - stream of data to store

location - where to store the file

Throws:

IOException - to indicate failure

restore

public Set<DfInfo> restore(MainStorageInterface mainStorageInterface,
                           List<DfInfo> dfInfos)

This is a dummy implementation. You need to override it if you want to support StorageUnit DATAFILE.

Specified by:

restore in interface ArchiveStorageInterface

Parameters:

mainStorageInterface - the main storage interface to write restored files to

dfInfos - list of DfInfo objects

Returns:

setof DfInfo objects which could not be restored