PortalContext

java.lang.Object
- lumis.portal.PortalContext

```
public class PortalContext
extends Object
```
Portal Context. Contains global portal configuration information

Since:

4.0.0

Version:

$Revision: 23943 $ $Date: 2020-06-29 21:02:59 +0000 (Mon, 29 Jun 2020) $

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PortalContext.RelativePath` Deprecated. Since 4.1.0, replaced by `PortalFilePath`.
`static class`	`PortalContext.RelativePathType` Deprecated. Since 4.1.0, replaced by `PortalBaseFolder`.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_LOADING_HTML_MESSAGE`
`static int`	`MODE_ADMIN` Deprecated. Since 6.0.0 due changes in the portal presentation.
`static int`	`MODE_USER` Deprecated. Since 6.0.0 due changes in the portal presentation.
`static String`	`SHARED_FOLDER_NAME` Shared folder name.

Constructor Summary

Constructors
Constructor and Description

PortalContext()

Constructors
Constructor and Description
`PortalContext()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static Node`	`getApplicationServerConfig()`
`static BuildConfig`	`getBuildConfig()`
`static int`	`getCacheDefaultCapacity()` Returns the default capacity for portal's caches.
`static String`	`getCacheOverflowType()` Returns the overflow type for portal's caches.
`static int`	`getClockTickInterval()`
`static Node`	`getClusterConfig()`
`static String`	`getConfigPath(String relativePath)`
`static Node`	`getCookieConfig()` Get Node of all cookies options, if wasn't set at lumispotalconfig.xml, will get the default cookies options.
`static String`	`getDataPath(String relativePath)` Deprecated. since 8.0.0 use `filesystem API` to perform filesystem operations in portal known files.
`static Locale`	`getDefaultLocale()` Deprecated. since 8.1.0 replaced by `ILocalizationManager.getDefaultLocale()`
`static PageDocType`	`getDefaultPageDocType()`
`static String`	`getDefinitionPath(String relativePath)` Deprecated. since 8.0.0 use `filesystem API` to perform filesystem operations in portal known files.
`static Node`	`getDeviceDetectionNode()` Returns the Device Detection node that was defined on lumisPortalConfig.
`static Node`	`getEncryptionConfig()`
`static String`	`getErrorPage()`
`static int`	`getExecutorMaxThreads()` Returns the maximum number of threads to be kept alive by `IExecutorManager`.
`static int`	`getExecutorMinThreads()` Returns the minimum number of threads to be kept alive by `IExecutorManager`.
`static String`	`getFFMPEGExecutablePath()` Returns the absolute file path of the FFMPEG customized by the user.
`static Pattern`	`getFileUploadDeniedExtensionsPattern()` Returns the pattern for matching file extensions whose upload are to be denied.
`static String`	`getFrameworkUrl()` Deprecated. Since 6.2.0, replaced by `IWebsite.getMainNonSecureBaseURL()` due to the inclusion of multiple websites. For best compatibility, this method resolves based on the default website's main non-secure URL. If there is no default website, it will throw an `IllegalStateException`.
`static HtmlGenerationConfig`	`getHtmlGenerationConfig()` Returns the configuration for the html generation.
`static String`	`getHttpAuthenticator()` Returns the configured `IHttpAuthenticator` class name.
`static String`	`getInterfaceTitleBarStyle()`
`static Integer`	`getLayoutFilePollIntervalSecs()` Returns the polling interval for changes in a layout file, in seconds.
`static String`	`getLoadingHtmlMessage()`
`static String`	`getLocalDataPath(String relativePath)` Returns the local data path.
`static int`	`getLockDefaultDeadlineMinutes()`
`static String`	`getLoginValidator()`
`static int`	`getMajorVersion()` Returns the major version of the portal.
`static long`	`getMaxFileUploadSize()` Returns the maximum size for file uploads.
`static int`	`getMinorVersion()` Returns the minor version of the portal.
`static String`	`getNonSSLConnectorPort()` Deprecated. Since 6.2.0, replaced by `IWebsite.getMainNonSecureBaseURL()` due to the inclusion of multiple websites. For best compatibility, this method resolves based on the default website's main non-secure URL. If there is no default website, it will throw an `IllegalStateException`.
`static String`	`getPortalInfo()` Returns the name and version of the portal.
`static String`	`getRealPath(String relativePath)` Deprecated. Since 6.2.0, replaced by `IWebsite.getWebRootBaseFolder()` due to the inclusion of multiple websites, and consequently, multiple web roots. For best compatibility, this method resolves based on the default website's web root folder. If there is no default website, it will throw an `IllegalStateException`.
`static String`	`getRootPath()` Deprecated. Since 6.2.0, replaced by `IWebsite.getWebRootBaseFolder()` due to the inclusion of multiple websites, and consequently, multiple web roots. For best compatibility, this method resolves based on the default website's web root folder. If there is no default website, it will throw an `IllegalStateException`.
`static String`	`getSecurityAlias()`
`static String`	`getServerId()` Returns the server id of the current server.
`static ServiceContainer`	`getServiceContainer()` Returns the service container associated with this portal application.
`static int`	`getSessionTimeout()` Returns the maximum amount of time (in minutes) a session can be inactive before it expires.
`static String`	`getSimpleVersion()` Returns a simplified version of product's version (in the form <major>.<minor>.<release>).
`static String`	`getSSLConnectorPort()` Deprecated. Since 6.2.0, replaced by `IWebsite.getMainSecureBaseURL()` due to the inclusion of multiple websites. For best compatibility, this method resolves based on the default website's main non-secure URL. If there is no default website, it will throw an `IllegalStateException`.
`static int`	`getTransactionLogAbandonedTimeout()` Returns the timeout for the logging of long-lived transactions.
`static String`	`getWebAppRelativePath(String absolutePath)` Deprecated. Since 6.2.0, replaced by `IPortalBaseFolder.getRelativePath(String)` in website's `web root base folder`, due to the inclusion of multiple websites, and consequently, multiple web roots. For best compatibility, this method resolves based on the default website's web root folder. If there is no default website, it will throw an `IllegalStateException`.
`static String`	`getWebInfPath(String relativePath)` Deprecated. Data is not stored in WEB-INF anymore, so this method should not be used. Instead use `getDefinitionPath(String)`, `getConfigPath(String)`, or `getDataPath(String)`.
`static boolean`	`isCacheStandardMembershipBulkLoadEnabled()` Returns whether the bulk load for the standard membership cache is enabled.
`static boolean`	`isCacheUserSegmentationMembershipBulkLoadEnabled()` Returns whether the bulk load for the user segmentation membership cache is enabled.
`static boolean`	`isClockEnabled()`
`static boolean`	`isSupportMultiLanguage()`
`static void`	`setSupportMultiLanguage(boolean supportMultiLanguage)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SHARED_FOLDER_NAME
```
public static final String SHARED_FOLDER_NAME
```
    Shared folder name.
    
    Since:
    
    8.0.0
    
    See Also:
    
    Constant Field Values
  - MODE_USER
```
@Deprecated
public static final int MODE_USER
```
    Deprecated. Since 6.0.0 due changes in the portal presentation.
    
    See Also:
    
    PortalModes
  - MODE_ADMIN
```
@Deprecated
public static final int MODE_ADMIN
```
    Deprecated. Since 6.0.0 due changes in the portal presentation.
    
    See Also:
    
    PortalModes
  - DEFAULT_LOADING_HTML_MESSAGE
```
public static final String DEFAULT_LOADING_HTML_MESSAGE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PortalContext
```
public PortalContext()
```
- Method Detail
  - getDefaultLocale
```
@Deprecated
public static Locale getDefaultLocale()
```
    Deprecated. since 8.1.0 replaced by ILocalizationManager.getDefaultLocale()
    
    Returns:
    
    Returns the defaultLanguageId.
  - getServerId
```
public static String getServerId()
```
    Returns the server id of the current server.
    
    Returns:
    
    the server id of the current server.
    
    Since:
    
    4.1.0
  - getFrameworkUrl
```
@Deprecated
public static String getFrameworkUrl()
```
    Deprecated. Since 6.2.0, replaced by IWebsite.getMainNonSecureBaseURL() due to the inclusion of multiple websites.
    For best compatibility, this method resolves based on the default website's main non-secure URL. If there is no default website, it will throw an IllegalStateException.
    
    Returns:
    
    Returns the frameworkUrl.
  - getErrorPage
```
public static String getErrorPage()
```
  - getLoginValidator
```
public static String getLoginValidator()
```
  - getHttpAuthenticator
```
public static String getHttpAuthenticator()
```
    Returns the configured IHttpAuthenticator class name.
    
    Returns:
    
    the httpAuthenticator class name, or null if none was configured.
    
    Since:
    
    4.0.10
  - getRootPath
```
@Deprecated
public static String getRootPath()
```
    Deprecated. Since 6.2.0, replaced by IWebsite.getWebRootBaseFolder() due to the inclusion of multiple websites, and consequently, multiple web roots.
    For best compatibility, this method resolves based on the default website's web root folder. If there is no default website, it will throw an IllegalStateException.
    
    Returns:
    
    Returns the rootPath.
  - getMaxFileUploadSize
```
public static long getMaxFileUploadSize()
```
    Returns the maximum size for file uploads.
    
    Returns:
    
    the maximum size for file uploads in bytes, or -1 if there is no limit for file upload size.
  - getFileUploadDeniedExtensionsPattern
```
public static Pattern getFileUploadDeniedExtensionsPattern()
```
    Returns the pattern for matching file extensions whose upload are to be denied.
    
    Returns:
    
    the pattern.
    
    Since:
    
    4.2.0
  - getRealPath
```
@Deprecated
public static String getRealPath(String relativePath)
```
    Deprecated. Since 6.2.0, replaced by IWebsite.getWebRootBaseFolder() due to the inclusion of multiple websites, and consequently, multiple web roots.
    For best compatibility, this method resolves based on the default website's web root folder. If there is no default website, it will throw an IllegalStateException.
  - getWebAppRelativePath
```
@Deprecated
public static String getWebAppRelativePath(String absolutePath)
```
    Deprecated. Since 6.2.0, replaced by IPortalBaseFolder.getRelativePath(String) in website's web root base folder, due to the inclusion of multiple websites, and consequently, multiple web roots.
    For best compatibility, this method resolves based on the default website's web root folder. If there is no default website, it will throw an IllegalStateException.
  - getDataPath
```
@Deprecated
public static String getDataPath(String relativePath)
```
    Deprecated. since 8.0.0 use filesystem API to perform filesystem operations in portal known files.
  - getLocalDataPath
```
public static String getLocalDataPath(String relativePath)
```
    Returns the local data path.
    
    Parameters:
    
    relativePath - the relative local data path.
    
    Returns:
    
    the local data path.
    
    Since:
    
    8.0.0
  - getConfigPath
```
public static String getConfigPath(String relativePath)
```
  - getDefinitionPath
```
@Deprecated
public static String getDefinitionPath(String relativePath)
```
    Deprecated. since 8.0.0 use filesystem API to perform filesystem operations in portal known files.
  - getWebInfPath
```
@Deprecated
public static String getWebInfPath(String relativePath)
```
    Deprecated. Data is not stored in WEB-INF anymore, so this method should not be used. Instead use getDefinitionPath(String), getConfigPath(String), or getDataPath(String).
  - getBuildConfig
```
public static BuildConfig getBuildConfig()
                                  throws PortalException
```
    Throws:
    
    PortalException
  - getMajorVersion
```
public static int getMajorVersion()
                           throws PortalException
```
    Returns the major version of the portal.
    
    Returns:
    
    the major version
    
    Throws:
    
    PortalException
    
    See Also:
    
    getMinorVersion()
  - getMinorVersion
```
public static int getMinorVersion()
                           throws PortalException
```
    Returns the minor version of the portal.
    
    Returns:
    
    the minor version
    
    Throws:
    
    PortalException
    
    See Also:
    
    getMajorVersion()
  - getPortalInfo
```
public static String getPortalInfo()
```
    Returns the name and version of the portal.
    The form of the returned string is portalname/versionnumber.
    
    Returns:
    
    the name and version of the portal.
    
    Since:
    
    5.5.0.
  - getServiceContainer
```
public static ServiceContainer getServiceContainer()
```
    Returns the service container associated with this portal application. Used by the presentation manager.
    
    Returns:
    
    Service Container for the portal application
  - isClockEnabled
```
public static boolean isClockEnabled()
```
    Returns:
    
    Returns the clockEnabled.
  - getClockTickInterval
```
public static int getClockTickInterval()
```
    Returns:
    
    Returns the clockTickInterval.
  - getNonSSLConnectorPort
```
@Deprecated
public static String getNonSSLConnectorPort()
```
    Deprecated. Since 6.2.0, replaced by IWebsite.getMainNonSecureBaseURL() due to the inclusion of multiple websites.
    For best compatibility, this method resolves based on the default website's main non-secure URL. If there is no default website, it will throw an IllegalStateException.
    
    Returns:
    
    Returns the port for http request.
  - getSSLConnectorPort
```
@Deprecated
public static String getSSLConnectorPort()
```
    Deprecated. Since 6.2.0, replaced by IWebsite.getMainSecureBaseURL() due to the inclusion of multiple websites.
    For best compatibility, this method resolves based on the default website's main non-secure URL. If there is no default website, it will throw an IllegalStateException.
    
    Returns:
    
    Returns the port for https request.
  - getLockDefaultDeadlineMinutes
```
public static int getLockDefaultDeadlineMinutes()
```
    Returns:
    
    Returns the default lock deadline (in minutes)
  - isSupportMultiLanguage
```
public static boolean isSupportMultiLanguage()
```
  - setSupportMultiLanguage
```
public static void setSupportMultiLanguage(boolean supportMultiLanguage)
```
  - getHtmlGenerationConfig
```
public static HtmlGenerationConfig getHtmlGenerationConfig()
```
    Returns the configuration for the html generation.
    
    Returns:
    
    the configuration for the html generation.
    
    Since:
    
    4.1.0
  - getClusterConfig
```
public static Node getClusterConfig()
```
  - getApplicationServerConfig
```
public static Node getApplicationServerConfig()
```
  - getEncryptionConfig
```
public static Node getEncryptionConfig()
```
  - getSessionTimeout
```
public static int getSessionTimeout()
```
    Returns the maximum amount of time (in minutes) a session can be inactive before it expires.
    
    Returns:
  - getSecurityAlias
```
public static String getSecurityAlias()
```
  - getInterfaceTitleBarStyle
```
public static String getInterfaceTitleBarStyle()
```
  - getCacheDefaultCapacity
```
public static int getCacheDefaultCapacity()
```
    Returns the default capacity for portal's caches.
    
    Returns:
    
    the default capacity for portal's caches.
    
    Since:
    
    4.0.11
    
    See Also:
    
    ICacheManager
  - getCacheOverflowType
```
public static String getCacheOverflowType()
```
    Returns the overflow type for portal's caches.
    
    Returns:
    
    the overflow type for portal's caches.
    
    Since:
    
    4.0.11
  - isCacheStandardMembershipBulkLoadEnabled
```
public static boolean isCacheStandardMembershipBulkLoadEnabled()
```
    Returns whether the bulk load for the standard membership cache is enabled.
    
    Returns:
    
    true if enabled or false if disabled.
    
    Since:
    
    10.1.1
  - isCacheUserSegmentationMembershipBulkLoadEnabled
```
public static boolean isCacheUserSegmentationMembershipBulkLoadEnabled()
```
    Returns whether the bulk load for the user segmentation membership cache is enabled.
    
    Returns:
    
    true if enabled or false if disabled.
    
    Since:
    
    12.0.0
  - getDefaultPageDocType
```
public static PageDocType getDefaultPageDocType()
```
  - getLoadingHtmlMessage
```
public static String getLoadingHtmlMessage()
```
  - getExecutorMinThreads
```
public static int getExecutorMinThreads()
```
    Returns the minimum number of threads to be kept alive by IExecutorManager.
    
    Returns:
    
    the minimum number of threads.
    
    Since:
    
    4.1.0
  - getExecutorMaxThreads
```
public static int getExecutorMaxThreads()
```
    Returns the maximum number of threads to be kept alive by IExecutorManager.
    
    Returns:
    
    the maximum number of threads.
    
    Since:
    
    4.1.0
  - getLayoutFilePollIntervalSecs
```
public static Integer getLayoutFilePollIntervalSecs()
```
    Returns the polling interval for changes in a layout file, in seconds.
    
    Returns:
    
    a positive value indicates the polling interval in seconds; a non-positive value indicates that polling is disabled; null indicates that the default for the current development mode is to be used.
    
    Since:
    
    5.6.0
  - getDeviceDetectionNode
```
public static Node getDeviceDetectionNode()
```
    Returns the Device Detection node that was defined on lumisPortalConfig. If the node wasn't defined on lumisPortalConfig the result will be null.
    
    Returns:
    
    node contained the deviceDetection definition.
    
    Since:
    
    6.0.0
  - getTransactionLogAbandonedTimeout
```
public static int getTransactionLogAbandonedTimeout()
```
    Returns the timeout for the logging of long-lived transactions.
    If a transaction is not disposed within the specified timeout period after its creation, a warning level message is sent to the portal log. The value is in seconds. A non-positive value disables this logging feature. Default value is 600 seconds.
    
    Returns:
    
    the timeout in seconds, or a non-positive value if the logging is disabled.
    
    Since:
    
    6.2.0
  - getFFMPEGExecutablePath
```
public static String getFFMPEGExecutablePath()
```
    Returns the absolute file path of the FFMPEG customized by the user.
    
    Returns:
    
    the absolute file path of the FFMPEG customized by the user.
    
    Since:
    
    7.0.0
  - getCookieConfig
```
public static Node getCookieConfig()
```
    Get Node of all cookies options, if wasn't set at lumispotalconfig.xml, will get the default cookies options. Default:
    
    Returns:
    
    a node of all portal cookies options
    
    Since:
    
    7.0.2
  - getSimpleVersion
```
public static String getSimpleVersion()
                               throws PortalException
```
    Returns a simplified version of product's version (in the form <major>.<minor>.<release>).
    
    Returns:
    
    a simplified version of product's version (in the form <major>.<minor>.<release>).
    
    Throws:
    
    PortalException
    
    Since:
    
    10.0.0

Class PortalContext

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SHARED_FOLDER_NAME

MODE_USER

MODE_ADMIN

DEFAULT_LOADING_HTML_MESSAGE

Constructor Detail

PortalContext

Method Detail

getDefaultLocale

getServerId

getFrameworkUrl

getErrorPage

getLoginValidator

getHttpAuthenticator

getRootPath

getMaxFileUploadSize

getFileUploadDeniedExtensionsPattern

getRealPath

getWebAppRelativePath

getDataPath

getLocalDataPath

getConfigPath

getDefinitionPath

getWebInfPath

getBuildConfig

getMajorVersion

getMinorVersion

getPortalInfo

getServiceContainer

isClockEnabled

getClockTickInterval

getNonSSLConnectorPort

getSSLConnectorPort

getLockDefaultDeadlineMinutes

isSupportMultiLanguage

setSupportMultiLanguage

getHtmlGenerationConfig

getClusterConfig

getApplicationServerConfig

getEncryptionConfig

getSessionTimeout

getSecurityAlias

getInterfaceTitleBarStyle

getCacheDefaultCapacity

getCacheOverflowType

isCacheStandardMembershipBulkLoadEnabled

isCacheUserSegmentationMembershipBulkLoadEnabled

getDefaultPageDocType

getLoadingHtmlMessage

getExecutorMinThreads

getExecutorMaxThreads

getLayoutFilePollIntervalSecs

getDeviceDetectionNode

getTransactionLogAbandonedTimeout

getFFMPEGExecutablePath

getCookieConfig

getSimpleVersion