Package lumis.portal

Class PortalConfiguration

java.lang.Object

lumis.portal.PortalConfiguration

All Implemented Interfaces:

java.util.EventListener, ServletContextListener

public class PortalConfiguration
extends java.lang.Object
implements ServletContextListener

Encapsulates the portal configuration read from the web.xml file. Has an alternative constructor (PortalConfiguration(String)) to be used outside the web container.

Since:

4.0.2

Version:

$Revision: 26582 $ $Date: 2024-08-20 13:23:41 -0300 (Tue, 20 Aug 2024) $

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PortalConfiguration.SystemBean	Bean used as system variable in lumisDataPath EL evaluation.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SYSTEM_PROPERTY_LUMIS_DATA_PATH	System property name for Lumis data path.

Constructor Summary

Constructors

Constructor	Description
PortalConfiguration()	Constructor for the web container to call it as a ServletContextListener.
PortalConfiguration(java.lang.String lumisDataDir)	Constructor for custom configuration outside a web container.
PortalConfiguration(java.lang.String lumisDataDir, boolean initialize)	Constructor for custom configuration outside a web container.

Method Summary

Modifier and Type	Method	Description
void	contextDestroyed(ServletContextEvent event)	Cleanup the current portal configuration, if initialized through the web.xml.
void	contextInitialized(ServletContextEvent event)	Initializes the current portal configuration.
static PortalConfiguration	getCurrentConfiguration()	Returns the current portal configuration.
java.lang.String	getLumisDataPath()	Returns the lumis data path.
void	init(ServletContextEvent event)
boolean	isDevelopmentMode()	Indicates if the portal is running in development mode.
static boolean	isInitialized()	Returns whether the LumisXP core system completed its runtime initialization.
static void	setCurrentConfiguration(PortalConfiguration currentConfiguration)	Method for setting a custom configuration outside a web container.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYSTEM_PROPERTY_LUMIS_DATA_PATH

public static final java.lang.String SYSTEM_PROPERTY_LUMIS_DATA_PATH

System property name for Lumis data path.

See Also:

Constant Field Values

Constructor Detail

PortalConfiguration

public PortalConfiguration()

Constructor for the web container to call it as a ServletContextListener.

PortalConfiguration

public PortalConfiguration(java.lang.String lumisDataDir)

Constructor for custom configuration outside a web container. The portal is initialized as a result of a call to this constructor.

See Also:

PortalConfiguration(String, boolean)

PortalConfiguration

public PortalConfiguration(java.lang.String lumisDataDir,
                           boolean initialize)

Constructor for custom configuration outside a web container.

Parameters:

lumisDataDir - the path for the portal lumisdata directory.

initialize - if true, the portal will be initialized. Use false only when performing operations without an existing database, such as initializing the portal database.

Since:

4.0.7

Method Detail

contextInitialized

public void contextInitialized(ServletContextEvent event)

Initializes the current portal configuration.

Specified by:

contextInitialized in interface ServletContextListener

Parameters:

event - instance of ServletContextEvent

Since:

5.6.0

init

public void init(ServletContextEvent event)

isInitialized

public static boolean isInitialized()

Returns whether the LumisXP core system completed its runtime initialization.

Returns:

true if it is initialized, false otherwise.

Since:

14.1.0

contextDestroyed

public void contextDestroyed(ServletContextEvent event)

Cleanup the current portal configuration, if initialized through the web.xml.

Specified by:

contextDestroyed in interface ServletContextListener

getLumisDataPath

public java.lang.String getLumisDataPath()

Returns the lumis data path.

isDevelopmentMode

public boolean isDevelopmentMode()

Indicates if the portal is running in development mode.

Since:

4.2.0

getCurrentConfiguration

public static PortalConfiguration getCurrentConfiguration()

Returns the current portal configuration.

setCurrentConfiguration

public static void setCurrentConfiguration(PortalConfiguration currentConfiguration)

Method for setting a custom configuration outside a web container.