blackboard.platform.filesystem
Interface FileSystemService

public interface FileSystemService

Interface for FileSystemServiceImpl class.

Since:

Bb 5.5

Version:

$Revision: 3 $ $Date: 12/08/03 5:32p $

See Also:

FileSystemServiceImpl

Method Summary

java.io.File	getApplicationDirectory() Returns the root of the application directory for persistant files.
java.io.File	getAttemptDirectory(Course course, Id attemptId, AttemptFile.FileType fileType) Returns the root directory relative to the course and attempt id.
java.io.File	getAttemptDirectory(java.lang.String courseId, Id attemptId, AttemptFile.FileType fileType) Returns the root directory relative to the course and attempt id.
java.io.File	getBrandingDirectory(Id portalBrandingId) Returns the root directory relative to the branding for given host.
java.io.File	getContentDirectory(Course course, Id contentId) Returns the root directory relative to the course and content id.
java.io.File	getContentDirectory(java.lang.String courseId, Id contentId) Returns the root directory relative to the course and content id.
java.io.File	getCourseDirectory(Course course) Returns the root directory relative to the course.
java.io.File	getCourseDirectory(java.lang.String courseId) Returns the root directory relative to the course.
java.io.File	getLogsDirectory() Returns the root of the logs directory for use within application.
java.io.File	getRecycleDirectory() Returns the root directory of the "recycle bin" for the application.
java.io.File	getRootCourseDirectory() Returns the root directory that all courses are stored in
java.io.File	getSessionDirectory() Returns the root of the session directory registered for the application.
java.io.File	getSponsorsDirectory(Id sponsorsId) Returns the root directory relative to the sponsors for given id.
java.io.File	getTempDirectory() Returns a temp directory for use within application.
java.io.File	getVIDataDirectory() Returns the root of the content directory.
java.io.File	getVIDataDirectory(VirtualInstallation vi) Returns the root of the content directory.
java.io.File	getVISystemDataDirectory() Returns the root of the systemdata directory.
java.lang.String	getWebAttemptDirectory(Course course, Id attemptId, AttemptFile.FileType fileType) Returns the web based root directory relative to the course and attempt id.
java.lang.String	getWebAttemptDirectory(java.lang.String courseId, Id attemptId, AttemptFile.FileType fileType) Returns the web based root directory relative to the course and attempt id.
java.lang.String	getWebBrandingDirectory(Id portalBrandingId) Returns the web based root directory relative to the branding for given host.
java.lang.String	getWebContentDirectory(Course course, Id contentId) Returns the web based root directory relative to the course and content id.
java.lang.String	getWebContentDirectory(java.lang.String courseId, Id contentId) Returns the web based root directory relative to the course and content id.
java.lang.String	getWebCourseDirectory(Course course) Returns the web-root based directory path to the course.
java.lang.String	getWebCourseDirectory(java.lang.String courseId) Returns the web-root based directory path to the course.
java.lang.String	getWebSessionDirectory() Returns the web based root of the session directory registered for the application.
java.lang.String	getWebSponsorsDirectory(Id sponsorsId) Returns the web based root directory relative to the branding for given host.
java.lang.String	getWebVIDataDirectory() Deprecated. This method never worked, because it points to an unavailable directory
java.lang.String	getWebVIDataDirectory(VirtualInstallation vi) Deprecated. This method never worked, because it points to an unavailable directory
java.lang.String	getWebVISystemDataDirectory() Returns the web based root of the systemdata directory.
MultipartRequest	processUpload(javax.servlet.http.HttpServletRequest req) Reads the file from the multipart stream and saves out the stream as a File.

Method Detail

getCourseDirectory

public java.io.File getCourseDirectory(java.lang.String courseId)
                                throws FileSystemException

Returns the root directory relative to the course.

FileSystemException

getCourseDirectory

public java.io.File getCourseDirectory(Course course)
                                throws FileSystemException

Returns the root directory relative to the course.

Parameters:

course - Course

FileSystemException

getWebCourseDirectory

public java.lang.String getWebCourseDirectory(java.lang.String courseId)
                                       throws FileSystemException

Returns the web-root based directory path to the course.

Parameters:

courseId - The ID of the course desired

FileSystemException

getWebCourseDirectory

public java.lang.String getWebCourseDirectory(Course course)
                                       throws FileSystemException

Returns the web-root based directory path to the course.

Parameters:

course - The Course desired

FileSystemException

getRootCourseDirectory

public java.io.File getRootCourseDirectory()
                                    throws FileSystemException

Returns the root directory that all courses are stored in

FileSystemException

getWebContentDirectory

public java.lang.String getWebContentDirectory(java.lang.String courseId,
                                               Id contentId)
                                        throws FileSystemException

Returns the web based root directory relative to the course and content id.

FileSystemException

getWebContentDirectory

public java.lang.String getWebContentDirectory(Course course,
                                               Id contentId)
                                        throws FileSystemException

Returns the web based root directory relative to the course and content id.

Parameters:

course - Course

FileSystemException

getContentDirectory

public java.io.File getContentDirectory(java.lang.String courseId,
                                        Id contentId)
                                 throws FileSystemException

Returns the root directory relative to the course and content id.

FileSystemException

getContentDirectory

public java.io.File getContentDirectory(Course course,
                                        Id contentId)
                                 throws FileSystemException

Returns the root directory relative to the course and content id.

FileSystemException

getWebAttemptDirectory

public java.lang.String getWebAttemptDirectory(java.lang.String courseId,
                                               Id attemptId,
                                               AttemptFile.FileType fileType)
                                        throws FileSystemException

Returns the web based root directory relative to the course and attempt id.

FileSystemException

getWebAttemptDirectory

public java.lang.String getWebAttemptDirectory(Course course,
                                               Id attemptId,
                                               AttemptFile.FileType fileType)
                                        throws FileSystemException

Returns the web based root directory relative to the course and attempt id.

Parameters:

course - Course

FileSystemException

getAttemptDirectory

public java.io.File getAttemptDirectory(java.lang.String courseId,
                                        Id attemptId,
                                        AttemptFile.FileType fileType)
                                 throws FileSystemException

Returns the root directory relative to the course and attempt id.

FileSystemException

getAttemptDirectory

public java.io.File getAttemptDirectory(Course course,
                                        Id attemptId,
                                        AttemptFile.FileType fileType)
                                 throws FileSystemException

Returns the root directory relative to the course and attempt id.

FileSystemException

getBrandingDirectory

public java.io.File getBrandingDirectory(Id portalBrandingId)
                                  throws FileSystemException

Returns the root directory relative to the branding for given host.

FileSystemException

getWebBrandingDirectory

public java.lang.String getWebBrandingDirectory(Id portalBrandingId)
                                         throws FileSystemException

Returns the web based root directory relative to the branding for given host.

FileSystemException

getSponsorsDirectory

public java.io.File getSponsorsDirectory(Id sponsorsId)
                                  throws FileSystemException

Returns the root directory relative to the sponsors for given id.

FileSystemException

getWebSponsorsDirectory

public java.lang.String getWebSponsorsDirectory(Id sponsorsId)
                                         throws FileSystemException

Returns the web based root directory relative to the branding for given host.

FileSystemException

getVIDataDirectory

public java.io.File getVIDataDirectory()
                                throws FileSystemException

Returns the root of the content directory.

FileSystemException

getVIDataDirectory

public java.io.File getVIDataDirectory(VirtualInstallation vi)
                                throws FileSystemException

Returns the root of the content directory.

Parameters:

vi - VirtualInstallation to be used in directory

FileSystemException

getWebVIDataDirectory

public java.lang.String getWebVIDataDirectory()
                                       throws FileSystemException

Deprecated. This method never worked, because it points to an unavailable directory

Returns the web based root of the content directory.

FileSystemException

getWebVIDataDirectory

public java.lang.String getWebVIDataDirectory(VirtualInstallation vi)
                                       throws FileSystemException

Deprecated. This method never worked, because it points to an unavailable directory

Returns the web based root of the content directory.

Parameters:

vi - VirtualInstallation to be used in directory

FileSystemException

getVISystemDataDirectory

public java.io.File getVISystemDataDirectory()
                                      throws FileSystemException

Returns the root of the systemdata directory.

FileSystemException

getWebVISystemDataDirectory

public java.lang.String getWebVISystemDataDirectory()
                                             throws FileSystemException

Returns the web based root of the systemdata directory.

FileSystemException

getSessionDirectory

public java.io.File getSessionDirectory()
                                 throws FileSystemException

Returns the root of the session directory registered for the application.

FileSystemException

getWebSessionDirectory

public java.lang.String getWebSessionDirectory()
                                        throws FileSystemException

Returns the web based root of the session directory registered for the application.

FileSystemException

getApplicationDirectory

public java.io.File getApplicationDirectory()
                                     throws FileSystemException

Returns the root of the application directory for persistant files.

FileSystemException

getTempDirectory

public java.io.File getTempDirectory()
                              throws FileSystemException

Returns a temp directory for use within application.

FileSystemException

getLogsDirectory

public java.io.File getLogsDirectory()
                              throws FileSystemException

Returns the root of the logs directory for use within application.

FileSystemException

getRecycleDirectory

public java.io.File getRecycleDirectory()
                                 throws FileSystemException

Returns the root directory of the "recycle bin" for the application. Items in this directory can be periodically removed from the file system after one day.

FileSystemException

processUpload

public MultipartRequest processUpload(javax.servlet.http.HttpServletRequest req)
                               throws java.io.IOException

Reads the file from the multipart stream and saves out the stream as a File. Once this method is invoked, it keeps reading from the stream until it reads the boundary line.

Throws:

java.io.IOException - thrown if the underlying io objects complain