com.plumtree.portaluiinfrastructure.application.varpacks
Class PTConfigVarPack

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

All Implemented Interfaces:

IVarPack

public class PTConfigVarPack
extends ConfigVarPack

This VarPack contains the Plumtree Application data. This extends the base config var pack, and adds extra data from the ptconfig.xml file.

Author:

John Osborne

Field Summary

static java.lang.String	PORTAL_ADMINISTRATION_COMPONENT_TYPE
static java.lang.String	PORTAL_COMMUNITIES_COMPONENT_TYPE
static java.lang.String	PORTAL_CRAWLERS_COMPONENT_TYPE
static java.lang.String	PORTAL_DOCUMENTS_COMPONENT_TYPE
static java.lang.String	PORTAL_FAILOVER_COMPONENT_TYPE
static java.lang.String	PORTAL_GATEWAY_COMPONENT_TYPE
static java.lang.String	PORTAL_INVITATIONS_COMPONENT_TYPE
static java.lang.String	PORTAL_SEARCH_COMPONENT_TYPE
static java.lang.String	PORTAL_STYLE_COMPONENT_TYPE

Fields inherited from class com.plumtree.uiinfrastructure.application.varpacks.ConfigVarPack

APP_PLATFORM_DOT_NET, APP_PLATFORM_JAVA, m_bIsDotNet, m_bIsJava, m_htConfigXMLSettings, PORTAL_AUTHENTICATION_COMPONENT_TYPE, PORTAL_CACHEDSETTINGS_COMPONENT_TYPE, PORTAL_INTERNATIONAL_COMPONENT_TYPE, PORTAL_MAINURLS_COMPONENT_TYPE, PORTAL_PERSONALSETTINGS_COMPONENT_TYPE, PORTAL_SECURITY_COMPONENT_TYPE, PORTAL_SERVICEURLS_COMPONENT_TYPE, PORTAL_SYSTEMPROPERTIES_COMPONENT_TYPE, PORTAL_URLMAPPING_COMPONENT_TYPE, SECURITY_MODE_NO_SSL, SECURITY_MODE_SSL_ACCELERATOR, SECURITY_MODE_SSL_ALL, SECURITY_MODE_SSL_CRITICAL_AS_ONLY, VARPACK_ID

Constructor Summary

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

Method Summary

java.lang.String	GetSSOBaseURL() JF- Returns the SSO Base URL.
java.lang.String	GetSSORelativeURL() JF- Returns the SSO relative URL.
java.lang.String	GetVarPackID() Get the id of this var pack instance.
XPElement	GetXMLElement(java.lang.String _strSection, java.lang.String _strSubSection) Returns an xml element consisting of all the XML in the specified section and subsection.
protected void	Load() This method loads the PTconfig.xml file into memory.
protected void	Reload() This method reloads the PTconfig.xml file into memory.

Methods inherited from class com.plumtree.uiinfrastructure.application.varpacks.ConfigVarPack

ExpireContent, GetConfigValueAsInt, GetConfigValueAsString, GetConfigValues, GetConfigXMLSettings, GetIsDotNet, GetIsJava, GetValue, GetVarPackKeys, InternalGetConfigValueAsString, InternalGetConfigValues, InternalGetXMLElement, LoadComponentSettings

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

PORTAL_DOCUMENTS_COMPONENT_TYPE

public static final java.lang.String PORTAL_DOCUMENTS_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_CRAWLERS_COMPONENT_TYPE

public static final java.lang.String PORTAL_CRAWLERS_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_SEARCH_COMPONENT_TYPE

public static final java.lang.String PORTAL_SEARCH_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_STYLE_COMPONENT_TYPE

public static final java.lang.String PORTAL_STYLE_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_COMMUNITIES_COMPONENT_TYPE

public static final java.lang.String PORTAL_COMMUNITIES_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_ADMINISTRATION_COMPONENT_TYPE

public static final java.lang.String PORTAL_ADMINISTRATION_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_FAILOVER_COMPONENT_TYPE

public static final java.lang.String PORTAL_FAILOVER_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_INVITATIONS_COMPONENT_TYPE

public static final java.lang.String PORTAL_INVITATIONS_COMPONENT_TYPE

See Also:

Constant Field Values

PORTAL_GATEWAY_COMPONENT_TYPE

public static final java.lang.String PORTAL_GATEWAY_COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

PTConfigVarPack

public PTConfigVarPack(java.lang.String _strPlatform)

Constructor for PTConfigVarPack.

Parameters:

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

Method Detail

GetSSOBaseURL

public java.lang.String GetSSOBaseURL()

JF- Returns the SSO Base URL. E.g.: /portal/SSOServlet

Returns:

String

GetSSORelativeURL

public java.lang.String GetSSORelativeURL()

JF- Returns the SSO relative URL. E.g.: SSOServlet

Returns:

String

GetXMLElement

public XPElement GetXMLElement(java.lang.String _strSection,
                               java.lang.String _strSubSection)

Returns an xml element consisting of all the XML in the specified section and subsection. Returns null if no such section or subsection exists. It first tries to get the element from the base class file, and then from the PTConfig.xml file. WARNING: if the element exists in both the base x_config.xml file and the PTconfig.xml file, only the element from the base x_config.xml file will be returned.

Parameters:

_strSection -

_strSubSection -

Returns:

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

Overrides:

GetVarPackID in class ConfigVarPack

Returns:

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

See Also:

IVarPack.GetVarPackID()

Load

protected void Load()

This method loads the PTconfig.xml file into memory.

Overrides:

Load in class ConfigVarPack

See Also:

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

Reload

protected void Reload()

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

Overrides:

Reload in class ConfigVarPack

See Also:

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