com.exlibris.core.sdk.storage.handler

Class AbstractStorageHandler

java.lang.Object

com.exlibris.core.sdk.storage.handler.AbstractStorageHandler

All Implemented Interfaces:

StorageHandler, StoragePlugin

public abstract class AbstractStorageHandler
extends java.lang.Object
implements StorageHandler

Author:

Shaib

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	parameters
protected java.lang.Long	storageGroupId
protected java.lang.Long	storageId

Constructor Summary

Constructors

Constructor and Description
AbstractStorageHandler()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createFileName(StoredEntityMetaData storedEntityMetadata)
protected java.lang.String	getChecksumUsingPlugin(java.lang.String filePath, java.lang.String pluginName, java.lang.String oldFixityValue)
java.lang.String	getFullFilePathForFlocat(java.lang.String storedEntityIdentifier)
java.util.Map<java.lang.String,java.lang.String>	getParameters()
java.lang.Long	getStorageGroupId()
java.lang.Long	getStorageId()
protected java.lang.String	getTempStorageDirectory() Use this method to get the location for files to be stored locally, when StoragePlugin.getLocalFilePath(String) is called.
protected java.lang.String	getTempStorageDirectory(boolean includeStorageId)
void	init(java.util.Map<java.lang.String,java.lang.String> params)
boolean	isAvailable()
protected void	resetFileLastModified(java.io.File file)
void	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
void	setStorageGroupId(java.lang.Long storageGroupId)
void	setStorageId(java.lang.Long storageId)
protected void	updateObjectDnx(StoredEntityMetaData storedEntityMetadata, Fixity fixity)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.exlibris.digitool.common.storage.StoragePlugin

checkFixity, deleteEntity, getFullFilePath, getLocalFilePath, retrieveEntity, retrieveEntityByRange, storeEntity

Field Detail

parameters

protected java.util.Map<java.lang.String,java.lang.String> parameters

storageId

protected java.lang.Long storageId

storageGroupId

protected java.lang.Long storageGroupId

Constructor Detail

AbstractStorageHandler

public AbstractStorageHandler()

Method Detail

init

public void init(java.util.Map<java.lang.String,java.lang.String> params)

Specified by:

init in interface StorageHandler

createFileName

protected java.lang.String createFileName(StoredEntityMetaData storedEntityMetadata)

setStorageId

public void setStorageId(java.lang.Long storageId)

Specified by:

setStorageId in interface StorageHandler

setStorageGroupId

public void setStorageGroupId(java.lang.Long storageGroupId)

Specified by:

setStorageGroupId in interface StorageHandler

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

getStorageId

public java.lang.Long getStorageId()

Specified by:

getStorageId in interface StorageHandler

getStorageGroupId

public java.lang.Long getStorageGroupId()

Specified by:

getStorageGroupId in interface StorageHandler

updateObjectDnx

protected void updateObjectDnx(StoredEntityMetaData storedEntityMetadata,
                               Fixity fixity)
                        throws com.exlibris.digitool.exceptions.DigitoolException

Throws:

com.exlibris.digitool.exceptions.DigitoolException

getTempStorageDirectory

protected java.lang.String getTempStorageDirectory()

Use this method to get the location for files to be stored locally, when StoragePlugin.getLocalFilePath(String) is called.

getTempStorageDirectory

protected java.lang.String getTempStorageDirectory(boolean includeStorageId)

isAvailable

public boolean isAvailable()

Specified by:

isAvailable in interface StorageHandler

getChecksumUsingPlugin

protected java.lang.String getChecksumUsingPlugin(java.lang.String filePath,
                                                  java.lang.String pluginName,
                                                  java.lang.String oldFixityValue)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

resetFileLastModified

protected void resetFileLastModified(java.io.File file)

getFullFilePathForFlocat

public java.lang.String getFullFilePathForFlocat(java.lang.String storedEntityIdentifier)

Specified by:

getFullFilePathForFlocat in interface StorageHandler