org.icatproject.ids.plugin

Class AbstractMainStorage

java.lang.Object

org.icatproject.ids.plugin.AbstractMainStorage

All Implemented Interfaces:

MainStorageInterface

public abstract class AbstractMainStorage
extends Object
implements MainStorageInterface

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

Constructor Summary

Constructors

Constructor and Description
AbstractMainStorage()

Method Summary

Modifier and Type	Method and Description
void	delete(DsInfo dsInfo) This is a dummy implementation.
void	delete(String location, String createId, String modId) This is a dummy implementation.
boolean	exists(DsInfo dsInfo) This is a dummy implementation.
boolean	exists(String location) This is a dummy implementation.
List<DfInfo>	getDatafilesToArchive(long lowArchivingLevel, long highArchivingLevel) This is a dummy implementation.
List<DsInfo>	getDatasetsToArchive(long lowArchivingLevel, long highArchivingLevel) This is a dummy implementation.
Path	getPath(String location, String createId, String modId) This is a dummy implementation.
AutoCloseable	lock(DsInfo dsInfo, boolean shared) This is a dummy implementation.
String	put(DsInfo dsInfo, String name, InputStream inputStream) This is a dummy implementation.
void	put(InputStream inputStream, String location) This is a dummy implementation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.icatproject.ids.plugin.MainStorageInterface

get

Constructor Detail

AbstractMainStorage

public AbstractMainStorage()

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.

Specified by:

delete in interface MainStorageInterface

Parameters:

dsInfo - describes the data set with the files to be deleted

Throws:

IOException - to indicate failure

delete

public void delete(String location,
                   String createId,
                   String modId)
            throws IOException

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

Specified by:

delete in interface MainStorageInterface

Parameters:

location - location of the data file to be deleted

createId - the icat user name of the creator of this datafile. This is provided so that the implementation can choose whether or not to trust the ICAT datafile object which holds this location field.

modId - the icat user name of the modifier of this datafile. This is provided so that the implementation can choose whether or not to trust the ICAT datafile object which holds this location field.

Throws:

IOException - to indicate failure

exists

public boolean exists(DsInfo dsInfo)

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

Specified by:

exists in interface MainStorageInterface

Parameters:

dsInfo - describes the data set being queried

Returns:

true if the data set exists

exists

public boolean exists(String location)

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

Specified by:

exists in interface MainStorageInterface

Parameters:

location - the value from datafile.location

Returns:

true if the data file exists

getDatafilesToArchive

public List<DfInfo> getDatafilesToArchive(long lowArchivingLevel,
                                          long highArchivingLevel)
                                   throws IOException

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

Specified by:

getDatafilesToArchive in interface MainStorageInterface

Parameters:

lowArchivingLevel - don't try to reduce space below this level

highArchivingLevel - if storage used is less than this return an empty list. Otherwise identify the list of DsInfos to get the space down to lowArchivingLevel

Returns:

list of DfInfos

Throws:

IOException - to indicate failure

getDatasetsToArchive

public List<DsInfo> getDatasetsToArchive(long lowArchivingLevel,
                                         long highArchivingLevel)
                                  throws IOException

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

Specified by:

getDatasetsToArchive in interface MainStorageInterface

Parameters:

lowArchivingLevel - don't try to reduce space below this level

highArchivingLevel - if storage used is less than this return an empty list. Otherwise identify the list of DsInfos to get the space down to lowArchivingLevel

Returns:

list of DsInfos

Throws:

IOException - to indicate failure

getPath

public Path getPath(String location,
                    String createId,
                    String modId)
             throws IOException

This is a dummy implementation. You need to override it if you want to support the getLink call.

Specified by:

getPath in interface MainStorageInterface

Parameters:

location - the value from datafile.location

createId - the icat user name of the creator of this datafile. This is provided so that the implementation can choose whether or not to trust the ICAT datafile object which holds this location field.

modId - the icat user name of the modifier of this datafile. This is provided so that the implementation can choose whether or not to trust the ICAT datafile object which holds this location field.

Returns:

physical path

Throws:

IOException - to indicate failure

put

public String put(DsInfo dsInfo,
                  String name,
                  InputStream inputStream)
           throws IOException

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

Specified by:

put in interface MainStorageInterface

Parameters:

dsInfo - describes the data set to which the data file should be added

name - name of file within data set

inputStream - stream of data to store

Returns:

the location of the stored data file

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 a two level storage.

Specified by:

put in interface MainStorageInterface

Parameters:

inputStream - stream of data to store

location - where to store the file

Throws:

IOException - to indicate failure

lock

public AutoCloseable lock(DsInfo dsInfo,
                          boolean shared)
                   throws AlreadyLockedException,
                          IOException

This is a dummy implementation. You need to override it if you want to support locking on the file system level.

Specified by:

lock in interface MainStorageInterface

Parameters:

dsInfo - describes the data set to be locked

shared - indicates whether a shared or an exclusive lock should be obtained

Returns:

an AutoCloseable that releases the lock on close

Throws:

AlreadyLockedException - if the lock cannot be obtained because the dataset is already locked

IOException - to indicate failure