|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.jetspeed.page.document.psml.FileSystemFolderHandler
public class FileSystemFolderHandler
FileSystemFolderHandler
Implementation of FolderHanlder
that is based off of the file
system.
Nested Class Summary | |
---|---|
class |
FileSystemFolderHandler.DocumentTypeFilter
|
Field Summary | |
---|---|
protected static java.io.FilenameFilter |
FOLDER_FILTER
|
Constructor Summary | |
---|---|
FileSystemFolderHandler(java.lang.String documentRoot,
DocumentHandlerFactory handlerFactory,
FileCache fileCache)
|
Method Summary | |
---|---|
protected void |
addToCache(java.lang.String id,
java.lang.Object objectToCache)
addToCache |
void |
evict(FileCacheEntry entry)
evict |
protected java.lang.String[] |
getChildrenNames(java.lang.String path,
java.io.FilenameFilter filter)
|
Folder |
getFolder(java.lang.String path)
getFolder |
Folder |
getFolder(java.lang.String path,
boolean fromCache)
getFolder |
NodeSet |
getFolders(java.lang.String path)
getFolders |
NodeSet |
getNodes(java.lang.String path,
boolean regexp,
java.lang.String documentType)
getChildNodes |
boolean |
isFolder(java.lang.String path)
Returns true if the path is a folder |
java.lang.String[] |
list(java.lang.String folderPath,
java.lang.String documentType)
list |
java.lang.String[] |
listAll(java.lang.String folderPath)
listAll |
void |
refresh(FileCacheEntry entry)
refresh |
void |
removeFolder(Folder folder)
removeFolder |
void |
updateFolder(Folder folder)
updateFolder |
protected void |
verifyPath(java.io.File path)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.io.FilenameFilter FOLDER_FILTER
Constructor Detail |
---|
public FileSystemFolderHandler(java.lang.String documentRoot, DocumentHandlerFactory handlerFactory, FileCache fileCache) throws java.io.FileNotFoundException, UnsupportedDocumentTypeException
documentRoot
- directory on file system to use as the root when locating
foldershandlerFactory
- A DocumentHandlerFactory
fileCache
- For caching folder instances
java.io.FileNotFoundException
- if the documentRoot
does not exist
UnsupportedDocumentTypeException
- if no DocumentHnadler
could be found that
supports folder metadata (folder.metadata) in the
handlerFactory
.Method Detail |
---|
public Folder getFolder(java.lang.String path) throws FolderNotFoundException, InvalidFolderException, NodeException
getFolder
getFolder
in interface FolderHandler
path
-
FolderNotFoundException
InvalidFolderException
NodeException
DocumentNotFoundException
DocumentException
- if there was an error processing the request.FolderHandler.getFolder(java.lang.String)
protected void verifyPath(java.io.File path) throws java.io.FileNotFoundException
java.io.FileNotFoundException
public Folder getFolder(java.lang.String path, boolean fromCache) throws NodeException, FolderNotFoundException, InvalidFolderException
getFolder
getFolder
in interface FolderHandler
path
- fromCache
-
InvalidFolderException
DocumentNotFoundException
DocumentException
- if there was an error processing the request.
NodeException
FolderNotFoundException
FolderHandler.getFolder(java.lang.String,
boolean)
public void updateFolder(Folder folder) throws FailedToUpdateFolderException
updateFolder
updateFolder
in interface FolderHandler
folder
-
FailedToUpdateFolderException
FolderHandler.updateFolder(org.apache.jetspeed.om.folder.Folder)
public void removeFolder(Folder folder) throws FailedToDeleteFolderException
removeFolder
removeFolder
in interface FolderHandler
folder
-
FailedToDeleteFolderException
FolderHandler.removeFolder(org.apache.jetspeed.om.folder.Folder)
public NodeSet getFolders(java.lang.String path) throws FolderNotFoundException, InvalidFolderException, NodeException
getFolders
getFolders
in interface FolderHandler
path
-
FolderNotFoundException
InvalidFolderException
NodeException
DocumentException
- if an error is encountered reading the folders.FolderHandler.getFolders(java.lang.String)
public java.lang.String[] list(java.lang.String folderPath, java.lang.String documentType) throws FolderNotFoundException
list
list
in interface FolderHandler
documentType
- folderPath
- folder path to search under
FolderNotFoundException
- if the folderPath
does not exsit.org.apache.jetspeed.page.document.FolderHandler#list(java.lang.String)
public java.lang.String[] listAll(java.lang.String folderPath) throws FolderNotFoundException
listAll
listAll
in interface FolderHandler
folderPath
-
FolderNotFoundException
FolderHandler.listAll(java.lang.String)
protected java.lang.String[] getChildrenNames(java.lang.String path, java.io.FilenameFilter filter) throws FolderNotFoundException
FolderNotFoundException
public NodeSet getNodes(java.lang.String path, boolean regexp, java.lang.String documentType) throws FolderNotFoundException, InvalidFolderException, NodeException
getChildNodes
getNodes
in interface FolderHandler
path
- regexp
- documentType
-
FolderNotFoundException
DocumentException
InvalidFolderException
NodeException
FolderHandler.getNodes(java.lang.String,boolean,java.lang.String)
protected void addToCache(java.lang.String id, java.lang.Object objectToCache)
addToCache
id
- objectToCache
- public void refresh(FileCacheEntry entry) throws java.lang.Exception
refresh
refresh
in interface FileCacheEventListener
entry
-
java.lang.Exception
FileCacheEventListener.refresh(org.apache.jetspeed.cache.file.FileCacheEntry)
public void evict(FileCacheEntry entry) throws java.lang.Exception
evict
evict
in interface FileCacheEventListener
entry
-
java.lang.Exception
FileCacheEventListener.evict(org.apache.jetspeed.cache.file.FileCacheEntry)
public boolean isFolder(java.lang.String path)
FolderHandler
isFolder
in interface FolderHandler
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |