de.uplanet.lucy.server.auxiliaries
Class Portal

java.lang.Object
  extended by de.uplanet.lucy.server.auxiliaries.Portal

public final class Portal
extends java.lang.Object

Version:
$Revision: 75057 $

Method Summary
 int getActiveSessionCount()
          Get the number of active sessions.
 java.lang.String getAnonymousUserGuid()
          Get the anonymous user's unique identifier.
 int getAnonymousUserOnlineCount()
          Get the number of sessions of the anonymous user.
 org.springframework.context.ApplicationContext getApplicationContext()
          Get the portal's Spring application context.
 java.lang.String getDefaultMenuGuid(java.lang.String p_strLayout)
          Get the GUID of the default menu of the given layout.
 int getFirstDayOfWeek()
          Get the portal's default first-day-of-week.
static Portal getInstance()
          Get the Portal instance.
 java.lang.String getLanguage()
          Get the portal's language.
 java.util.List<java.lang.String> getLanguages()
          Get the languages that are supported by this portal.
 java.util.List<java.lang.String> getLoginDomains()
          Get a list of available login domains.
 java.util.List<IUser> getMyBuddies(de.uplanet.jdbc.JdbcConnection p_conn, java.lang.String p_strName, java.lang.String p_strUserGuid)
           
 java.lang.String getName()
          Get the portal name (server/).
 int getNonAnonymousActiveSessionCount()
          Get the number of non-anonymous active sessions.
 NowValueHolder getNow()
          Get a value holder for the current date and time.
 java.lang.String getPortalName()
          Get the portal's display name.
 java.util.TimeZone getTimeZone()
          Get the portal's default time zone.
 java.util.List<java.lang.String> getUsersOnline(boolean p_bIncudeAnonymousUsers)
          Get a list that contains the unique identifiers of users that are online.
 boolean isChatEnabled()
          Test if chat is enabled globally.
 boolean isChatEnabled(java.lang.String p_strUserId)
          Test if chat is enabled for the given user.
 boolean isConcatenatedJsEnabled()
           
 boolean isCssCompressionEnabled()
           
 boolean isDemo()
           
 boolean isJsCompressionEnabled()
           
 boolean isMenuCloudSupported()
           
 boolean isMobileDevicesSupported()
           
 boolean isUserOnline(java.lang.String p_strUserId)
          Test if the specified user is online, i.e. if she has an associated session.
 java.util.List<IUser> listNonAnonymousUsersOnline()
          Get a list of all non-anonymous users that are online.
 java.util.List<IUser> listNonAnonymousUsersOnline(IFilter<IUser> p_filter)
          Get a list of all non-anonymous users that are online.
 double userActivity(java.lang.String p_strUserId)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static Portal getInstance()
Get the Portal instance.

Returns:
The instance.

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()
Get the portal's Spring application context.

Returns:
The Spring application context.

getNow

public NowValueHolder getNow()
Get a value holder for the current date and time.

Returns:
The value holder.

getPortalName

public java.lang.String getPortalName()
Get the portal's display name.

Returns:
The portal's display name.

getName

public java.lang.String getName()
Get the portal name (server/).

Returns:
The portal name.

isMobileDevicesSupported

public boolean isMobileDevicesSupported()

isMenuCloudSupported

public boolean isMenuCloudSupported()

getDefaultMenuGuid

public java.lang.String getDefaultMenuGuid(java.lang.String p_strLayout)
                                    throws java.lang.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:
java.lang.Exception

isDemo

public boolean isDemo()
Returns:
true if the portal runs in demo mode, or false otherwise.

getLanguage

public java.lang.String getLanguage()
Get the portal's language.

Returns:
The portal's language.

getLanguages

public java.util.List<java.lang.String> getLanguages()
Get the languages that are supported by this portal.

Returns:
A list of supported languages.

getLoginDomains

public java.util.List<java.lang.String> getLoginDomains()
Get a list of available login domains.

Returns:
An array containing the available login domains.

getTimeZone

public java.util.TimeZone getTimeZone()
Get the portal's default time zone.

Returns:
The default time zone.

getFirstDayOfWeek

public int getFirstDayOfWeek()
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 java.lang.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(java.lang.String p_strUserId)
Parameters:
p_strUserId - The user's unique identifier.
Returns:
A value that indicates the user's activity.

isUserOnline

public boolean isUserOnline(java.lang.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 java.util.List<java.lang.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 includes 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 java.util.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 java.util.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:
A - filter to be applied.
Returns:
A list of all non-anonymous users that are online.

isChatEnabled

public boolean isChatEnabled()
Test if chat is enabled globally.

Returns:
true if chat is globally enabled, or false otherwise.

isChatEnabled

public boolean isChatEnabled(java.lang.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 java.util.List<IUser> getMyBuddies(de.uplanet.jdbc.JdbcConnection p_conn,
                                          java.lang.String p_strName,
                                          java.lang.String p_strUserGuid)

isJsCompressionEnabled

public boolean isJsCompressionEnabled()

isCssCompressionEnabled

public boolean isCssCompressionEnabled()

isConcatenatedJsEnabled

public boolean isConcatenatedJsEnabled()


Last updated: 2011-01-27
Copyright 2000-2010 United Planet. All Rights Reserved.