Plumtree UI Infrastructure API  
 

Interpreter Members

Interpreter overview

Public Static Fields

BROWSERTYPE stored as a BrowserType object
CHECKPOINT_CONTROL_END 
CHECKPOINT_CONTROL_START internal timer checkpoint constants
CHECKPOINT_DISPLAY_END 
CHECKPOINT_DISPLAY_START 
CHECKPOINT_PAGE_END 
CHECKPOINT_PAGE_START 
DEFAULTERRORSPACE mj: default error space.
HOSTNAME stored as a string
HOSTPORT stored as an Integer
USERLOCALE stored as a string
USERSESSIONVALID false implies guest -- this should only be read in the Interpreter (and elsewhere). It is set in the LoginHelper.SetSessionValidity() method.

Public Static Methods

CheckSessionAuth This helper method performs basic session authentication. It does not issue login challenges.
ClearSandbox This is the only way to safely clear the sandbox so that it gets correctly re-initialized. This does not reset the SESSIONVALID variable.
GenerateDiagnosticErrorPage Method: \u0009GenerateDiagnosticErrorPage Purpose:\u0009Helper method to output an error as a diagnostic style startup error page. Uses diagnostic notification arrays to form recommendation. Useful if you have a fundamental error that is similar to a startup check, such as licensing. Notes: Be sure to supply at least one element on the eventlog vector; the reportlog can be null or a series of strings. Note also that the eventlog should ideally have valid values that tie back to a real startup task in order to load an appropriate recommendation. Here, for example, are some licensing settings: EventLog[] eventVector = new EventLog[1]; eventVector[0].taskID = PTStartupTasks.VALIDATELICENSE.getOrdinal(); eventVector[0].taskStep = 1; eventVector[0].taskName = "ValidateLicense"; eventVector[0].platformName = Platform.getCurPlatform().getName(); eventVector[0].errorMessage = "Session License Failure"; eventVector[0].errorDescription = "You have exceeded your allowed session count on the evaluation of your license."; eventVector[0].exceptionRecommendation = "Contact BEA sales and purchase a production license."; eventVector[0].retVal = PT_STARTUP_RESULTCODES.FATAL; GenerateDiagnosticErrorPage(request, eventVector, null);
GenerateFailureHTML Uses the startup diagnostics strings to form an HTML message.
GenerateFailureHTMLInsecure Insecure, outward-facing, simplified HTML for startup failure message
HandleError This method handles displaying an error page, or displaying an error if that is not possible.
HandleRequest Handle the HTTP request by getting the appropriate control, filling out its data, and returning the Display page from the control.
InitializePersonalSettingsSession Initializes the personal settings session manager off the sandbox session. This is done automatically when a new RequestData object is created. If the sandbox has been cleared, this re-initializes the personal settings session manager.
IsErrorPageRequired 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.
OutputStartupFailure Method: \u0009OutputStartupFailure Purpose:\u0009Helper method to output startup failure message. Uses diagnostic notification arrays to form recommendation.
SendHTTPRedirect This helper method sends a 302 redirect.
SetContentLanguageOnPageData JF- Helper method to retrieve the current locale from the Session and set it on the PageData. (It will later be set in the HTTP header by WebData.)
StoreBrowserSettings Stores the browser settings from the current request on the subsession.
StoreHostPortSettings Stores the host name and port number from the current request on the subsession.

Protected Static Fields

m_Authenticator 
m_MVCController 

Protected Static Methods

EqualRedirects 

Public Instance Constructors

Interpreter Constructor Initializes a new instance of the Interpreter class.

Public Instance Methods

DoService Pass the HTTP request to the static control code.
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

Interpreter Class | com.plumtree.uiinfrastructure.interpreter Namespace