com.plumtree.uiinfrastructure.application.varpacks
Class ConfigVarPack

java.lang.Object
  com.plumtree.uiinfrastructure.web.BaseVarPack
      com.plumtree.uiinfrastructure.application.varpacks.ConfigVarPack

All Implemented Interfaces:

IVarPack

Direct Known Subclasses:

PTConfigVarPack

public class ConfigVarPack
extends BaseVarPack

This varpack contains the base application data. This is read from the base x_config.xml file.

Field Summary

static java.lang.String	APP_PLATFORM_DOT_NET
static java.lang.String	APP_PLATFORM_JAVA
protected boolean	m_bIsDotNet
protected boolean	m_bIsJava
protected XPHashtable	m_htConfigXMLSettings JF- This XPHashtable contains all the settings from x_config.xml (keys and values) We need it for the Memory Debug page where we need to be able to iterate through the keys to display all the values.
static java.lang.String	PORTAL_AUTHENTICATION_COMPONENT_TYPE
static java.lang.String	PORTAL_CACHEDSETTINGS_COMPONENT_TYPE
static java.lang.String	PORTAL_INTERNATIONAL_COMPONENT_TYPE
static java.lang.String	PORTAL_MAINURLS_COMPONENT_TYPE
static java.lang.String	PORTAL_PERSONALSETTINGS_COMPONENT_TYPE
static java.lang.String	PORTAL_SECURITY_COMPONENT_TYPE
static java.lang.String	PORTAL_SERVICEURLS_COMPONENT_TYPE
static java.lang.String	PORTAL_SYSTEMPROPERTIES_COMPONENT_TYPE
static java.lang.String	PORTAL_URLMAPPING_COMPONENT_TYPE
static int	SECURITY_MODE_NO_SSL JF- Security Mode: No SSL check.
static int	SECURITY_MODE_SSL_ACCELERATOR JF- Security Mode: SSL on every AS using an SSL Accelerator hardware.
static int	SECURITY_MODE_SSL_ALL JF- Security Mode: SSL on every AS.
static int	SECURITY_MODE_SSL_CRITICAL_AS_ONLY JF- Security Mode: SSL on some AS only.
static java.lang.String	VARPACK_ID The string ID of this variable package.

Constructor Summary

ConfigVarPack(java.lang.String _strPlatform)
Constructor for ConfigVarPack.

Method Summary

protected void	ExpireContent() You cannot expire the x_config.xml content.
int	GetConfigValueAsInt(java.lang.String _strSection, java.lang.String _strSubSection, java.lang.String _strAttribute)
java.lang.String	GetConfigValueAsString(java.lang.String _strSection, java.lang.String _strSubSection, java.lang.String _strAttribute)
java.lang.Object[]	GetConfigValues(java.lang.String _strSection, java.lang.String _strSubSection, java.lang.String _strAttribute)
XPHashtable	GetConfigXMLSettings() Returns the XPHashtable with all the setings from config.xml
boolean	GetIsDotNet() Returns whether or not the current platform is .NET.
boolean	GetIsJava() Returns whether or not the current platform is Java.
protected java.lang.Object	GetValue(java.lang.String arg0) This method will return a chunk of from one level under the Config node.
java.lang.String	GetVarPackID() Get the id of this var pack instance.
IXPEnumerator	GetVarPackKeys() This method will return an enumeration of the top level nodes in the XML tree that is x_config.xml.
protected java.lang.String	InternalGetConfigValueAsString(java.lang.String _strSection, java.lang.String _strSubSection, java.lang.String _strAttribute, boolean bReportErrors) This is an internal helper method.
protected java.lang.Object[]	InternalGetConfigValues(java.lang.String _strSection, java.lang.String _strSubSection, java.lang.String _strAttribute, boolean bReportErrors) This is an internal helper method
protected static XPElement	InternalGetXMLElement(XPDocument _xmlDoc, java.lang.String _strSection, java.lang.String _strSubSection) Helper method that returns an xml element consisting of all the XML in the specified section and subsection.
protected void	Load() This method loads the x_config.xml file into memory.
protected void	LoadComponentSettings(IOKComponent component, java.lang.String sectionName) Helper method to load settings in the specified OpenConfig component into the XPHashtable.
protected void	Reload() This method reloads the x_config.xml file into memory.

Methods inherited from class com.plumtree.uiinfrastructure.web.BaseVarPack

CanReloadVarPackFromUI, ExpireVarPackContent, GetConfigPath, GetExpireTimeout, GetLastAccessedTimeStamp, GetReloadInterval, GetVarPackValue, IsLoaded, LoadVarPack, ReloadVarPack, SetExpireTimeout, SetReloadInterval

Methods inherited from class java.lang.Object

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

Field Detail

VARPACK_ID

public static final java.lang.String VARPACK_ID

The string ID of this variable package.

See Also:

Constant Field Values

PORTAL_MAINURLS_COMPONENT_TYPE

public static final java.lang.String PORTAL_MAINURLS_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_SERVICEURLS_COMPONENT_TYPE

public static final java.lang.String PORTAL_SERVICEURLS_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_SYSTEMPROPERTIES_COMPONENT_TYPE

public static final java.lang.String PORTAL_SYSTEMPROPERTIES_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_URLMAPPING_COMPONENT_TYPE

public static final java.lang.String PORTAL_URLMAPPING_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_PERSONALSETTINGS_COMPONENT_TYPE

public static final java.lang.String PORTAL_PERSONALSETTINGS_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_CACHEDSETTINGS_COMPONENT_TYPE

public static final java.lang.String PORTAL_CACHEDSETTINGS_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_AUTHENTICATION_COMPONENT_TYPE

public static final java.lang.String PORTAL_AUTHENTICATION_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_SECURITY_COMPONENT_TYPE

public static final java.lang.String PORTAL_SECURITY_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_INTERNATIONAL_COMPONENT_TYPE

public static final java.lang.String PORTAL_INTERNATIONAL_COMPONENT_TYPE

See Also:

Constant Field Values

m_bIsJava

protected boolean m_bIsJava

m_bIsDotNet

protected boolean m_bIsDotNet

m_htConfigXMLSettings

protected XPHashtable m_htConfigXMLSettings

JF- This XPHashtable contains all the settings from x_config.xml (keys and values) We need it for the Memory Debug page where we need to be able to iterate through the keys to display all the values.

SECURITY_MODE_NO_SSL

public static final int SECURITY_MODE_NO_SSL

JF- Security Mode: No SSL check.

See Also:

Constant Field Values

SECURITY_MODE_SSL_CRITICAL_AS_ONLY

public static final int SECURITY_MODE_SSL_CRITICAL_AS_ONLY

JF- Security Mode: SSL on some AS only. List of AS defined in SecureActivitySpaces.xml.

See Also:

Constant Field Values

SECURITY_MODE_SSL_ALL

public static final int SECURITY_MODE_SSL_ALL

JF- Security Mode: SSL on every AS.

See Also:

Constant Field Values

SECURITY_MODE_SSL_ACCELERATOR

public static final int SECURITY_MODE_SSL_ACCELERATOR

JF- Security Mode: SSL on every AS using an SSL Accelerator hardware.

See Also:

Constant Field Values

APP_PLATFORM_DOT_NET

public static final java.lang.String APP_PLATFORM_DOT_NET

See Also:

Constant Field Values

APP_PLATFORM_JAVA

public static final java.lang.String APP_PLATFORM_JAVA

See Also:

Constant Field Values

Constructor Detail

ConfigVarPack

public ConfigVarPack(java.lang.String _strPlatform)

Constructor for ConfigVarPack.

Parameters:

__strPlatform - The current platform "Java" or "DotNet")

Method Detail

GetVarPackID

public java.lang.String GetVarPackID()

Description copied from class: BaseVarPack

Get the id of this var pack instance. Note: VarPackManager only has 1 key per var pack. This should be unquie per class instance.

Specified by:

GetVarPackID in interface IVarPack

Specified by:

GetVarPackID in class BaseVarPack

Returns:

A unique key to store the var pack in the varpackmanager.

See Also:

IVarPack.GetVarPackID()

GetConfigXMLSettings

public XPHashtable GetConfigXMLSettings()

Returns the XPHashtable with all the setings from config.xml

Returns:

XPHashtable

GetIsJava

public boolean GetIsJava()

Returns whether or not the current platform is Java.

Returns:

boolean true implies Java.

GetIsDotNet

public boolean GetIsDotNet()

Returns whether or not the current platform is .NET.

Returns:

boolean true implies .NET.

GetConfigValueAsInt

public int GetConfigValueAsInt(java.lang.String _strSection,
                               java.lang.String _strSubSection,
                               java.lang.String _strAttribute)

Parameters:

_strSection -

_strSubSection -

_strAttribute -

Returns:

GetConfigValueAsString

public java.lang.String GetConfigValueAsString(java.lang.String _strSection,
                                               java.lang.String _strSubSection,
                                               java.lang.String _strAttribute)

Parameters:

_strSection -

_strSubSection -

_strAttribute -

Returns:

InternalGetConfigValueAsString

protected java.lang.String InternalGetConfigValueAsString(java.lang.String _strSection,
                                                          java.lang.String _strSubSection,
                                                          java.lang.String _strAttribute,
                                                          boolean bReportErrors)

This is an internal helper method.

Parameters:

xmlDoc - the base xml doc to read the values from

_strSection -

_strSubSection -

_strAttribute -

bReportErrors - true implies report errors

Returns:

String null if not found

GetConfigValues

public java.lang.Object[] GetConfigValues(java.lang.String _strSection,
                                          java.lang.String _strSubSection,
                                          java.lang.String _strAttribute)

Parameters:

_strSection -

_strSubSection -

_strAttribute -

Returns:

InternalGetConfigValues

protected java.lang.Object[] InternalGetConfigValues(java.lang.String _strSection,
                                                     java.lang.String _strSubSection,
                                                     java.lang.String _strAttribute,
                                                     boolean bReportErrors)

This is an internal helper method

Parameters:

xmlDoc - the base xml doc to read the values from

_strSection -

_strSubSection -

_strAttribute -

bReportErrors - true implies report errors

Returns:

InternalGetXMLElement

protected static XPElement InternalGetXMLElement(XPDocument _xmlDoc,
                                                 java.lang.String _strSection,
                                                 java.lang.String _strSubSection)

Helper method that returns an xml element consisting of all the XML in the specified section and subsection. Returns null if no such section or subsection exists

Parameters:

_xmlDoc - the XPDocument

_strSection -

_strSubSection -

Returns:

GetVarPackKeys

public IXPEnumerator GetVarPackKeys()

This method will return an enumeration of the top level nodes in the XML tree that is x_config.xml.

Specified by:

GetVarPackKeys in interface IVarPack

Specified by:

GetVarPackKeys in class BaseVarPack

Returns:

IXPEnumerator of keys in the var pack.

See Also:

IVarPack.GetVarPackKeys()

ExpireContent

protected void ExpireContent()

You cannot expire the x_config.xml content. You can only reload it. This method does nothing.

Specified by:

ExpireContent in class BaseVarPack

See Also:

com.plumtree.xpsupport.web.BaseVarPack#ExpireContent()

GetValue

protected java.lang.Object GetValue(java.lang.String arg0)

This method will return a chunk of from one level under the Config node.

Specified by:

GetValue in class BaseVarPack

Parameters:

arg0 - The key for the lookup

Returns:

the value from the lookup (null if not found)

See Also:

com.plumtree.xpsupport.web.BaseVarPack#GetValue(String)

Load

protected void Load()

This method loads the x_config.xml file into memory.

Specified by:

Load in class BaseVarPack

See Also:

com.plumtree.xpsupport.web.BaseVarPack#Load()

LoadComponentSettings

protected void LoadComponentSettings(IOKComponent component,
                                     java.lang.String sectionName)

Helper method to load settings in the specified OpenConfig component into the XPHashtable.

Parameters:

component -

Reload

protected void Reload()

This method reloads the x_config.xml file into memory. It clears the current data rather than delegating to Load().

Specified by:

Reload in class BaseVarPack

See Also:

com.plumtree.xpsupport.web.BaseVarPack#Reload()