Package lumis.portal.filesystem

LumisXP provides a comprehensive file system API to abstract a virtual file system available on all portal servers on the same cluster.

See: Description

Interface Summary

Interface	Description
IFileFilter	Filter used when listing files of a given IFile.
IFileSystem	This is the LumisPortal file system interface that a given file system implementation must implement. Implementations are not loaded from platform's classloader. They will be read from web application's classloader instead.
IFileSystemManager	Provides operations for manipulating the file system.
IPortalBaseFolder	A portal base folder represents a logical folder known to the portal.

Class Summary

Class	Description
AbstractPortalBaseFolder	Abstract IPortalBaseFolder implementation, used as base class for some implementations.
FileSystemManager	Implementation of the file system manager.
FileSystemUtil	Utility class that provides methods for use internally in the lumis.portal.filesystem package.
IFile	Represents a LumisPortal file or directory that may or may not exist.
PortalFile	Deprecated since 8.0.0 it is not recommended to be used anymore due to the filesystem abstraction layer.
PortalFilePath	Represents a path to a portal file.

Enum Summary

Enum	Description
PortalBaseFolder	Specifies a portal standard base folder.

Package lumis.portal.filesystem Description

LumisXP provides a comprehensive file system API to abstract a virtual file system available on all portal servers on the same cluster.

The portal known files are those files that belong to some specific folders controlled by the LumisPortal.
These folders are abstracted by the IPortalBaseFolder interface.
A portal file is denoted by:

1. A portal base folder
2. A string that is the relative path of the file

By doing this the portal can easily identify a given file in any cluster server, even if the LumisPortal install path vary from server to server. The PortalFilePath class is the abstraction of these information.

The usage of portal known files must be performed through this API. The direct file manipulation could corrupt the portal file system.

The usage of this API provides the following advantages:

• Events corresponding to the changes in the file system are raised.
• Changes in the portal file system are reflected on other servers throughout the cluster.
• The file system implementation is abstracted and may be easily changed without loss of functionality.

The entry points for this package are:

• IFileSystemManager, available at ManagerFactory.getFileSystemManager(), that provides operations on the file system.
• IFile.
• IPortalBaseFolder.
• PortalFilePath.

How the portal known files are persisted can be configured on the portal environment configuration. If it is desired to implement your own way of file persistence this can be done by implementing IFileSystem. It is important to notice, though, that file system implementations are not loaded from platform's classloader. They must be present in web application's classloader instead.

Since:

4.1.0

Version:

$Revision: 23103 $ $Date: 2019-09-03 15:45:21 +0000 (Tue, 03 Sep 2019) $

See Also:

ManagerFactory.getFileSystemManager(), IFileSystemManager, PortalFilePath, IFile