blackboard.cms.filesystem
Class ContentSystemHelperImpl

java.lang.Object
  blackboard.cms.filesystem.ContentSystemHelperImpl

All Implemented Interfaces:

blackboard.platform.filesystem.ContentSystemHelper

public class ContentSystemHelperImpl
extends java.lang.Object
implements blackboard.platform.filesystem.ContentSystemHelper

Implementation for Content System Helper class.

Since:

Bb 7.2

See Also:

ContentSystemHelper

Nested Class Summary

Nested classes/interfaces inherited from interface blackboard.platform.filesystem.ContentSystemHelper

blackboard.platform.filesystem.ContentSystemHelper.DocstoreLocation

Constructor Summary

ContentSystemHelperImpl()

Method Summary

java.io.File	copyFileToCSWithAutomaticRename(java.lang.String csFileLocation, java.io.File tempDir, java.io.File tempFile)
void	copyLocalFileToCS(java.io.File fileToCopy, java.lang.String destinationDirectory, boolean overwrite) This method wraps a call to CSFileExporter so that all copy methods to and from CS are gathered in one interface.
void	copyToLocalFileSystem(java.lang.String source, java.io.File target) Perists source to designated target.
void	copyToLocalFileSystem(java.lang.String source, java.lang.String target)
blackboard.platform.filesystem.ContentSystemHelper.DocstoreLocation	getDocstoreLocationByPath(java.lang.String location)
java.lang.String	getFileName(java.lang.String path)
long	getFileSize(java.lang.String path)
java.lang.String	getLocation(java.lang.String path) Return the actual location of the file (as in CSEntry.getFullPath() )
void	removePrincipal(java.lang.String principal) Removes references to the provided principal
void	writeToLocalOutputStream(java.lang.String source, java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentSystemHelperImpl

public ContentSystemHelperImpl()

Method Detail

copyToLocalFileSystem

public void copyToLocalFileSystem(java.lang.String source,
                                  java.io.File target)
                           throws blackboard.platform.filesystem.FileSystemException

Perists source to designated target.

Specified by:

copyToLocalFileSystem in interface blackboard.platform.filesystem.ContentSystemHelper

Parameters:

source -

target -

Throws:

blackboard.platform.filesystem.FileSystemException

writeToLocalOutputStream

public void writeToLocalOutputStream(java.lang.String source,
                                     java.io.OutputStream os)
                              throws blackboard.platform.filesystem.FileSystemException

Specified by:

writeToLocalOutputStream in interface blackboard.platform.filesystem.ContentSystemHelper

Throws:

blackboard.platform.filesystem.FileSystemException

copyToLocalFileSystem

public void copyToLocalFileSystem(java.lang.String source,
                                  java.lang.String target)
                           throws blackboard.platform.filesystem.FileSystemException

Specified by:

copyToLocalFileSystem in interface blackboard.platform.filesystem.ContentSystemHelper

Throws:

blackboard.platform.filesystem.FileSystemException

copyLocalFileToCS

public void copyLocalFileToCS(java.io.File fileToCopy,
                              java.lang.String destinationDirectory,
                              boolean overwrite)
                       throws blackboard.platform.filesystem.FileSystemException

This method wraps a call to CSFileExporter so that all copy methods to and from CS are gathered in one interface.

Specified by:

copyLocalFileToCS in interface blackboard.platform.filesystem.ContentSystemHelper

Parameters:

fileToCopy -

destinationDirectory -

overwrite -

Throws:

blackboard.platform.filesystem.FileSystemException

See Also:

FileExporter, CSFileExporter

copyFileToCSWithAutomaticRename

public java.io.File copyFileToCSWithAutomaticRename(java.lang.String csFileLocation,
                                                    java.io.File tempDir,
                                                    java.io.File tempFile)
                                             throws blackboard.platform.filesystem.FileSystemException

Specified by:

copyFileToCSWithAutomaticRename in interface blackboard.platform.filesystem.ContentSystemHelper

Throws:

blackboard.platform.filesystem.FileSystemException

getFileSize

public long getFileSize(java.lang.String path)

Specified by:

getFileSize in interface blackboard.platform.filesystem.ContentSystemHelper

getFileName

public java.lang.String getFileName(java.lang.String path)

Specified by:

getFileName in interface blackboard.platform.filesystem.ContentSystemHelper

getLocation

public java.lang.String getLocation(java.lang.String path)

Return the actual location of the file (as in CSEntry.getFullPath() )

Specified by:

getLocation in interface blackboard.platform.filesystem.ContentSystemHelper

Parameters:

path -

Returns:

removePrincipal

public void removePrincipal(java.lang.String principal)
                     throws blackboard.platform.filesystem.FileSystemException

Removes references to the provided principal

Specified by:

removePrincipal in interface blackboard.platform.filesystem.ContentSystemHelper

Parameters:

principal -

Throws:

blackboard.platform.filesystem.FileSystemException

getDocstoreLocationByPath

public blackboard.platform.filesystem.ContentSystemHelper.DocstoreLocation getDocstoreLocationByPath(java.lang.String location)

Specified by:

getDocstoreLocationByPath in interface blackboard.platform.filesystem.ContentSystemHelper