Plumtree UI Infrastructure API  
 

ConfigHelper Members

ConfigHelper overview

Public Static Fields

GATEWAY_URL JF- This is to be able to identify a gatway URL
HTTP_SCHEME JF- HTTP Scheme
HTTPS_SCHEME JF- HTTPS Scheme
JSCOMPONENT_JSDATEPICKER 
JSCOMPONENT_JSPORTALMENU 
JSCOMPONENT_JSPORTLET 
JSCOMPONENT_JSROBOHELPER 
JSCOMPONENT_JSUTIL 
JSCOMPONENT_JSXML 

Public Static Methods

GetApplicationBaseURLOverloaded. 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.
GetApplicationBaseURLToAS JF- Returns the Application URL according to the URL Mapping and determines the security according to the space name in argument.
GetCommonJSIncludesOverloaded.  
GetConfigVariableAsIntOverloaded. Helper method to access an int variable from portalconfig.xml.
GetConfigVariableAsStringOverloaded. Helper method to access a String variable from portalconfig.xml.
GetConfigVariablesOverloaded. Helper method to access a String variable from portalconfig.xml.
GetFullAdminSiteURL Returns full URL to the admin site without any question mark.
GetHTMLDocType This method returns the document type specification for use with the HTMLPage objects created for each DisplayPage.
GetHTTPEntryPoint JF- Retuns the value of the HTTP Entry point from x_config.xml E.g.: server.pt
GetImageServerBaseURLOverloaded. This method used to return the Image Server Base URL. Example: http://server/imageserver/plumtree
GetImageserverConnectTimeout This method returns the imageserver connection timeout integer in seconds
GetImageServerRootURLOverloaded. This method used to return the Image Server Base URL. Example: http://server/imageserver/
GetIsDotNet Returns whether or not the current platform is .NET.
GetIsJava Returns whether or not the current platform is Java.
GetIsSpaceSecure Returns the security of the Activty Space.
GetJSIncluderComponentPath 
GetJSIncluderComponentVersion 
GetJSIncluderJSComponentIncludeOverloaded. HTMLElement with a script blocks including the javascript files for the given jscomponent.
GetJSIncluderVersionPrefix 
GetMainApplicationName This method returns the main application name
GetMainServerApplicationURL JF- Returns the Main server URL from x_config.xml
GetNormalizedBaseURL DLH- Helper method to return the normalized base URL for use in determining the correct application base url.
GetPerformanceCommentsEnabled Returns whether or not the performance metrics comments displayed in the HTML source at the end of each page are enabled. This value should be false if web caching and acceleration software is being used, otherwise pages will never have static content.
GetPerformanceStacktracesEnabled Returns whether or not the performance metrics stacktraces displayed in the HTML source at the end of each page are enabled. This value should be false if web caching and acceleration software is being used, otherwise pages will never have static content.
GetPortalImageServerBaseURLOverloaded. This method used to return the Portal Image Server Base URL.
GetPortalImageServerConnectionURL This method returns the Image Server Connection URL. This URL is used anytime the Portal Server needs to talk to the Image Server. This happens when retrieving JSRegistry information, for example.
GetPortalImageServerHelpURLOverloaded. This method used to return the Portal Image Server Help URL.
GetPortalImageServerImagesURLOverloaded. This method used to return the Portal Image Server Images URL.
GetPortalImageServerJavaScriptURLOverloaded. This method used to return the Portal Image Server JavaScript URL.
GetResourceManager 
GetSecurityMode Returns the security mode value from portalconfig.xml.
GetSharedImageServerBaseURLOverloaded. This method used to return the Shared Image Server Base URL.
GetSharedImageServerImagesURLOverloaded. This method used to return the Shared Image Server Images URL.
GetSharedImageServerJavaScriptURLOverloaded. This method used to return the Shared Image Server JavaScript URL.
GetSharedImageServerStylesURLOverloaded. This method used to return the Shared Image Server Styles URL.
GetStyleSheetsBaseURLOverloaded. Returns the base URL to the style sheets on the image server.
GetTypeDescrManager This method returns the class type description manager.
IsGoingToSubSpace Helper method to know whether the Redirect is going to a sub space of the current space of no.
IsInitialized Whether or not the config helper has been initialized properly.
IsLoginTokenSecure JF- Helper method to figure out if the login cookie should be secure or not.
IsSpaceSecured Returns true if this AS shoudl be accessed through HTTPS. Note: in security mode 2 and 3, true is always returned.
StaticInit Static init method. Can only be called once.

Public Instance Constructors

ConfigHelper Constructor Initializes a new instance of the ConfigHelper class.

Public Instance Methods

Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.

See Also

ConfigHelper Class | com.plumtree.uiinfrastructure.statichelpers Namespace