com.plumtree.uiinfrastructure.helpers
Interface IConfigHelper

All Known Subinterfaces:

IPTConfigHelper

All Known Implementing Classes:

ConfigService, PTConfigService

public interface IConfigHelper

Method Summary

java.lang.String	GetApplicationBaseURL(AActivitySpace asSpace) JF- Returns the Application URL according to the URL Mapping.
java.lang.String	GetApplicationBaseURL(java.lang.String _sNormalizedBaseURL) JF- Returns the Application URL according to the URL Mapping.
java.lang.String	GetApplicationBaseURL(java.lang.String _sNormalizedBaseURL, boolean _bSecure) JF- Returns the Application URL according to the URL Mapping and the security.
java.lang.String	GetApplicationBaseURLToAS(java.lang.String _sNormalizedBaseURL, java.lang.String _sASName, boolean _bIsSubSpace) JF- Returns the Application URL according to the URL Mapping and determines the security according to the space name in argument.
java.lang.String	GetHTTPEntryPoint() JF- Returns the value of the HTTP Entry point from x_config.xml E.g.: server.pt
java.lang.String	GetImageServerBaseURL(AActivitySpace asSpace) This method used to return the Portal Image Server Base URL.
java.lang.String	GetJSIncluderComponentPath(java.lang.String strJSComponentName, java.lang.String strImageServerURL)
HTMLElementCollection	GetJSIncluderJSComponentInclude(java.lang.String strJSComponentName, AActivitySpace owner) HTMLElement with a script blocks including the javascript files for the given jscomponent.
HTMLElementCollection	GetJSIncluderJSComponentInclude(java.lang.String strJSComponentName, boolean bEnableDebug, AActivitySpace owner, XPLocale locale) HTMLElement with a script blocks including the javascript files for the given jscomponent.
java.lang.String	GetJSIncluderVersionPrefix(java.lang.String strJSComponentName)
java.lang.String	GetMainServerApplicationURL(boolean _bIsSecure) JF- Returns the Main server URL from x_config.xml
java.lang.String	GetNormalizedBaseURL(java.lang.String _sURL) DLH- Helper method to return the normalized base URL for use in determining the correct application base url.

Method Detail

GetApplicationBaseURL

java.lang.String GetApplicationBaseURL(java.lang.String _sNormalizedBaseURL,
                                       boolean _bSecure)

JF- Returns the Application URL according to the URL Mapping and the security. Warning: depending on the security mode, the security in argument might not make sense. E.g.: in mode 0, it doesn't make sense to request the secure URL (and it might just return an empty URL) The normalized base URL is available either cached on the AActivitySpace or by calling ConfigHelper.GetNormalizedBaseURL with the current request URL.

Parameters:

_sNormalizedBaseURL - the normalized base URL from the current request.

_bSecure - HTTP or HTTPS

Returns:

String

GetApplicationBaseURL

java.lang.String GetApplicationBaseURL(AActivitySpace asSpace)

JF- Returns the Application URL according to the URL Mapping. Warning: In mode 1, it returns the non secure URL by default.

Parameters:

AActivitySpace - the current activity space.

Returns:

String

GetApplicationBaseURL

java.lang.String GetApplicationBaseURL(java.lang.String _sNormalizedBaseURL)

JF- Returns the Application URL according to the URL Mapping. Warning: In mode 1, it returns the non secure URL by default. GetApplicationBaseURL(AActivitySpace) should be used if possible.

Parameters:

_sNormalizedBaseURL - Normalized Base URL from the AActivity Space (or ConfigHelper.GetNormalizedBaseURL).

Returns:

String

GetApplicationBaseURLToAS

java.lang.String GetApplicationBaseURLToAS(java.lang.String _sNormalizedBaseURL,
                                           java.lang.String _sASName,
                                           boolean _bIsSubSpace)

JF- Returns the Application URL according to the URL Mapping and determines the security according to the space name in argument.

Parameters:

_sNormalizedBaseURL - Normalized Base URL from the AActivity Space. (or ConfigHelper.GetNormalizedBaseURL).

_sASName - Name of the destination Activity Space

_bIsSubSpace - Is the target AS a sub space?

Returns:

String

GetMainServerApplicationURL

java.lang.String GetMainServerApplicationURL(boolean _bIsSecure)

JF- Returns the Main server URL from x_config.xml

Parameters:

_bIsSecure - HTTP or HTTPS

Returns:

String

GetHTTPEntryPoint

java.lang.String GetHTTPEntryPoint()

JF- Returns the value of the HTTP Entry point from x_config.xml E.g.: server.pt

Returns:

String

GetJSIncluderVersionPrefix

java.lang.String GetJSIncluderVersionPrefix(java.lang.String strJSComponentName)

Parameters:

strJSComponentName - JSComponent name included through JSIncluder Example: " jsxml" or "jsutil"

Returns:

GetJSIncluderComponentPath

java.lang.String GetJSIncluderComponentPath(java.lang.String strJSComponentName,
                                            java.lang.String strImageServerURL)

Parameters:

strJSComponentName -

strImageServerURL -

Returns:

the path to a particular JS component

GetJSIncluderJSComponentInclude

HTMLElementCollection GetJSIncluderJSComponentInclude(java.lang.String strJSComponentName,
                                                      AActivitySpace owner)

HTMLElement with a script blocks including the javascript files for the given jscomponent.

Parameters:

strJSComponentName - JSComponent name. For example "jsxml" or "jsutil", the common components have constants defined in ConfigHelper.

owner - Current activityspace

Returns:

GetJSIncluderJSComponentInclude

HTMLElementCollection GetJSIncluderJSComponentInclude(java.lang.String strJSComponentName,
                                                      boolean bEnableDebug,
                                                      AActivitySpace owner,
                                                      XPLocale locale)

HTMLElement with a script blocks including the javascript files for the given jscomponent.

Parameters:

strJSComponentName - JSComponent name. For example "jsxml" or "jsutil", the common components have constants defined in ConfigHelper.

owner - Current activityspace

Returns:

GetImageServerBaseURL

java.lang.String GetImageServerBaseURL(AActivitySpace asSpace)

This method used to return the Portal Image Server Base URL.

Parameters:

AActivitySpace - the space that this image is in.

Returns:

String the Portal image server base URL.

GetNormalizedBaseURL

java.lang.String GetNormalizedBaseURL(java.lang.String _sURL)

DLH- Helper method to return the normalized base URL for use in determining the correct application base url.

Parameters:

_sURL -

Returns:

String the normalized base URL