Class Portal
java.lang.Object
de.uplanet.lucy.server.auxiliaries.Portal
-
Field Summary
-
Constructor Summary
ConstructorDescriptionPortal
(org.springframework.context.ApplicationContext p_appCtx) Standard constructor. -
Method Summary
Modifier and TypeMethodDescriptionint
Get the number of active sessions.Get the anonymous user's unique identifier.int
Get the number of sessions of the anonymous user.org.springframework.context.ApplicationContext
Get the portal's Spring application context.de.uplanet.lucy.server.auxiliaries.versionmanager.VCVersionInfo
getApplicationVersionInformation
(String p_strApplicationGuid) Get the semantic version information of an application.Get a list of available time zone IDs.getDefaultMenuGuid
(String p_strLayout) Get the GUID of the default menu of the given layout.int
Deprecated.Get the Intrexx semantic version.int
Get the Intrexx Share version.int
Get the Intrexx version as an integer (e.g. 5200).Get the Intrexx version as a string (e.g. 5.20).Get the portal's language.Get the languages that are supported by this portal.de.uplanet.lucy.server.auxiliaries.versionmanager.VCVersionInfo
getLayoutVersionInformation
(String p_strLayoutDirectoryName) Get the semantic version information of a layout.Get a list of available login domains.List<de.uplanet.lucy.server.usermanager.IUser>
getMyBuddies
(de.uplanet.jdbc.JdbcConnection p_conn, String p_strName, String p_strUserGuid) getName()
Get the portal name (server/). int
Get the number of non-anonymous active sessions.de.uplanet.lucy.server.dataobjects.impl.NowValueHolder
getNow()
Get a value holder for the current date and time.de.uplanet.lucy.server.usermanager.velocity.VelocityOrgStructureWrapper
Get the portal's organizational structure.de.uplanet.lucy.server.polling.IPollingService
Get the polling service.Get the portal's display name.int
Get the process id (PID) of the running portal server.de.uplanet.lucy.server.scripting.ChimeraDate
Get the portal start time.Get the portal's default time zone.de.uplanet.lucy.server.scripting.velocity.util.Duration
Get the portal uptime as a string.long
Get the portal uptime in milliseconds.getUsersOnline
(boolean p_bIncudeAnonymousUsers) Get a list that contains the unique identifiers of users that are online.de.uplanet.lucy.server.auxiliaries.versionmanager.VCVersionInfo
getWorkflowVersionInformation
(String p_strWorkflowGuid) Get the semantic version information of a workflow.boolean
Test if the Application API is supported in this portal.boolean
Test if chat is enabled globally.boolean
isChatEnabled
(String p_strUserId) Test if chat is enabled for the given user.boolean
Deprecated.Since Intrexx 9.0.boolean
isDemo()
boolean
boolean
Test if external authentication is supported in this portal.boolean
Test if horizontal scaling is supported in this portal.boolean
Check if Intrexx Share is available in the current portal.boolean
Deprecated.Since Intrexx 9.0.boolean
boolean
Flag indicating if mobile devices are supported.boolean
Test if multitenancy is supported in this portal.boolean
isNfr()
boolean
boolean
Flag indicating if silent mode is enabled.boolean
Flag indicating if single tenant mode is enabled.boolean
boolean
isUserOnline
(String p_strUserId) Test if the specified user is online, i.e. if she has an associated session.boolean
Test if user synchronization is supported in this portal.boolean
Flag indicating if yellow fade is enabled.List<de.uplanet.lucy.server.usermanager.IUser>
Get a list of all non-anonymous users that are online.List<de.uplanet.lucy.server.usermanager.IUser>
listNonAnonymousUsersOnline
(de.uplanet.util.filter.IFilter<de.uplanet.lucy.server.usermanager.IUser> p_filter) Get a list of all non-anonymous users that are online.de.uplanet.lucy.server.usermanager.velocity.VelocityOrgStructureWrapper
Read the portal's organizational structure from database.double
userActivity
(String p_strUserId)
-
Field Details
-
SYSPROP_DISABLE_DEPRECATED_EDITOR
"de.uplanet.lucy.server.portal.disableDeprecatedEditor"
.- See Also:
-
SYSPROP_MEDIASIZE_DEBUG
"de.uplanet.lucy.server.mediaSize.debug"
.- See Also:
-
-
Constructor Details
-
Portal
public Portal(org.springframework.context.ApplicationContext p_appCtx) Standard constructor.- Parameters:
p_appCtx
- The Spring application context.
-
-
Method Details
-
getApplicationContext
public org.springframework.context.ApplicationContext getApplicationContext()Get the portal's Spring application context.- Returns:
- The Spring application context.
-
getProcessId
public int getProcessId()Get the process id (PID) of the running portal server.- Returns:
- The process id.
-
getNow
public de.uplanet.lucy.server.dataobjects.impl.NowValueHolder getNow()Get a value holder for the current date and time.- Returns:
- The value holder.
-
getUptimeMillis
public long getUptimeMillis()Get the portal uptime in milliseconds.- Returns:
- The uptime in milliseconds.
-
getUptimeDuration
public de.uplanet.lucy.server.scripting.velocity.util.Duration getUptimeDuration()Get the portal uptime as a string.The returned duration object can be used to format the duration or to extract days, hours, minutes, seconds, and milliseconds.
- Returns:
- The uptime as a
Duration
object.
-
getStartTime
public de.uplanet.lucy.server.scripting.ChimeraDate getStartTime()Get the portal start time.- Returns:
- The portal start time.
-
getPortalName
Get the portal's display name.- Returns:
- The portal's display name.
-
getName
Get the portal name (server/). - Returns:
- The portal name.
-
isMobileDevicesSupported
public boolean isMobileDevicesSupported()Flag indicating if mobile devices are supported.- Returns:
true
if mobile devices are supported, orfalse
otherwise.
-
isYellowFadeEnabled
public boolean isYellowFadeEnabled()Flag indicating if yellow fade is enabled.- Returns:
true
if yellow fade is enabled, orfalse
otherwise.
-
isSilentModeEnabled
public boolean isSilentModeEnabled()Flag indicating if silent mode is enabled.- Returns:
true
if silent mode is enabled, orfalse
otherwise.
-
isSingleTenantMode
public boolean isSingleTenantMode()Flag indicating if single tenant mode is enabled.- Returns:
true
single tenant mode is enabled, orfalse
otherwise.
-
getDefaultMenuGuid
Get the GUID of the default menu of the given layout.- Parameters:
p_strLayout
- The directory name of the layout.- Returns:
- The GUID of the default menu top-level group.
- Throws:
Exception
-
isDemo
public boolean isDemo()- Returns:
true
if the portal runs in demo mode, orfalse
otherwise.
-
isDeprecatedEditorDisabled
public boolean isDeprecatedEditorDisabled()- Returns:
true
if deprecated editors are disabled, orfalse
otherwise.
-
isMediaSizeDebugEnabled
public boolean isMediaSizeDebugEnabled()- Returns:
true
if media size debugging is enabled, orfalse
otherwise.
-
isPushState
public boolean isPushState()- Returns:
true
if the portal supports HTML push state, orfalse
otherwise.
-
getLanguage
Get the portal's language.- Returns:
- The portal's language.
-
getLanguages
Get the languages that are supported by this portal.- Returns:
- A list of supported languages.
-
getLoginDomains
Get a list of available login domains.- Returns:
- An array containing the available login domains.
-
getTimeZone
Get the portal's default time zone.- Returns:
- The default time zone.
-
getAvailableTimeZoneIDs
Get a list of available time zone IDs.- Returns:
- The list of available time zone IDs.
-
getFirstDayOfWeek
Deprecated.UseVCLocales.getDefaultLocale()
instead.Get the portal's default first-day-of-week.- Returns:
- The portal's default first-day-of-week.
-
getActiveSessionCount
public int getActiveSessionCount()Get the number of active sessions.- Returns:
- The number of active sessions.
-
getNonAnonymousActiveSessionCount
public int getNonAnonymousActiveSessionCount()Get the number of non-anonymous active sessions.- Returns:
- The number of active sessions.
-
getAnonymousUserGuid
Get the anonymous user's unique identifier.- Returns:
- The anonymous user's unique identifier, or
null
if it could not be determined.
-
userActivity
- Parameters:
p_strUserId
- The user's unique identifier.- Returns:
- A value that indicates the user's activity.
-
isUserOnline
Test if the specified user is online, i.e. if she has an associated session.- Parameters:
p_strUserId
- The user's unique identifier.- Returns:
true
if the user is online,false
otherwise.
-
getUsersOnline
Get a list that contains the unique identifiers of users that are online.- Parameters:
p_bIncudeAnonymousUsers
-true
if anonymous sessions should be included in the resulting array,false
otherwise.- Returns:
- A list that contains the unique identifiers of users that are online.
-
getAnonymousUserOnlineCount
public int getAnonymousUserOnlineCount()Get the number of sessions of the anonymous user.- Returns:
- The number of anonymous user sessions.
-
listNonAnonymousUsersOnline
Get a list of all non-anonymous users that are online.- Returns:
- A list of all non-anonymous users that are online.
-
listNonAnonymousUsersOnline
public List<de.uplanet.lucy.server.usermanager.IUser> listNonAnonymousUsersOnline(de.uplanet.util.filter.IFilter<de.uplanet.lucy.server.usermanager.IUser> p_filter) Get a list of all non-anonymous users that are online.Note: filters can be created e.g. using the
ObjectFactory
.- Parameters:
p_filter
- A filter to be applied.- Returns:
- A list of all non-anonymous users that are online.
-
getPollingService
public de.uplanet.lucy.server.polling.IPollingService getPollingService()Get the polling service.- Returns:
- The polling service.
- Since:
- Intrexx version 6.0.
-
getOrgStructure
public de.uplanet.lucy.server.usermanager.velocity.VelocityOrgStructureWrapper getOrgStructure()Get the portal's organizational structure.This method utilizes the org structure cache and thus generally offers better performance than
readOrgStructure()
.- Returns:
- The portal's organizational structure.
- See Also:
-
readOrgStructure
public de.uplanet.lucy.server.usermanager.velocity.VelocityOrgStructureWrapper readOrgStructure() throws SQLExceptionRead the portal's organizational structure from database.This method reads the organizational structure directly from the database. So it reflects the most recent changes, but at the expense of performance.
- Returns:
- The portal's organizational structure.
- Throws:
SQLException
- If a database error occurred.- See Also:
-
isChatEnabled
public boolean isChatEnabled()Test if chat is enabled globally.- Returns:
true
if chat is globally enabled, orfalse
otherwise.
-
isChatEnabled
Test if chat is enabled for the given user.- Parameters:
p_strUserId
- The user's unique identifier.- Returns:
true
if chat is enabled for the given user, orfalse
otherwise.
-
getMyBuddies
-
isJsCompressionEnabled
Deprecated.Since Intrexx 9.0. -
isCssCompressionEnabled
Deprecated.Since Intrexx 9.0. -
isTestOrDevelopmentSystem
public boolean isTestOrDevelopmentSystem()- Returns:
true
if the portal is licensed as a test or development system, orfalse
otherwise.
-
isNfr
public boolean isNfr()- Returns:
true
if the portal is licensed as a NFR system, orfalse
otherwise.
-
getIntrexxSemanticVersion
Get the Intrexx semantic version.See https://semver.org/.
- Returns:
- The Intrexx semantic version.
-
getIntrexxVersionInt
public int getIntrexxVersionInt()Get the Intrexx version as an integer (e.g. 5200).- Returns:
- The Intrexx version as an integer.
-
getIntrexxVersionStr
Get the Intrexx version as a string (e.g. 5.20).- Returns:
- The Intrexx version as a string.
-
isExternalAuthenticationSupported
public boolean isExternalAuthenticationSupported()Test if external authentication is supported in this portal.- Returns:
true
if external authentication is supported in this portal, orfalse
otherwise.
-
isUserSynchronizationSupported
public boolean isUserSynchronizationSupported()Test if user synchronization is supported in this portal.- Returns:
true
if user synchronization is supported in this portal, orfalse
otherwise.
-
isApplicationApiSupported
public boolean isApplicationApiSupported()Test if the Application API is supported in this portal.- Returns:
true
if the Application API is supported in this portal, orfalse
otherwise.
-
isMultitenancySupported
public boolean isMultitenancySupported()Test if multitenancy is supported in this portal.- Returns:
true
if multitenancy is supported in this portal, orfalse
otherwise.
-
isHorizontalScalabilitySupported
public boolean isHorizontalScalabilitySupported()Test if horizontal scaling is supported in this portal.- Returns:
true
if horizontal scaling is supported in this portal, orfalse
otherwise.
-
getApplicationVersionInformation
public de.uplanet.lucy.server.auxiliaries.versionmanager.VCVersionInfo getApplicationVersionInformation(String p_strApplicationGuid) Get the semantic version information of an application.- Parameters:
p_strApplicationGuid
- The application GUID.- Returns:
- The semantic version information or
null
if no semantic version information exists.
-
getWorkflowVersionInformation
public de.uplanet.lucy.server.auxiliaries.versionmanager.VCVersionInfo getWorkflowVersionInformation(String p_strWorkflowGuid) Get the semantic version information of a workflow.- Parameters:
p_strWorkflowGuid
- The workflow GUID.- Returns:
- The semantic version information or
null
if no semantic version information exists.
-
getLayoutVersionInformation
public de.uplanet.lucy.server.auxiliaries.versionmanager.VCVersionInfo getLayoutVersionInformation(String p_strLayoutDirectoryName) Get the semantic version information of a layout.- Parameters:
p_strLayoutDirectoryName
- The layout directory name.- Returns:
- The semantic version information or
null
if no semantic version information exists.
-
VCLocales.getDefaultLocale()
instead.