Uiinfrastructure API Docs  
 

RequestData Members

RequestData overview

Public Instance Constructors

icon RequestData Constructor Creates a new RequestData object.

Public Instance Fields

iconm_Application application
iconm_asSpace Activity Space
iconm_bClearSession whether or not to clear the session after this request has finished.
iconm_bGetCacheNoID whether or not to get the item from the cache without knowing its ID
iconm_bGuest whether or not the current user is a guest user
iconm_dpNextDisplay display page
iconm_nSSOState SSO state
iconm_sControl Control name
iconm_sDevicesSpaceNameSuffix optional _WML, etc... devices suffix
iconm_SessionManager base session manager
iconm_smCache Activity Space Cache
iconm_smPersistentSandbox persistent sandbox session manager
iconm_smPersonalSettings personal settings session manager
iconm_smSandbox sandbox session manager
iconm_sPage display page name
iconm_sParentID parent space ID
iconm_sParentName parent space name
iconm_sSpaceID space id
iconm_sSubSpaceKey sub-space key
iconm_ttTimer A timer used to track various events in the requests lifetime
iconm_wdPageData web data
iconm_xpmCacheList list of items in the cache
iconm_xpRequest request
iconm_xpResponse response

Public Instance Methods

iconAppendRedirectURLTo302URL JF- Adds the redirect URL to the URL where we are about to 302 redirect to. (only appends the redirect URL if we are in security mode 1 and if we are redirecting to the login space)
iconClearUserSession Removes the User Session from the top-level session and on the Request Data object.
iconEquals (inherited from Object)Determines whether the specified Object is equal to the current Object.
iconGetHasExternalRedirect Helper method that checks whether or not an external redirect has been set on this object (i.e. "http://www.mysite.com").
iconGetHashCode (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.
iconGetHasHTTPRedirect Helper method that checks whether or not an HTTP redirect has been set on this object (i.e. Redirect.SetIsHTTPRedirect(true)).
iconGetQueryString Helper method that constructs and returns a redirect .
iconGetRedirect Helper method that constructs and returns a redirect.
iconGetRedirectURLFromQS JF- In security mode 1, returns the redirect URL (ASConstants.REDIRECT_AFTER_LOGIN) from the QS. (Returns null if it was not there.)
iconGetRequestFullURL Returns the request full URL. This method is used to avoid having to recalculate this URL, since the call to URLDecode is fairly expensive. This method calculates this value if it has not already been set on the RequestData object.
iconGetRequestURL Returns the request URL. This method is used in login code instead of m_xpRequest.GetRequestURL() so the SSO login code can make it look like the request came to server.pt instead of ssologin.pt.
iconGetRootSpaceName Accessor method for the root space name (without devices suffix).
iconGetSpaceName Accessor method for the full space name (including devices suffix, if applicable).
iconGetType (inherited from Object)Gets the Type of the current instance.
iconGetUserSession Gets the IPTSession from the Request Data object (originally off the top-level session).
iconLoadQSSettings This method loads various settings from the query string. If the query string parameters contain potential cross-site scripting attacks, this will throw an XPException.
iconRedirectWithMetaRefresh JF- We need to do a meta refresh instead of a 302 redirect if we are going from https to http in order to not see the browser security alert "You are about to be redirected to a connection that is not secure".
iconSetRedirect Helper method that sets request data based on a redirect
iconSetRequestFullURL Sets the request full URL. This method is used to avoid having to recalculate this URL, since the call to URLDecode is fairly expensive.
iconSetRequestURL Sets the request URL. This method is used by SSO login code to make it look like the request came to server.pt instead of ssologin.pt.
iconSetSpaceName This helper method sets the root space name and the real space name based upon the optional devices space name suffix (_WML, etc...). This should be used to avoid breaking the devices scheme.
iconSetUserSession sets the IPTSession on the top-level session and on the Request Data object.
iconToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Methods

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

See Also

RequestData Class | com.plumtree.uiinfrastructure.interpreter Namespace