com.plumtree.uiinfrastructure.application.varpacks
Class DevicesVarPack

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

All Implemented Interfaces:

IVarPack

public class DevicesVarPack
extends BaseVarPack

This var pack handles all of the different devices and markup formats that we support.

Author:

SudhaS

Field Summary

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

Constructor Summary

DevicesVarPack()

Method Summary

protected void	ExpireContent() You cannot expire the x_config.xml content.
java.lang.String	GetApplicationBaseURL() This method returns the Application Base URL.
java.lang.String	GetDevice(java.lang.String strAcceptsHeader, java.lang.String strUserAgentHeader) This method determines the proper markup type to use for whatever device the user is using.
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.
protected java.lang.String	InternalGetDeviceValueAsString(java.lang.String _strSection, java.lang.String _strSubSection) This is an internal helper method.
protected java.lang.Object[]	InternalGetDeviceValues(java.lang.String _strSection) This is an internal helper method
protected void	Load() This method loads the x_config.xml file into memory.
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_DEVICES_COMPONENT_TYPE

public static final java.lang.String PORTAL_DEVICES_COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

DevicesVarPack

public DevicesVarPack()

Method Detail

GetApplicationBaseURL

public java.lang.String GetApplicationBaseURL()

This method returns the Application Base URL. This is for easy access. You could just call GetConfigValueAsString with the appropriate parameters.

Returns:

GetDevice

public java.lang.String GetDevice(java.lang.String strAcceptsHeader,
                                  java.lang.String strUserAgentHeader)

This method determines the proper markup type to use for whatever device the user is using. This uses the accepts header and locates the first supported markup format that the device prefers.

Parameters:

String - the accepts header for the device

Returns:

String the code for the markup that should] be displayed. null implies standard HTML.

InternalGetDeviceValueAsString

protected java.lang.String InternalGetDeviceValueAsString(java.lang.String _strSection,
                                                          java.lang.String _strSubSection)

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

InternalGetDeviceValues

protected java.lang.Object[] InternalGetDeviceValues(java.lang.String _strSection)

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:

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

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

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

Reload

protected void Reload()

This method reloads the x_config.xml file into memory. It delegates to Load().

Specified by:

Reload in class BaseVarPack

See Also:

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