org.codice.ddf.catalog.content.impl

Class FileSystemStorageProvider

java.lang.Object

org.codice.ddf.catalog.content.impl.FileSystemStorageProvider

All Implemented Interfaces:

StorageProvider

public class FileSystemStorageProvider
extends Object
implements StorageProvider

File system storage provider.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONTENT_REPOSITORY
static String	DEFAULT_CONTENT_STORE
static String	DEFAULT_TMP
static String	KARAF_HOME
static String	REF_EXT

Constructor Summary

Constructors

Constructor and Description
FileSystemStorageProvider() Default constructor, invoked by blueprint.

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTENT_REPOSITORY

public static final String DEFAULT_CONTENT_REPOSITORY

See Also:

Constant Field Values

DEFAULT_CONTENT_STORE

public static final String DEFAULT_CONTENT_STORE

See Also:

Constant Field Values

DEFAULT_TMP

public static final String DEFAULT_TMP

See Also:

Constant Field Values

KARAF_HOME

public static final String KARAF_HOME

See Also:

Constant Field Values

REF_EXT

public static final String REF_EXT

See Also:

Constant Field Values

Constructor Detail

FileSystemStorageProvider

public FileSystemStorageProvider()

Default constructor, invoked by blueprint.

Method Detail

create

public CreateStorageResponse create(CreateStorageRequest createRequest)
                             throws StorageException

Description copied from interface: StorageProvider

Creates an item in the content repository.

Specified by:

create in interface StorageProvider

Parameters:

createRequest - 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

public ReadStorageResponse read(ReadStorageRequest readRequest)
                         throws StorageException

Description copied from interface: StorageProvider

Retrieves a ContentItem from the content repository.

Specified by:

read in interface StorageProvider

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

public UpdateStorageResponse update(UpdateStorageRequest updateRequest)
                             throws StorageException

Description copied from interface: StorageProvider

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.

Specified by:

update in interface StorageProvider

Parameters:

updateRequest - 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

public DeleteStorageResponse delete(DeleteStorageRequest deleteRequest)
                             throws StorageException

Description copied from interface: StorageProvider

Deletes a ContentItem from the content repository.

Specified by:

delete in interface StorageProvider

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

public void commit(StorageRequest request)
            throws StorageException

Description copied from interface: StorageProvider

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

Specified by:

commit in interface StorageProvider

Parameters:

request - the id associated with the request

Throws:

StorageException

rollback

public void rollback(StorageRequest request)
              throws StorageException

Description copied from interface: StorageProvider

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

Specified by:

rollback in interface StorageProvider

Parameters:

request - the id associated with the request

Throws:

StorageException

getMimeTypeMapper

public MimeTypeMapper getMimeTypeMapper()

setMimeTypeMapper

public void setMimeTypeMapper(MimeTypeMapper mimeTypeMapper)

setBaseContentDirectory

public void setBaseContentDirectory(String baseDirectory)
                             throws IOException

Throws:

IOException