org.olat.fileresource
Class FileResourceManager

java.lang.Object
  extended by org.olat.fileresource.FileResourceManager

public class FileResourceManager
extends java.lang.Object

Initial Date: Apr 8, 2004

Author:
Mike Stock

Field Summary
static java.lang.String ZIPDIR
           
 
Method Summary
 FileResource addFileResource(java.io.File fResource, java.lang.String newName)
           
 FileResource addFileResource(java.io.File fResource, java.lang.String newName, FileResource knownResource)
          Add a file resource if the resource type is already known.
 OLATResourceable createCopy(OLATResourceable res)
          Creates a copy of the given resourceable.
 OLATResourceable createCopy(OLATResourceable res, java.lang.String resourceFolderName)
          Creates a copy of the given resourceable.
 void deleteFileResource(OLATResourceable res)
           
 boolean deleteUnzipContent(OLATResourceable res)
          Deletes the contents of the last unzip operation.
 MediaResource getAsDownloadeableMediaResource(OLATResourceable res)
           
 Component getDetailsComponent(OLATResourceable res, java.util.Locale locale)
           
 java.io.File getFileResource(OLATResourceable res)
           
 java.io.File getFileResourceRoot(OLATResourceable res)
           
 OlatRootFolderImpl getFileResourceRootImpl(OLATResourceable res)
           
static FileResourceManager getInstance()
           
 java.lang.String getUnzippedDirRel(OLATResourceable res)
           
 java.io.File unzipFileResource(OLATResourceable res)
          Unzips a resource and returns the unzipped folder's root.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ZIPDIR

public static final java.lang.String ZIPDIR
See Also:
Constant Field Values
Method Detail

getInstance

public static final FileResourceManager getInstance()
Returns:
Singleton.

addFileResource

public FileResource addFileResource(java.io.File fResource,
                                    java.lang.String newName,
                                    FileResource knownResource)
                             throws AddingResourceException
Add a file resource if the resource type is already known.

Parameters:
fResource -
newName -
knownResource - maybe null, FileResource type will be calculated
Returns:
True upon success, false otherwise.
Throws:
AddingResourceException

addFileResource

public FileResource addFileResource(java.io.File fResource,
                                    java.lang.String newName)
                             throws AddingResourceException
Parameters:
fResource -
newName -
Returns:
Newly created file resource
Throws:
AddingResourceException

deleteFileResource

public void deleteFileResource(OLATResourceable res)
Parameters:
res -

getFileResourceRoot

public java.io.File getFileResourceRoot(OLATResourceable res)
Parameters:
res -
Returns:
Canonical root of file resource

getFileResourceRootImpl

public OlatRootFolderImpl getFileResourceRootImpl(OLATResourceable res)
Parameters:
res -
Returns:
olat root folder implementation of file resource

getFileResource

public java.io.File getFileResource(OLATResourceable res)
Parameters:
res -
Returns:
Get resourceable as file.

getAsDownloadeableMediaResource

public MediaResource getAsDownloadeableMediaResource(OLATResourceable res)
Parameters:
res -
Returns:
File resource as downloadeable media resource.

getUnzippedDirRel

public java.lang.String getUnzippedDirRel(OLATResourceable res)
Parameters:
res -
Returns:
Directory wherer unzipped files of file resourcea are located.

unzipFileResource

public java.io.File unzipFileResource(OLATResourceable res)
Unzips a resource and returns the unzipped folder's root.

Parameters:
res -
Returns:
Unzip contents of ZIP file resource.

deleteUnzipContent

public boolean deleteUnzipContent(OLATResourceable res)
Deletes the contents of the last unzip operation.

Parameters:
res -
Returns:
True upon success.

getDetailsComponent

public Component getDetailsComponent(OLATResourceable res,
                                     java.util.Locale locale)
Parameters:
res -
locale -
Returns:
Components displaying details of a file resource.

createCopy

public OLATResourceable createCopy(OLATResourceable res)
Creates a copy of the given resourceable.

Parameters:
res -
Returns:
Copy of the given resource.

createCopy

public OLATResourceable createCopy(OLATResourceable res,
                                   java.lang.String resourceFolderName)
Creates a copy of the given resourceable.

Parameters:
res -
Returns:
Copy of the given resource.