|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.interpreter.RequestData
public class RequestData
Helper class for managing the request data for the Interpreter.
Field Summary | |
---|---|
IApplication |
m_Application
application |
AActivitySpace |
m_asSpace
Activity Space |
boolean |
m_bClearSession
whether or not to clear the session after this request has finished. |
boolean |
m_bGetCacheNoID
whether or not to get the item from the cache without knowing its ID |
boolean |
m_bGuest
whether or not the current user is a guest user |
IDisplayPage |
m_dpNextDisplay
display page |
int |
m_nSSOState
SSO state |
java.lang.String |
m_sControl
Control name |
java.lang.String |
m_sDevicesSpaceNameSuffix
optional _WML, etc... |
ISessionManager |
m_SessionManager
base session manager |
ISessionManager |
m_smCache
Activity Space Cache |
ISessionManager |
m_smPersistentSandbox
persistent sandbox session manager |
ISessionManager |
m_smPersonalSettings
personal settings session manager |
ISessionManager |
m_smSandbox
sandbox session manager |
java.lang.String |
m_sPage
display page name |
java.lang.String |
m_sParentID
parent space ID |
java.lang.String |
m_sParentName
parent space name |
java.lang.String |
m_sSpaceID
space id |
java.lang.String |
m_sSubSpaceKey
sub-space key |
TimeTracker |
m_ttTimer
A timer used to track various events in the requests lifetime |
WebData |
m_wdPageData
web data |
XPHashtable |
m_xpmCacheList
list of items in the cache |
IXPRequest |
m_xpRequest
request |
IXPResponse |
m_xpResponse
response |
Constructor Summary | |
---|---|
RequestData(IXPRequest request,
IXPResponse response,
ISessionManager session,
IApplication application)
Creates a new RequestData object. |
Method Summary | |
---|---|
java.lang.String |
AppendRedirectURLTo302URL(java.lang.String _sTargetSpace,
java.lang.String _sURL)
JF- Adds the redirect URL to the URL where we are about to 302 redirect to. |
void |
ClearUserSession()
Removes the User Session from the top-level session and on the Request Data object. |
boolean |
GetHasExternalRedirect()
Helper method that checks whether or not an external redirect has been set on this object (i.e. |
boolean |
GetHasHTTPRedirect()
Helper method that checks whether or not an HTTP redirect has been set on this object (i.e. |
XPHashtable |
GetQueryString()
Helper method that constructs and returns a redirect . |
Redirect |
GetRedirect()
Helper method that constructs and returns a redirect. |
java.lang.String |
GetRedirectURLFromQS()
JF- In security mode 1, returns the redirect URL (ASConstants.REDIRECT_AFTER_LOGIN) from the QS. |
java.lang.String |
GetRequestFullURL()
Returns the request full URL. |
java.lang.String |
GetRequestURL()
Returns the request URL. |
java.lang.String |
GetRootSpaceName()
Accessor method for the root space name (without devices suffix). |
java.lang.String |
GetSpaceName()
Accessor method for the full space name (including devices suffix, if applicable). |
java.lang.Object |
GetUserSession()
Gets the IPTSession from the Request Data object (originally off the top-level session). |
void |
LoadQSSettings()
This method loads various settings from the query string. |
boolean |
RedirectWithMetaRefresh(java.lang.String _sRedirectURL)
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". |
void |
SetRedirect(Redirect newRedirect)
Helper method that sets request data based on a redirect |
void |
SetRequestFullURL(java.lang.String sRequestFullURL)
Sets the request full URL. |
void |
SetRequestURL(java.lang.String sRequestURL)
Sets the request URL. |
void |
SetSpaceName(java.lang.String strName)
This helper method sets the root space name and the real space name based upon the optional devices space name suffix (_WML, etc...). |
void |
SetUserSession(java.lang.Object oUserSession)
sets the IPTSession on the top-level session and on the Request Data object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public AActivitySpace m_asSpace
public IApplication m_Application
public IDisplayPage m_dpNextDisplay
public ISessionManager m_SessionManager
public ISessionManager m_smCache
public ISessionManager m_smPersonalSettings
public ISessionManager m_smSandbox
public ISessionManager m_smPersistentSandbox
public IXPRequest m_xpRequest
public IXPResponse m_xpResponse
public java.lang.String m_sControl
public java.lang.String m_sDevicesSpaceNameSuffix
public java.lang.String m_sPage
public java.lang.String m_sParentID
public java.lang.String m_sParentName
public java.lang.String m_sSpaceID
public java.lang.String m_sSubSpaceKey
public WebData m_wdPageData
public XPHashtable m_xpmCacheList
public boolean m_bGetCacheNoID
public boolean m_bClearSession
public boolean m_bGuest
public int m_nSSOState
public TimeTracker m_ttTimer
Constructor Detail |
---|
public RequestData(IXPRequest request, IXPResponse response, ISessionManager session, IApplication application)
request
- response
- session
- application
- Method Detail |
---|
public java.lang.String GetRootSpaceName()
public java.lang.String GetSpaceName()
public XPHashtable GetQueryString()
public boolean GetHasExternalRedirect()
public boolean GetHasHTTPRedirect()
public Redirect GetRedirect()
public java.lang.String GetRedirectURLFromQS()
public void SetRedirect(Redirect newRedirect)
Redirect
- public java.lang.String AppendRedirectURLTo302URL(java.lang.String _sTargetSpace, java.lang.String _sURL)
_sTargetSpace
- - Space where we are 302 redirecting to._sURL
- - URL to append the redirect to
(if it's not needed, the url will be returned unchanged)
public boolean RedirectWithMetaRefresh(java.lang.String _sRedirectURL)
_sRedirectURL
-
public void LoadQSSettings()
public void SetSpaceName(java.lang.String strName)
String
- strName the root name of the new spacepublic java.lang.String GetRequestURL()
m_xpRequest.GetRequestURL()
so the SSO login code can make
it look like the request came to server.pt instead of ssologin.pt.
public void SetRequestURL(java.lang.String sRequestURL)
sRequestURL
- the request urlpublic java.lang.String GetRequestFullURL()
public void SetRequestFullURL(java.lang.String sRequestFullURL)
sRequestFullURL
- the request full urlpublic java.lang.Object GetUserSession()
public void SetUserSession(java.lang.Object oUserSession)
User
- Session Objectpublic void ClearUserSession()
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |