lumis.portal
Class PortalContext

java.lang.Object
  lumis.portal.PortalContext

public class PortalContext
extends Object

Portal Context. Contains global portal configuration information

Since:

4.0.0

Nested Class Summary

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

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.

Constructor Summary

PortalContext()

Method Summary

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 String	getDataPath(String relativePath)
static Locale	getDefaultLocale()
static PageDocType	getDefaultPageDocType()
static String	getDefinitionPath(String relativePath)
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 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 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	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	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

MODE_USER

@Deprecated
public static final int MODE_USER

Deprecated. Since 6.0.0 due changes in the portal presentation.

See Also:

Constant Field Values

MODE_ADMIN

@Deprecated
public static final int MODE_ADMIN

Deprecated. Since 6.0.0 due changes in the portal presentation.

See Also:

Constant Field Values

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

public static Locale 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

public static String getDataPath(String relativePath)

getConfigPath

public static String getConfigPath(String relativePath)

getDefinitionPath

public static String getDefinitionPath(String relativePath)

getWebInfPath

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

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

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

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