Package fr.gouv.vitam.storage.offers.tape.cas

Class TapeLibraryContentAddressableStorage

java.lang.Object

fr.gouv.vitam.storage.offers.tape.cas.TapeLibraryContentAddressableStorage

All Implemented Interfaces:

VitamAutoCloseable, ContentAddressableStorage, AutoCloseable

public class TapeLibraryContentAddressableStorage
extends Object
implements ContentAddressableStorage

Constructor Summary

Constructors

Constructor

Description

TapeLibraryContentAddressableStorage(BasicFileStorage basicFileStorage, ObjectReferentialRepository objectReferentialRepository, ArchiveReferentialRepository archiveReferentialRepository, AccessRequestManager accessRequestManager, FileBucketTarCreatorManager fileBucketTarCreatorManager, ArchiveCacheStorage archiveCacheStorage, ArchiveCacheEvictionController archiveCacheEvictionController, BucketTopologyHelper bucketTopologyHelper)

Method Summary

Modifier and Type	Method	Description
Map<String,AccessRequestStatus>	checkAccessRequestStatuses(List<String> accessRequestIds, boolean adminCrossTenantAccessRequestAllowed)	Checks status of access requests by id.
boolean	checkObjectAvailability(String containerName, List<String> objectNames)	Check object availability for async offers.
void	checkObjectDigestAndStoreDigest(String containerName, String objectName, String objectDigest, DigestType digestType, long size)	Checks objet digest & update persist its digest in object metadata
void	close()
String	createAccessRequest(String containerName, List<String> objectsNames)	Create an access request for objects (asynchronous read from tape to local FS).
void	createContainer(String containerName)	Creates a container
void	deleteObject(String containerName, String objectName)	Deletes a object representing the data at location containerName/objectName
ContainerInformation	getContainerInformation(String containerName)	Get container information like capacity
ObjectContent	getObject(String containerName, String objectName)	Retrieves an object representing the data at location containerName/objectName
String	getObjectDigest(String containerName, String objectName, DigestType algo, boolean noCache)	compute Object Digest using a defined algorithm
MetadatasObject	getObjectMetadata(String containerName, String objectName, boolean noCache)	get metadata of the object
boolean	isExistingContainer(String containerName)	Determines if a container exists
boolean	isExistingObject(String containerName, String objectName)	Determines if an object exists
void	listContainer(String containerName, ObjectListingListener objectListingListener)	List container objects
void	removeAccessRequest(String accessRequestId, boolean adminCrossTenantAccessRequestAllowed)	Delete access request.
void	writeObject(String containerName, String objectName, InputStream inputStream, DigestType digestType, long size)	Adds an object representing the data at location containerName/objectName

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.gouv.vitam.common.storage.cas.container.api.ContentAddressableStorage

putObject

Constructor Details

TapeLibraryContentAddressableStorage

public TapeLibraryContentAddressableStorage(BasicFileStorage basicFileStorage,
 ObjectReferentialRepository objectReferentialRepository,
 ArchiveReferentialRepository archiveReferentialRepository,
 AccessRequestManager accessRequestManager,
 FileBucketTarCreatorManager fileBucketTarCreatorManager,
 ArchiveCacheStorage archiveCacheStorage,
 ArchiveCacheEvictionController archiveCacheEvictionController,
 BucketTopologyHelper bucketTopologyHelper)

Method Details

createContainer

public void createContainer(String containerName)

Description copied from interface: ContentAddressableStorage

Creates a container

Specified by:

createContainer in interface ContentAddressableStorage

Parameters:

containerName - name of container to create

isExistingContainer

public boolean isExistingContainer(String containerName)

Description copied from interface: ContentAddressableStorage

Determines if a container exists

Specified by:

isExistingContainer in interface ContentAddressableStorage

Parameters:

containerName - name of container

Returns:

boolean type

writeObject

public void writeObject(String containerName,
 String objectName,
 InputStream inputStream,
 DigestType digestType,
 long size)
                 throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

Adds an object representing the data at location containerName/objectName

Specified by:

writeObject in interface ContentAddressableStorage

Parameters:

containerName - container to place the object.

objectName - fully qualified object name relative to the container.

inputStream - the data

digestType - parameter to compute an hash.

size - size off the input stream

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageException - Thrown when put action failed due some other failure

ContentAddressableStorageAlreadyExistException - Thrown when object creating exists

checkObjectDigestAndStoreDigest

public void checkObjectDigestAndStoreDigest(String containerName,
 String objectName,
 String objectDigest,
 DigestType digestType,
 long size)

Description copied from interface: ContentAddressableStorage

Checks objet digest & update persist its digest in object metadata

Specified by:

checkObjectDigestAndStoreDigest in interface ContentAddressableStorage

Parameters:

containerName - container to place the object.

objectName - fully qualified object name relative to the container.

objectDigest - object digest value

digestType - object digest type

size - size off the input stream

getObject

public ObjectContent getObject(String containerName,
 String objectName)
                        throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

Retrieves an object representing the data at location containerName/objectName

Specified by:

getObject in interface ContentAddressableStorage

Parameters:

containerName - container where this exists.

objectName - fully qualified name relative to the container.

Returns:

the object you intended to receive

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located.

ContentAddressableStorageUnavailableDataFromAsyncOfferException - Thrown when object cannot be read due to missing access request on AsyncRead ContentAddressableStorage

ContentAddressableStorageException - Thrown when get action failed due some other failure

createAccessRequest

public String createAccessRequest(String containerName,
 List<String> objectsNames)
                           throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

Create an access request for objects (asynchronous read from tape to local FS). Return access request identifier

Specified by:

createAccessRequest in interface ContentAddressableStorage

Parameters:

containerName - container where this exists.

objectsNames - list of objects names for which access is requested

Returns:

access request identifier

Throws:

ContentAddressableStorageException

checkAccessRequestStatuses

public Map<String,AccessRequestStatus> checkAccessRequestStatuses(List<String> accessRequestIds,
 boolean adminCrossTenantAccessRequestAllowed)
                                                           throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

Checks status of access requests by id.

Specified by:

checkAccessRequestStatuses in interface ContentAddressableStorage

Parameters:

accessRequestIds - the identifiers of the access requests to check

adminCrossTenantAccessRequestAllowed - when true, access to access requests of other tenants is allowed from Admin tenant

Returns:

AccessRequestStatus representing access request status

Throws:

ContentAddressableStorageException

removeAccessRequest

public void removeAccessRequest(String accessRequestId,
 boolean adminCrossTenantAccessRequestAllowed)
                         throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

Delete access request. Ignored if no access request found (not exists, expired or already canceled).

Specified by:

removeAccessRequest in interface ContentAddressableStorage

Parameters:

accessRequestId - the identifier of the access request to cancel.

adminCrossTenantAccessRequestAllowed - when true, removing access requests of other tenants is allowed from Admin tenant

Throws:

ContentAddressableStorageException

checkObjectAvailability

public boolean checkObjectAvailability(String containerName,
 List<String> objectNames)
                                throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

Check object availability for async offers.

Specified by:

checkObjectAvailability in interface ContentAddressableStorage

Parameters:

containerName - container where this exists.

objectNames - list of objects names for which availability is to be checked.

Returns:

true if ALL objects are available, otherwise false.

Throws:

ContentAddressableStorageException

deleteObject

public void deleteObject(String containerName,
 String objectName)
                  throws ContentAddressableStorageServerException,
ContentAddressableStorageNotFoundException

Description copied from interface: ContentAddressableStorage

Deletes a object representing the data at location containerName/objectName

Specified by:

deleteObject in interface ContentAddressableStorage

Parameters:

containerName - container where this exists.

objectName - fully qualified name relative to the container.

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container cannot be located or the blob cannot be located in the container.

ContentAddressableStorageServerException

isExistingObject

public boolean isExistingObject(String containerName,
 String objectName)
                         throws ContentAddressableStorageServerException

Description copied from interface: ContentAddressableStorage

Determines if an object exists

Specified by:

isExistingObject in interface ContentAddressableStorage

Parameters:

containerName - container where the object resides

objectName - fully qualified name relative to the container.

Returns:

boolean type

Throws:

ContentAddressableStorageServerException - Thrown when internal server error happens

getObjectDigest

public String getObjectDigest(String containerName,
 String objectName,
 DigestType algo,
 boolean noCache)
                       throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

compute Object Digest using a defined algorithm

Specified by:

getObjectDigest in interface ContentAddressableStorage

Parameters:

containerName - container where this exists.

objectName - fully qualified name relative to the container.

algo - Digest algo

noCache - forces full digest computation

Returns:

the digest object as String

Throws:

ContentAddressableStorageNotFoundException - Thrown when the container or the object cannot be located

ContentAddressableStorageServerException - Thrown when internal server error happens

ContentAddressableStorageException - Thrown when put action failed due some other failure

getContainerInformation

public ContainerInformation getContainerInformation(String containerName)

Description copied from interface: ContentAddressableStorage

Get container information like capacity

Specified by:

getContainerInformation in interface ContentAddressableStorage

Parameters:

containerName - the container name

Returns:

container information like usableSpace

getObjectMetadata

public MetadatasObject getObjectMetadata(String containerName,
 String objectName,
 boolean noCache)
                                  throws ContentAddressableStorageException

Description copied from interface: ContentAddressableStorage

get metadata of the object

Specified by:

getObjectMetadata in interface ContentAddressableStorage

Parameters:

containerName - the container name

objectName - the objectId to check

Returns:

MetadatasObjectResult

Throws:

ContentAddressableStorageException - Thrown when get action failed due some other failure

listContainer

public void listContainer(String containerName,
 ObjectListingListener objectListingListener)
                   throws ContentAddressableStorageServerException,
IOException

Description copied from interface: ContentAddressableStorage

List container objects

Specified by:

listContainer in interface ContentAddressableStorage

Parameters:

containerName - the container name

Throws:

ContentAddressableStorageServerException - Thrown when internal server error happens

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface VitamAutoCloseable