Package org.olat.core.util.vfs

Virtual File System (VFS) code examples

See:
Description

Interface Summary

OlatRelPathImpl
Quota	Description: TODO: HP_Besitzer Class Description for QuotaImpl
VFSContainer	Description: TODO: Felix Jost Class Description for VFSContainer
VFSItem	Description: TODO: Felix Jost Class Description for VFSItem
VFSLeaf	Description: VFSLeaf: A file that can be written to, read from

Class Summary

AbstractVirtualContainer	Description: TODO: Felix Jost Class Description for VirtualContainer
LocalFileImpl	Description: VFSLeaf implementation that is based on a java.io.File from a local filesystem
LocalFolderImpl	Description: VFSContainer implementation that is based on a java.io.File from a local filesystem.
LocalImpl	Description: TODO: Felix Jost Class Description for LocalImpl
MergeSource	Description: TODO: Felix Jost Class Description for MultiSource
NamedContainerImpl	Description: TODO: Felix Jost Class Description for VirtualContainerImpl
NamedLeaf	Description:
QuotaManager	Initial Date: Feb 17, 2004
StreamedImpl	Description: TODO: Felix Jost Class Description for StreamedImpl
VFSConstants	Description: TODO: Felix Jost Class Description for Constants
VFSLeafHandler	Description: Log handler that logs to a virtual file system leaf.
VFSManager
VFSManagerTest	Description: TODO: patrickb Class Description for VFSManagerTest
VFSMediaResource
VFSRevisionMediaResource
VFSStatus	Description: TODO: Felix Jost Class Description for VFSStatus
VFSTestMain	Description: TODO: Felix Jost Class Description for Test
VirtualContainer

Package org.olat.core.util.vfs Description

Virtual File System (VFS) code examples

The virtial file system allows the same operations as you are may know form java.io but names and behavior are a bit different. See techdocu for an introduction to the VFS.

• Find a file or folder vfs style: If you are sure it is a folder you can resolve and cast it immediatly

  VFSContainer folder = (VFSContainer) wikiContainer.resolve(WIKI_FOLDER_NAME);

  if you are not shure whether it is a file or a folder you get an VFSItem as result of a resolve operatin and have to check with:

     
                  if (item instanceof VFSLeaf) {
                          VFSLeaf leaf = (VFSLeaf)item;
                  }
                  TODO:Add methods like isLeaf() or isContainer() to item.
                  

• Get a folder in the OLAT bcroot/repository hierarchie:

  VFSContainer rootContainer = FileResourceManager.getInstance().getFileResourceRootImpl(ores);

  TODO: Create proper factory that delivers Containers,
• To write of read from a vfs file you have to get the OutputStream from the leave where your can read of write with support of the FileUtils class:

                  VFSLeaf leaf = wikiContentContainer.createChildLeaf(filename);
                  FileUtils.save(leaf.getOutputStream(false), content, "utf-8");
                  

• Reading content of a file

                  VFSLeaf leaf = (VFSLeaf) folder.resolve(page.getPageId() + "." + WikiManager.WIKI_FILE_SUFFIX);
                  page.setContent(FileUtils.load(leaf.getInputStream(), "utf-8"));
                  

Getting a list of files with a specific file ending

List propertyLeafs = wikiCtn.getItems(new VFSItemSuffixFilter(new String[] { WikiManager.WIKI_PROPERTIES_SUFFIX }));

• Creating a subfolder

  rootContainer.createChildContainer(WIKI_RESOURCE_FOLDER_NAME)

• Creating a file in a folder

  VFSLeaf leaf = wikiContentContainer.createChildLeaf(page.getPageId());

The VFS can also be used to create a collection of containers that are merged virtually to offer some folders in a view which is not physically the same on the filesystem. Similar to the use of symlinks in a unix environnement. @see org.olat.modules.bc.BriefcaseWebDAVProvider

TODO:how to create an initial container out form a path??? creating an Impl, This need to be refactored to use the Abstract type VFSContainer through out olat