|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.interpreter.Interpreter
public class Interpreter
The Interpreter class takes HTTP requests, checks the authentication on the request sessions, processes the requests for any activity-space related operations, including IControl executions and PEI invocations, and finally writes the response to the client browser.
Field Summary | |
---|---|
static java.lang.String |
BROWSERTYPE
stored as a BrowserType object |
static java.lang.String |
CHECKPOINT_CONTROL_END
|
static java.lang.String |
CHECKPOINT_CONTROL_START
internal timer checkpoint constants |
static java.lang.String |
CHECKPOINT_DISPLAY_END
|
static java.lang.String |
CHECKPOINT_DISPLAY_START
|
static java.lang.String |
CHECKPOINT_PAGE_END
|
static java.lang.String |
CHECKPOINT_PAGE_START
|
static java.lang.String |
DEFAULTERRORSPACE
mj: default error space. |
static java.lang.String |
HOSTNAME
stored as a string |
static java.lang.String |
HOSTPORT
stored as an Integer |
static java.lang.String |
JSON_DATA_TYPE
Mime type for JSON data. |
protected static IAuthenticator |
m_Authenticator
|
protected static MVCController |
m_MVCController
|
static java.lang.String |
USERLOCALE
stored as a string |
static java.lang.String |
USERSESSIONVALID
false implies guest -- this should only be read in the Interpreter (and elsewhere). |
Constructor Summary | |
---|---|
Interpreter()
|
Method Summary | |
---|---|
static void |
AddNonFormDataRequestPattern(java.lang.String _strPattern)
Adds non-form data url patterns (I.E. |
static Redirect |
CheckSessionAuth(RequestData tempData)
This helper method performs basic session authentication. |
static void |
ClearSandbox(ISessionManager smSandbox)
This is the only way to safely clear the sandbox so that it gets correctly re-initialized. |
void |
DoService(IXPRequest request,
IXPResponse response,
ISessionManager session,
IApplication application)
Pass the HTTP request to the static control code. |
protected static boolean |
EqualRedirects(Redirect r1,
Redirect r2)
|
static HTMLElementCollection |
GenerateDiagnosticErrorPage(IXPRequest request,
EventLog[] eventVector,
XPArrayList reportLog)
Method: GenerateDiagnosticErrorPage Purpose: Helper method to output an error as a diagnostic style startup error page. |
static java.lang.String |
GenerateFailureHTML()
Uses the startup diagnostics strings to form an HTML message. |
static java.lang.String |
GenerateFailureHTMLInsecure()
Insecure, outward-facing, simplified HTML for startup failure message |
static void |
HandleError(java.lang.Exception e,
RequestData tempData)
This method handles displaying an error page, or displaying an error if that is not possible. |
static void |
HandleRequest(IXPRequest request,
IXPResponse response,
ISessionManager session,
IApplication application)
Handle the HTTP request by getting the appropriate control, filling out its data, and returning the Display page from the control. |
static void |
InitializePersonalSettingsSession(ISessionManager session)
Initializes the personal settings session manager off the sandbox session. |
static boolean |
IsErrorPageRequired(RequestData tempData)
This method checks whether or not an error page is required and changes the space information if necessary, but does not get the actual space. |
protected static boolean |
IsNotFormRequest(java.lang.String uri)
Checks if the provided url is not a form POST URL (i.e. |
static void |
OutputStartupFailure(IXPRequest request,
IXPResponse response)
Method: OutputStartupFailure Purpose: Helper method to output startup failure message. |
static void |
SendHTTPRedirect(Redirect myRedirect,
RequestData tempData)
This helper method sends a 302 redirect. |
static void |
SetContentLanguageOnPageData(RequestData _tempData)
JF- Helper method to retrieve the current locale from the Session and set it on the PageData. |
static void |
StoreBrowserSettings(ISessionManager subSession,
IXPRequest request)
Stores the browser settings from the current request on the subsession. |
static void |
StoreHostPortSettings(ISessionManager subSession,
IXPRequest request)
Stores the host name and port number from the current request on the subsession. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULTERRORSPACE
public static final java.lang.String HOSTNAME
public static final java.lang.String HOSTPORT
public static final java.lang.String USERSESSIONVALID
public static final java.lang.String USERLOCALE
public static final java.lang.String BROWSERTYPE
public static final java.lang.String CHECKPOINT_CONTROL_START
public static final java.lang.String CHECKPOINT_CONTROL_END
public static final java.lang.String CHECKPOINT_PAGE_START
public static final java.lang.String CHECKPOINT_PAGE_END
public static final java.lang.String CHECKPOINT_DISPLAY_START
public static final java.lang.String CHECKPOINT_DISPLAY_END
public static final java.lang.String JSON_DATA_TYPE
protected static final IAuthenticator m_Authenticator
protected static final MVCController m_MVCController
Constructor Detail |
---|
public Interpreter()
Method Detail |
---|
public static void AddNonFormDataRequestPattern(java.lang.String _strPattern)
pattern
- A pattern is just a part of a non-form data url, for example: '/gateway/PTARGS_' or '/gw/'
The latter example is the default keyword for gateway friendly urls, it isn't completely unique
since you could name a community or page 'gw' but it is up to the customer to choose a unique
enough friendly url keyword.public static void ClearSandbox(ISessionManager smSandbox)
smSandbox
- public static void InitializePersonalSettingsSession(ISessionManager session)
public void DoService(IXPRequest request, IXPResponse response, ISessionManager session, IApplication application)
DoService
in interface IXPPage
request
- response
- session
- application
- public static void HandleRequest(IXPRequest request, IXPResponse response, ISessionManager session, IApplication application)
request
- response
- session
- application
- protected static boolean IsNotFormRequest(java.lang.String uri)
uri
- url of the request to check
public static void OutputStartupFailure(IXPRequest request, IXPResponse response)
public static HTMLElementCollection GenerateDiagnosticErrorPage(IXPRequest request, EventLog[] eventVector, XPArrayList reportLog)
public static java.lang.String GenerateFailureHTML()
public static java.lang.String GenerateFailureHTMLInsecure()
public static void HandleError(java.lang.Exception e, RequestData tempData)
Exception
- the exception that caused us to go here.public static boolean IsErrorPageRequired(RequestData tempData)
RequestData
- the temporary request data object.
public static void StoreHostPortSettings(ISessionManager subSession, IXPRequest request)
subSession
- request
- public static void StoreBrowserSettings(ISessionManager subSession, IXPRequest request)
subSession
- request
- public static void SetContentLanguageOnPageData(RequestData _tempData)
_tempData
- public static Redirect CheckSessionAuth(RequestData tempData)
tempData
- The current request data.
public static void SendHTTPRedirect(Redirect myRedirect, RequestData tempData)
myRedirect
- The 302 redirect to send.tempData
- The current request data.protected static boolean EqualRedirects(Redirect r1, Redirect r2)
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |