Plumtree UI Infrastructure API  
 

RequestData Members

RequestData overview

Public Instance Constructors

RequestData Constructor Creates a new RequestData object.

Public Instance Fields

m_Application application
m_asSpace Activity Space
m_bClearSession whether or not to clear the session after this request has finished.
m_bGetCacheNoID whether or not to get the item from the cache without knowing its ID
m_bGuest whether or not the current user is a guest user
m_dpNextDisplay display page
m_nSSOState SSO state
m_sControl Control name
m_sDevicesSpaceNameSuffix optional _WML, etc... devices suffix
m_SessionManager base session manager
m_smCache Activity Space Cache
m_smPersistentSandbox persistent sandbox session manager
m_smPersonalSettings personal settings session manager
m_smSandbox sandbox session manager
m_sPage display page name
m_sParentID parent space ID
m_sParentName parent space name
m_sSpaceID space id
m_sSubSpaceKey sub-space key
m_ttTimer A timer used to track various events in the requests lifetime
m_wdPageData web data
m_xpmCacheList list of items in the cache
m_xpRequest request
m_xpResponse response

Public Instance Methods

AppendRedirectURLTo302URL 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)
ClearUserSession Removes the User Session from the top-level session and on the Request Data object.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetHasExternalRedirect Helper method that checks whether or not an external redirect has been set on this object (i.e. "http://www.mysite.com").
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.
GetHasHTTPRedirect Helper method that checks whether or not an HTTP redirect has been set on this object (i.e. Redirect.SetIsHTTPRedirect(true)).
GetQueryString Helper method that constructs and returns a redirect .
GetRedirect Helper method that constructs and returns a redirect.
GetRedirectURLFromQS JF- In security mode 1, returns the redirect URL (ASConstants.REDIRECT_AFTER_LOGIN) from the QS. (Returns null if it was not there.)
GetRequestFullURL 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.
GetRequestURL 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.
GetRootSpaceName Accessor method for the root space name (without devices suffix).
GetSpaceName Accessor method for the full space name (including devices suffix, if applicable).
GetType (inherited from Object)Gets the Type of the current instance.
GetUserSession Gets the IPTSession from the Request Data object (originally off the top-level session).
LoadQSSettings 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.
RedirectWithMetaRefresh 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".
SetRedirect Helper method that sets request data based on a redirect
SetRequestFullURL Sets the request full URL. This method is used to avoid having to recalculate this URL, since the call to URLDecode is fairly expensive.
SetRequestURL 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.
SetSpaceName 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.
SetUserSession sets the IPTSession on the top-level session and on the Request Data object.
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

RequestData Class | com.plumtree.uiinfrastructure.interpreter Namespace