Package de.uplanet.lucy.server.auxiliaries

Class Portal

  • @VelocityVariable("Portal")
@VelocityCallable("instance")
public final class Portal
extends Object

    • Field Detail

      • SYSPROP_DISABLE_DEPRECATED_EDITOR

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

      • SYSPROP_MEDIASIZE_DEBUG

        @SystemProperty(defaultValue="true")
public static final String SYSPROP_MEDIASIZE_DEBUG
        "de.uplanet.lucy.server.mediaSize.debug".
        See Also:
        Constant Field Values

    • Constructor Detail

      • Portal

        public Portal​(org.springframework.context.ApplicationContext p_appCtx)
        Standard constructor.
        Parameters:
        p_appCtx - The Spring application context.

    • Method Detail

      • 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.

      • 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.

      • 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 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 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.

      • 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:
        getOrgStructure()

      • 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.

      • 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.

      • 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_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 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 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.