com.plumtree.portaluiinfrastructure.application.varpacks
Class PTSSOVarPack

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

All Implemented Interfaces:

IVarPack

public class PTSSOVarPack
extends BaseVarPack

VarPack for sso.xml, a file used to customize various SSO integrations. It reads in all settings in the file and stores them in a map, which is available via the GetVendorSettings method.

Author:

Mike Jahr

Field Summary

static java.lang.String	PORTAL_SSOVENDOR_COMPONENT_TYPE
static java.lang.String	VARPACK_ID The string ID of this variable package.

Constructor Summary

PTSSOVarPack()

Method Summary

protected void	ExpireContent() Expire content in this var pack.
protected java.lang.Object	GetValue(java.lang.String arg0) Get a value from the Var pack.
java.lang.String	GetVarPackID() Get the id of this var pack instance.
IXPEnumerator	GetVarPackKeys() Get an enumeration of keys in the var pack.
XPHashtable	GetVendorSettings() Returns an XPHashtable from String to XPArrayList, containing all the settings in the sso.xml config file.
protected void	Load() Load the var pack.
protected void	Reload() Reload the var pack.

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_SSOVENDOR_COMPONENT_TYPE

public static final java.lang.String PORTAL_SSOVENDOR_COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

PTSSOVarPack

public PTSSOVarPack()

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.

GetVarPackKeys

public IXPEnumerator GetVarPackKeys()

Description copied from class: BaseVarPack

Get an enumeration of keys in the var pack.

Specified by:

GetVarPackKeys in interface IVarPack

Specified by:

GetVarPackKeys in class BaseVarPack

Returns:

IXPEnumerator of keys in the var pack.

GetVendorSettings

public XPHashtable GetVendorSettings()

Returns an XPHashtable from String to XPArrayList, containing all the settings in the sso.xml config file.

Returns:

an XPHashtable of vendor settings

ExpireContent

protected void ExpireContent()

Description copied from class: BaseVarPack

Expire content in this var pack.

Specified by:

ExpireContent in class BaseVarPack

GetValue

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

Description copied from class: BaseVarPack

Get a value from the Var pack.

Specified by:

GetValue in class BaseVarPack

Parameters:

arg0 - The key for the lookup

Returns:

the value from the lookup (null if not found)

Load

protected void Load()

Description copied from class: BaseVarPack

Load the var pack. -- The ConfigPath is guaranteed to be set before this method is called (although it may be null or "").

Specified by:

Load in class BaseVarPack

Reload

protected void Reload()

Description copied from class: BaseVarPack

Reload the var pack.

Specified by:

Reload in class BaseVarPack