org.icatproject.ids.plugin

Class MainStorageWithoutArchive

java.lang.Object

org.icatproject.ids.plugin.MainStorageWithoutArchive

All Implemented Interfaces:

MainStorageInterface

Direct Known Subclasses:

MainStorageWithoutArchiveReadOnly

public abstract class MainStorageWithoutArchive
extends Object
implements MainStorageInterface

This is a partial implementation of a MainStorageInterface providing dummy implementations of those operations not needed when no archive storage is being used.

Constructor Summary

Constructors

Constructor and Description
MainStorageWithoutArchive()

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(DsInfo dsInfo) This is a dummy implementation
boolean	exists(DsInfo dsInfo) This is a dummy implementation
List<DfInfo>	getDatafilesToArchive(long lowArchivingLevel, long highArchivingLevel) Return the list of DfInfos which should be archived to reduce the used storage to between lowArchivingLevel and highArchivingLevel.
List<DsInfo>	getDatasetsToArchive(long lowArchivingLevel, long highArchivingLevel) Return the list of DsInfos which should be archived to reduce the used storage to between lowArchivingLevel and highArchivingLevel.
void	put(InputStream inputStream, String location) This is a dummy implementation - only used when a file is restored from archive so the Datafile.location field in ICAT is already known.

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

delete, exists, get, getPath, put

Constructor Detail

MainStorageWithoutArchive

public MainStorageWithoutArchive()

Method Detail

delete

public void delete(DsInfo dsInfo)
            throws IOException

This is a dummy implementation

Specified by:

delete in interface MainStorageInterface

Parameters:

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

Throws:

IOException

exists

public boolean exists(DsInfo dsInfo)
               throws IOException

This is a dummy implementation

Specified by:

exists in interface MainStorageInterface

Parameters:

dsInfo - describes the data set being queried

Returns:

true if the data set exists

Throws:

IOException

put

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

This is a dummy implementation - only used when a file is restored from archive so the Datafile.location field in ICAT is already known.

Specified by:

put in interface MainStorageInterface

Parameters:

inputStream - stream of data to store

location - where to store the file

Throws:

IOException

getDatasetsToArchive

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

Description copied from interface: MainStorageInterface

Return the list of DsInfos which should be archived to reduce the used storage to between lowArchivingLevel and highArchivingLevel. A dummy implementation can be provided if no archive storage is configured with storageUnit set to dataset The implementaion is free to do this however it chooses. Use might be made of the information available from the java.nio.file.FileStore (obtainable by Files.getFileStore(path) for any file to see whether or not any action is required. For each DsInfo returned the IDS will find all datasets which match all the fields that are not null in the DsInfo.

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

getDatafilesToArchive

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

Description copied from interface: MainStorageInterface

Return the list of DfInfos which should be archived to reduce the used storage to between lowArchivingLevel and highArchivingLevel. A dummy implementation can be provided if no archive storage is configured with storageUnit set to datafile The implementaion is free to do this however it chooses. Use might be made of the information available from the java.nio.file.FileStore (obtainable by Files.getFileStore(path) for any file to see whether or not any action is required. For each DfInfo returned the IDS will find all datafiles which match all the fields that are not null in the DfInfo.

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