Package de.uplanet.lucy.server.auxiliaries

Class Portal

java.lang.Object
de.uplanet.lucy.server.auxiliaries.Portal
@VelocityVariable("Portal") @VelocityCallable("instance") public final class Portal extends Object

  • Field Details

    • SYSPROP_DISABLE_DEPRECATED_EDITOR

      @SystemProperty(defaultValue="true") public static final String SYSPROP_DISABLE_DEPRECATED_EDITOR
      "de.uplanet.lucy.server.portal.disableDeprecatedEditor".
      See Also:

    • SYSPROP_MEDIASIZE_DEBUG

      @SystemProperty(defaultValue="true") public static final String 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 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 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 ChimeraDate getStartTime()
      Get the portal start time.
      Returns:
      The portal start time.

    • getPortalName

      public String getPortalName()
      Get the portal's display name.
      Returns:
      The portal's display name.

    • getName

      public String 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, or false otherwise.

    • isYellowFadeEnabled

      public boolean isYellowFadeEnabled()
      Flag indicating if yellow fade is enabled.
      Returns:
      true if yellow fade is enabled, or false otherwise.

    • isShowActionInfo

      public boolean isShowActionInfo()
      Flag indicating if an info box is shown when saving or deleting a record.
      Returns:
      true if an info box is shown, or false otherwise.

    • isSilentModeEnabled

      public boolean isSilentModeEnabled()
      Flag indicating if silent mode is enabled.
      Returns:
      true if silent mode is enabled, or false otherwise.

    • isSingleTenantMode

      public boolean isSingleTenantMode()
      Flag indicating if single tenant mode is enabled.
      Returns:
      true single tenant mode is enabled, or false otherwise.

    • getDefaultMenuGuid

      public String getDefaultMenuGuid(String p_strLayout) throws Exception
      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, or false otherwise.

    • isDeprecatedEditorDisabled

      public boolean isDeprecatedEditorDisabled()
      Returns:
      true if deprecated editors are disabled, or false otherwise.

    • isMediaSizeDebugEnabled

      public boolean isMediaSizeDebugEnabled()
      Returns:
      true if media size debugging is enabled, or false otherwise.

    • isPushState

      public boolean isPushState()
      Returns:
      true if the portal supports HTML push state, or false otherwise.

    • getLanguage

      public String getLanguage()
      Get the portal's language.
      Returns:
      The portal's language.

    • getLanguages

      public List<String> getLanguages()
      Get the languages that are supported by this portal.
      Returns:
      A list of supported languages.

    • getLoginDomains

      public List<String> getLoginDomains()
      Get a list of available login domains.
      Returns:
      An array containing the available login domains.

    • getTimeZone

      public TimeZone getTimeZone()
      Get the portal's default time zone.
      Returns:
      The default time zone.

    • getAvailableTimeZoneIDs

      public List<String> getAvailableTimeZoneIDs()
      Get a list of available time zone IDs.
      Returns:
      The list of available time zone IDs.

    • getFirstDayOfWeek

      @Deprecated public int getFirstDayOfWeek()
      Deprecated.
      Use VCLocales.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

      public String getAnonymousUserGuid()
      Get the anonymous user's unique identifier.
      Returns:
      The anonymous user's unique identifier, or null if it could not be determined.

    • userActivity

      public double userActivity(String p_strUserId)
      Parameters:
      p_strUserId - The user's unique identifier.
      Returns:
      A value that indicates the user's activity.

    • isUserOnline

      public boolean isUserOnline(String p_strUserId)
      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

      public List<String> getUsersOnline(boolean p_bIncudeAnonymousUsers)
      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

      public List<IUser> listNonAnonymousUsersOnline()
      Get a distinct list of all non-anonymous users that are online.
      Returns:
      A list of all non-anonymous users that are online.

    • listNonAnonymousUsersOnline

      public List<IUser> listNonAnonymousUsersOnline(IFilter<IUser> p_filter)
      Get a distinct filtered list of 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 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 VelocityOrgStructureWrapper readOrgStructure() throws SQLException
      Read 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, or false otherwise.

    • isChatEnabled

      public boolean isChatEnabled(String p_strUserId)
      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, or false otherwise.

    • getMyBuddies

      public List<IUser> getMyBuddies(de.uplanet.jdbc.JdbcConnection p_conn, String p_strName, String p_strUserGuid)

    • isJsCompressionEnabled

      @Deprecated public boolean isJsCompressionEnabled()
      Deprecated.
      Since Intrexx 9.0.

    • isCssCompressionEnabled

      @Deprecated public boolean isCssCompressionEnabled()
      Deprecated.
      Since Intrexx 9.0.

    • isTestOrDevelopmentSystem

      public boolean isTestOrDevelopmentSystem()
      Returns:
      true if the portal is licensed as a test or development system, or false otherwise.

    • isNfr

      public boolean isNfr()
      Returns:
      true if the portal is licensed as a NFR system, or false otherwise.

    • getIntrexxSemanticVersion

      public String 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

      public String 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, or false otherwise.

    • isUserSynchronizationSupported

      public boolean isUserSynchronizationSupported()
      Test if user synchronization is supported in this portal.
      Returns:
      true if user synchronization is supported in this portal, or false 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, or false otherwise.

    • isMultitenancySupported

      public boolean isMultitenancySupported()
      Test if multitenancy is supported in this portal.
      Returns:
      true if multitenancy is supported in this portal, or false otherwise.

    • isHorizontalScalabilitySupported

      public boolean isHorizontalScalabilitySupported()
      Test if horizontal scaling is supported in this portal.
      Returns:
      true if horizontal scaling is supported in this portal, or false otherwise.

    • isWebdavServicesSupported

      public boolean isWebdavServicesSupported()
      Test if WebDAV services are supported in this portal.
      Returns:
      true if WebDAV services are supported in this portal, or false otherwise.

    • isIntrexxShareAvailable

      public boolean isIntrexxShareAvailable()
      Check if Intrexx Share is available in the current portal.
      Returns:
      true if Intrexx Share is available, or false otherwise.

    • getIntrexxShareVersion

      public int getIntrexxShareVersion()
      Get the Intrexx Share version.
      Returns:
      The Intrexx Share version, or -1 if Intrexx Share is not available.

    • getApplicationVersionInformation

      public VCVersionInfo getApplicationVersionInformation(String p_strAppGuid)
      Get the semantic version information of an application.
      Parameters:
      p_strAppGuid - The application GUID.
      Returns:
      The semantic version information or null if no semantic version information exists.
      Throws:
      IllegalArgumentException - If no GUID is given or the application does not exist.

    • getWorkflowVersionInformation

      public 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.
      Throws:
      IllegalArgumentException - If no GUID is given or the workflow does not exist.

    • getLayoutVersionInformation

      public VCVersionInfo getLayoutVersionInformation(String p_strLayoutDirName)
      Get the semantic version information of a layout.
      Parameters:
      p_strLayoutDirName - The layout directory name.
      Returns:
      The semantic version information or null if no semantic version information exists.
      Throws:
      IllegalArgumentException - If no layout name is given or if the layout name is invalid or the layout does not exist.

    • getApiKey

      public String getApiKey(String p_strApiKeyName)
      Get the API key with the given name.
      Parameters:
      p_strApiKeyName - The name of the API key.
      Returns:
      The API key, or null if no key with the given name exist.

    • getMultiFactorAppGuid

      public String getMultiFactorAppGuid()
      Returns:
      Returns the GUID for the multi-factor authentication configuration application.