edu.illinois.ncsa.domain

Interface FileStorage

All Known Implementing Classes:

FileStorageClowder, FileStorageDisk, IncoreFileStorage

public interface FileStorage

This interface allows files to be saved, read and deleted for different storage implementations.

Author:

Rob Kooper

Method Summary

Modifier and Type	Method and Description
boolean	deleteFile(FileDescriptor fd) Deletes file from storage
boolean	deleteFile(FileDescriptor fd, Person creator) Deletes file from storage
InputStream	readFile(FileDescriptor fd) Read file from storage
URL	storeFile(FileDescriptor fd, InputStream is) Store file in file storage system
FileDescriptor	storeFile(InputStream is) Store file in file storage system
FileDescriptor	storeFile(String filename, InputStream is) Store file in file storage system
FileDescriptor	storeFile(String filename, InputStream is, Person creator, Dataset ds) Store file in file storage system
FileDescriptor	storeFile(String id, String filename, InputStream is) Store file in file storage system
FileDescriptor	storeFile(String id, String filename, InputStream is, Person creator, Dataset ds) Store file in file storage system

Method Detail

storeFile

FileDescriptor storeFile(InputStream is)
                  throws IOException

Store file in file storage system

Parameters:

is - - inputstream of the file to store

Returns:

FileDescriptor for the stored file

Throws:

IOException - if an I/O error occurs

storeFile

FileDescriptor storeFile(String filename,
                         InputStream is)
                  throws IOException

Store file in file storage system

Parameters:

filename - - name of the file

is - - inputstream of the file to store

Returns:

FileDescriptor for the stored file

Throws:

IOException - if an I/O error occurs

storeFile

FileDescriptor storeFile(String filename,
                         InputStream is,
                         Person creator,
                         Dataset ds)
                  throws IOException

Store file in file storage system

Parameters:

filename - - name of the file

is - - inputstream of the file to store

creator - - file creator

ds - - dataset to attach file to

Returns:

FileDescriptor for the stored file

Throws:

IOException - if an I/O error occurs

storeFile

URL storeFile(FileDescriptor fd,
              InputStream is)
       throws IOException

Store file in file storage system

Parameters:

fd - - file descriptor to store the file with

is - - inputstream of the file to store

Returns:

URL of stored file

Throws:

IOException - if an I/O error occurs

storeFile

FileDescriptor storeFile(String id,
                         String filename,
                         InputStream is)
                  throws IOException

Store file in file storage system

Parameters:

id - - descriptor id to store the file with

filename - - name of the file

is - - inputstream of the file to store

Returns:

FileDescriptor for the stored file

Throws:

IOException - if an I/O error occurs

storeFile

FileDescriptor storeFile(String id,
                         String filename,
                         InputStream is,
                         Person creator,
                         Dataset ds)
                  throws IOException

Store file in file storage system

Parameters:

id - - descriptor id to store the file with

filename - - name of the file

is - - inputstream of the file to store

creator - - file creator

ds - - dataset to attach file to

Returns:

FileDescriptor for the stored file

Throws:

IOException - if an I/O error occurs

readFile

InputStream readFile(FileDescriptor fd)
              throws IOException

Read file from storage

Parameters:

fd - FileDescriptor of file to read

Returns:

Inpustream of the file

Throws:

IOException - if an I/O error occurs

deleteFile

boolean deleteFile(FileDescriptor fd)

Deletes file from storage

Parameters:

fd - - File descriptor representing the file to delete

Returns:

true if the delete operation was successful.

deleteFile

boolean deleteFile(FileDescriptor fd,
                   Person creator)

Deletes file from storage

Parameters:

fd - - File descriptor representing the file to delete

creator - - file creator

Returns:

true if the delete operation was successful.