com.plumtree.portaluiinfrastructure.helpers
Class PTConfigService

java.lang.Object
  com.plumtree.uiinfrastructure.helpers.ConfigService
      com.plumtree.portaluiinfrastructure.helpers.PTConfigService

All Implemented Interfaces:

IPTConfigHelper, IConfigHelper

public class PTConfigService
extends ConfigService
implements IPTConfigHelper

A service that provides access to the pt config helper object.

Method Summary

java.lang.String	GetAbsoluteImageServerBaseURL(AActivitySpace _space, java.lang.String _strRequestURL)
java.lang.String	GetAbsoluteImageServerRootURL(AActivitySpace _space, java.lang.String _strRequestURL)
int	GetConfigVariableAsInt(java.lang.String strSection, java.lang.String strSubSection, java.lang.String strAttribute, AActivitySpace space) Helper method to access an int variable from x_config.xml.
java.lang.String	GetConfigVariableAsString(java.lang.String strSection, java.lang.String strSubSection, java.lang.String strAttribute, AActivitySpace space) Helper method to access a String variable from x_config.xml.
java.lang.String	GetConfigVariableAsString(java.lang.String strSection, java.lang.String strSubSection, java.lang.String strAttribute, IApplication app) Helper method to access a String variable from x_config.xml.
java.lang.Object[]	GetConfigVariables(java.lang.String strSection, java.lang.String strSubSection, java.lang.String strAttribute, AActivitySpace space) Helper method to access a String variable from x_config.xml.
java.lang.Object[]	GetConfigVariables(java.lang.String strSection, java.lang.String strSubSection, java.lang.String strAttribute, IApplication application) Helper method to access a String variable from x_config.xml.
IPTClassTypeDescManager	GetPTClassTypeDescrManager() Helper method to retrieve the ClassTypeDescrManager from the cache
static IPTConfigHelper	getPTInstance()
static void	setTestPTInstance(IPTConfigHelper testHelper) Unit tests should use this method to overwrite/teardown existing helper singleton.
boolean	UseFriendlyURLS(int classId, java.lang.String queryStringArgs) Checks whether the classId supports friendly URLs

Methods inherited from class com.plumtree.uiinfrastructure.helpers.ConfigService

GetApplicationBaseURL, GetApplicationBaseURL, GetApplicationBaseURL, GetApplicationBaseURLToAS, GetHTTPEntryPoint, GetImageServerBaseURL, getInstance, GetJSIncluderComponentPath, GetJSIncluderJSComponentInclude, GetJSIncluderJSComponentInclude, GetJSIncluderVersionPrefix, GetMainServerApplicationURL, GetNormalizedBaseURL, setTestInstance

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.plumtree.uiinfrastructure.helpers.IConfigHelper

GetApplicationBaseURL, GetApplicationBaseURL, GetApplicationBaseURL, GetApplicationBaseURLToAS, GetHTTPEntryPoint, GetImageServerBaseURL, GetJSIncluderComponentPath, GetJSIncluderJSComponentInclude, GetJSIncluderJSComponentInclude, GetJSIncluderVersionPrefix, GetMainServerApplicationURL, GetNormalizedBaseURL

Method Detail

getPTInstance

public static IPTConfigHelper getPTInstance()

Returns:

The singleton PT config helper.

setTestPTInstance

public static void setTestPTInstance(IPTConfigHelper testHelper)

Unit tests should use this method to overwrite/teardown existing helper singleton. DO NOT USE for production code. NOTE: When finished with a unit test, this should be set back to null so as not to interfere with other tests.

GetConfigVariableAsInt

public int GetConfigVariableAsInt(java.lang.String strSection,
                                  java.lang.String strSubSection,
                                  java.lang.String strAttribute,
                                  AActivitySpace space)

Description copied from interface: IPTConfigHelper

Helper method to access an int variable from x_config.xml.

Specified by:

GetConfigVariableAsInt in interface IPTConfigHelper

Parameters:

strSection - strSection

strSubSection - strSubSection

strAttribute - strAttribute

space - the current space

Returns:

int the requested variable

GetConfigVariableAsString

public java.lang.String GetConfigVariableAsString(java.lang.String strSection,
                                                  java.lang.String strSubSection,
                                                  java.lang.String strAttribute,
                                                  AActivitySpace space)

Description copied from interface: IPTConfigHelper

Helper method to access a String variable from x_config.xml.

Specified by:

GetConfigVariableAsString in interface IPTConfigHelper

Parameters:

strSection - strSection

strSubSection - strSubSection

strAttribute - strAttribute

space - the current space

Returns:

String the requested variable

GetConfigVariableAsString

public java.lang.String GetConfigVariableAsString(java.lang.String strSection,
                                                  java.lang.String strSubSection,
                                                  java.lang.String strAttribute,
                                                  IApplication app)

Description copied from interface: IPTConfigHelper

Helper method to access a String variable from x_config.xml.

Specified by:

GetConfigVariableAsString in interface IPTConfigHelper

Parameters:

strSection - strSection

strSubSection - strSubSection

strAttribute - strAttribute

Returns:

String the requested variable

GetConfigVariables

public java.lang.Object[] GetConfigVariables(java.lang.String strSection,
                                             java.lang.String strSubSection,
                                             java.lang.String strAttribute,
                                             AActivitySpace space)

Description copied from interface: IPTConfigHelper

Helper method to access a String variable from x_config.xml.

Specified by:

GetConfigVariables in interface IPTConfigHelper

Parameters:

strSection - strSection

strSubSection - strSubSection

strAttribute - strAttribute

space - the current space

Returns:

String the requested variable

GetConfigVariables

public java.lang.Object[] GetConfigVariables(java.lang.String strSection,
                                             java.lang.String strSubSection,
                                             java.lang.String strAttribute,
                                             IApplication application)

Description copied from interface: IPTConfigHelper

Helper method to access a String variable from x_config.xml.

Specified by:

GetConfigVariables in interface IPTConfigHelper

Parameters:

strSection - strSection

strSubSection - strSubSection

strAttribute - strAttribute

Returns:

String the requested variable

GetPTClassTypeDescrManager

public IPTClassTypeDescManager GetPTClassTypeDescrManager()

Description copied from interface: IPTConfigHelper

Helper method to retrieve the ClassTypeDescrManager from the cache

Specified by:

GetPTClassTypeDescrManager in interface IPTConfigHelper

Returns:

IPTClassTypeDescManager

GetAbsoluteImageServerBaseURL

public java.lang.String GetAbsoluteImageServerBaseURL(AActivitySpace _space,
                                                      java.lang.String _strRequestURL)

Specified by:

GetAbsoluteImageServerBaseURL in interface IPTConfigHelper

Parameters:

_space - The current Activity Space.

_strRequestURL - The current request URL.

Returns:

the absolute image server base URL.

GetAbsoluteImageServerRootURL

public java.lang.String GetAbsoluteImageServerRootURL(AActivitySpace _space,
                                                      java.lang.String _strRequestURL)

Specified by:

GetAbsoluteImageServerRootURL in interface IPTConfigHelper

Parameters:

_space - The current Activity Space.

_strRequestURL - The current request URL.

Returns:

the absolute image server root URL.

UseFriendlyURLS

public boolean UseFriendlyURLS(int classId,
                               java.lang.String queryStringArgs)

Description copied from interface: IPTConfigHelper

Checks whether the classId supports friendly URLs

Specified by:

UseFriendlyURLS in interface IPTConfigHelper

Returns: