com.plumtree.uiinfrastructure.application.varpacks
Class URLASMappingsVarPack

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

All Implemented Interfaces:

IVarPack

public class URLASMappingsVarPack
extends BaseVarPack

This VarPack is used to determine which Activity Space to go to if the space is not on the URL, based on what parameters are available on the URL.

Author:

Ricky Wong

Field Summary

static java.lang.String	PORTAL_URLASMAPPINGS_COMPONENT_TYPE
static java.lang.String	VARPACK_FILE The XML file this VarPack loads.
static java.lang.String	VARPACK_ID The String ID of this VarPack.

Constructor Summary

URLASMappingsVarPack()

Method Summary

protected void	ExpireContent() You cannot expire the x_config.xml content.
IXPEnumerator	GetParameterMapKeys() Returns an enumeration of the Parameter map keys.
java.lang.String	GetParameterMapValue(java.lang.String strKey) Returns the Parameter map value for the given key.
protected java.lang.Object	GetValue(java.lang.String arg0) This method will return a chunk of from one level under the PTConfig 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.
java.lang.String	GetVarPackXMLFileName()
protected void	Load() Loads in the same manner as XMLBaseVarPack, but then we organize the data for URLASMapping specific purposes.
protected void	Reload() This method reloads the 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 VarPack.

See Also:

Constant Field Values

VARPACK_FILE

public static final java.lang.String VARPACK_FILE

The XML file this VarPack loads.

See Also:

Constant Field Values

PORTAL_URLASMAPPINGS_COMPONENT_TYPE

public static final java.lang.String PORTAL_URLASMAPPINGS_COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

URLASMappingsVarPack

public URLASMappingsVarPack()

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.

GetVarPackXMLFileName

public java.lang.String GetVarPackXMLFileName()

Load

protected void Load()

Loads in the same manner as XMLBaseVarPack, but then we organize the data for URLASMapping specific purposes.

Specified by:

Load in class BaseVarPack

GetParameterMapKeys

public IXPEnumerator GetParameterMapKeys()

Returns an enumeration of the Parameter map keys.

Returns:

IXPEnumerator of the Parameter map keys.

GetParameterMapValue

public java.lang.String GetParameterMapValue(java.lang.String strKey)

Returns the Parameter map value for the given key.

Parameters:

strKey - The Parameter key.

Returns:

The Parameter value.

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()

GetValue

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

This method will return a chunk of from one level under the PTConfig 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)

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()

Reload

protected void Reload()

This method reloads the XML file into memory. It delegates to Load(). This may not be entirely threadsafe.

Specified by:

Reload in class BaseVarPack

See Also:

BaseVarPack.Reload()