Package lumis.portal.filesystem

Interface IPortalBaseFolder

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

IWebRootPortalBaseFolder, IWebRootPortalBaseFolderSPI

All Known Implementing Classes:

AbstractPortalBaseFolder, LocalDataFilePortalBaseFolder, PortalBaseFolder

@StableMinor(version="16.1",
             sinceVersion="6.2")
public interface IPortalBaseFolder
extends java.io.Serializable

A portal base folder represents a logical folder known to the portal. It provides operations to convert between relative (logical) and absolute (real) paths for resource inside the structure represented by it.

A portal base folder implementation must be serializable in such way that after being transferred between LumisXP instances, it resolves to the equivalent files in the new instance.

Since:

6.2.0

Version:

$Revision: 26156 $ $Date: 2024-01-13 10:26:46 -0300 (Sat, 13 Jan 2024) $

See Also:

PortalFilePath, PortalBaseFolder, IWebsite.getWebRootBaseFolder()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)	Indicates whether this base folder is equivalent to the given base folder.
java.lang.String	getAbsolutePath(java.lang.String relativePath)	Deprecated. since 8.0.0 it is not recommended to be used anymore due to the filesystem abstraction layer.
java.lang.String	getRelativePath(java.lang.String absolutePath)	Deprecated. since 8.0.0 it is not recommended to be used anymore due to the filesystem abstraction layer.
java.lang.String	toString()	A string for display purposes that identifies this base folder.

Method Detail

getAbsolutePath

@Deprecated
java.lang.String getAbsolutePath(java.lang.String relativePath)

Deprecated.

since 8.0.0 it is not recommended to be used anymore due to the filesystem abstraction layer. Every file operation should use the IFile interface, that can be obtained from IFileSystemManager.getFile(PortalFilePath). The direct usage of Java file API can produce unpredictable portal behavior, when not using the LumisPortal default filesystem implementations. The new filesystem API is highly recommended to be used instead.

Calculates the absolute path from a relative path to this base folder.

Parameters:

relativePath - the relative path.

Returns:

the absolute path.

Since:

6.2.0

getRelativePath

@Deprecated
java.lang.String getRelativePath(java.lang.String absolutePath)

Deprecated.

since 8.0.0 it is not recommended to be used anymore due to the filesystem abstraction layer. Every file operation should use the IFile interface, that can be obtained from IFileSystemManager.getFile(PortalFilePath). The direct usage of Java file API can produce unpredictable portal behavior, when not using the LumisPortal default filesystem implementations. The new filesystem API is highly recommended to be used instead.

Calculates the relative path to this base folder for the given absolute path.

Parameters:

absolutePath - the absolute path.

Returns:

the calculated relative path, relative to this base folder.

Throws:

java.lang.IllegalArgumentException - if the given absolute path is invalid or does not belongs to this base folder area.

Since:

6.2.0

equals

boolean equals(java.lang.Object obj)

Indicates whether this base folder is equivalent to the given base folder.

Equivalent base folders represent the same real folder and semantics. Two equivalent base folders have the same results on its conversions between absolute and relative paths. But it is possible to two base folders to resolve its conversions the same way, but not be considered equivalent, if they do not share the same semantics.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare to.

Returns:

true if this base folder is equivalent to a given base folder; false otherwise.

Since:

6.2.0

toString

java.lang.String toString()

A string for display purposes that identifies this base folder.

In special, PortalFilePath uses this string to create its own toString, in the form: [base folder]:/[relative path]. This method should return a value that keeps that form friendly.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this base folder.

Since:

6.2.0