Package ddf.catalog.content

Interface StorageProvider

public interface StorageProvider

Provider of content repository storage. All URIs should use the ContentItem.CONTENT_SCHEME

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Method Summary

Modifier and Type	Method	Description
void	commit(StorageRequest id)	Commit will be called by the CatalogFramework to finalize create, update, and delete requests.
CreateStorageResponse	create(CreateStorageRequest createStorageRequest)	Creates an item in the content repository.
DeleteStorageResponse	delete(DeleteStorageRequest deleteRequest)	Deletes a ContentItem from the content repository.
ReadStorageResponse	read(ReadStorageRequest readRequest)	Retrieves a ContentItem from the content repository.
void	rollback(StorageRequest id)	Rollback will be called by the CatalogFramework to discard changes related to create, update, and delete requests
UpdateStorageResponse	update(UpdateStorageRequest updateStorageRequest)	Updates a ContentItem in the content repository.

Method Details

create

CreateStorageResponse create(CreateStorageRequest createStorageRequest)
                      throws StorageException

Creates an item in the content repository.

Parameters:

createStorageRequest - the CreateStorageRequest that contains the ContentItem to be stored/created in the content repository. The ID of the ContentItem will be auto-generated by the StorageProvider.

Returns:

the CreateStorageResponse that contains the ContentItem created by the StorageProvider in the content repository. This ContentItem will contain the GUID assigned by the StorageProvider. This GUID will be used in subsequent UpdateStorageRequest, ReadStorageRequest, and DeleteStorageRequest to access the stored ContentItem.

Throws:

StorageException - if any problems encountered while creating/storing the ContentItem

read

ReadStorageResponse read(ReadStorageRequest readRequest)
                  throws StorageException

Retrieves a ContentItem from the content repository.

Parameters:

readRequest - the ReadStorageRequest that contains the GUID of the ContentItem to be retrieved

Returns:

the ReadStorageResponse that contains the ContentItem retrieved by the StorageProvider from the content repository.

Throws:

StorageException - if any problems encountered while retrieving the ContentItem

update

UpdateStorageResponse update(UpdateStorageRequest updateStorageRequest)
                      throws StorageException

Updates a ContentItem in the content repository. The ContentItem must already exist in the content repository in order to be updated. The StorageProvider will not automatically create the ContentItem if it does not exist.

Parameters:

updateStorageRequest - the UpdateStorageRequest that contains the GUID of the ContentItem to be updated and the InputStream with the new data to overwrite the existing ContentItem in the content repository.

Returns:

the UpdateStorageResponse that contains the ContentItem updated by the StorageProvider in the content repository.

Throws:

StorageException - if any problems encountered while updating the ContentItem

delete

DeleteStorageResponse delete(DeleteStorageRequest deleteRequest)
                      throws StorageException

Deletes a ContentItem from the content repository.

Parameters:

deleteRequest - the DeleteStorageRequest that contains the GUID of the ContentItem to be deleted.

Returns:

the DeleteStorageResponse that contains the status of the deletion of the ContentItem from the content repository.

Throws:

StorageException - if any problems encountered while deleting the ContentItem

commit

void commit(StorageRequest id)
     throws StorageException

Commit will be called by the CatalogFramework to finalize create, update, and delete requests.

Parameters:

id - the id associated with the request

Throws:

StorageException

rollback

void rollback(StorageRequest id)
       throws StorageException

Rollback will be called by the CatalogFramework to discard changes related to create, update, and delete requests

Parameters:

id - the id associated with the request

Throws:

StorageException