Uiinfrastructure API Docs  
 

Interpreter Members

Interpreter overview

Public Static Fields

iconiconBROWSERTYPE stored as a BrowserType object
iconiconCHECKPOINT_CONTROL_END 
iconiconCHECKPOINT_CONTROL_START internal timer checkpoint constants
iconiconCHECKPOINT_DISPLAY_END 
iconiconCHECKPOINT_DISPLAY_START 
iconiconCHECKPOINT_PAGE_END 
iconiconCHECKPOINT_PAGE_START 
iconiconDEFAULTERRORSPACE mj: default error space.
iconiconHOSTNAME stored as a string
iconiconHOSTPORT stored as an Integer
iconiconJSON_DATA_TYPE Mime type for JSON data. JSON requests will not have the POST data parsed automatically.
iconiconUSERLOCALE stored as a string
iconiconUSERSESSIONVALID false implies guest -- this should only be read in the Interpreter (and elsewhere). It is set in the LoginHelper.SetSessionValidity() method.

Public Static Methods

iconiconAddNonFormDataRequestPattern Adds non-form data url patterns (I.E. gateway requests). These signal the Interpreter not to parse the request body as form-encoded. This allows subsequent code to get the input stream. NOTe: This method is not threadsafe and should only be called by static initializers. Called on the first request after startup by GatewayHelpers.
iconiconCheckSessionAuth This helper method performs basic session authentication. It does not issue login challenges.
iconiconClearSandbox This is the only way to safely clear the sandbox so that it gets correctly re-initialized. This does not reset the SESSIONVALID variable.
iconiconGenerateDiagnosticErrorPage 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);
iconiconGenerateFailureHTML Uses the startup diagnostics strings to form an HTML message.
iconiconGenerateFailureHTMLInsecure Insecure, outward-facing, simplified HTML for startup failure message
iconiconHandleError This method handles displaying an error page, or displaying an error if that is not possible.
iconiconHandleRequest Handle the HTTP request by getting the appropriate control, filling out its data, and returning the Display page from the control.
iconiconInitializePersonalSettingsSession 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.
iconiconIsErrorPageRequired 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.
iconiconOutputStartupFailure Method: \u0009OutputStartupFailure Purpose:\u0009Helper method to output startup failure message. Uses diagnostic notification arrays to form recommendation.
iconiconSendHTTPRedirect This helper method sends a 302 redirect.
iconiconSetContentLanguageOnPageData 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.)
iconiconStoreBrowserSettings Stores the browser settings from the current request on the subsession.
iconiconStoreHostPortSettings Stores the host name and port number from the current request on the subsession.

Protected Static Fields

iconiconm_Authenticator 
iconiconm_MVCController 

Protected Static Methods

iconiconEqualRedirects 
iconiconIsNotFormRequest Checks if the provided url is not a form POST URL (i.e. gateway, or REST API). NOTE: This is based off of a static list of patterns for non-form POST URLs. This list is initialized by the GatewayHelpers static initializer, so the list will not be complete until that class is used (i.e. the second request).

Public Instance Constructors

icon Interpreter Constructor Initializes a new instance of the Interpreter class.

Public Instance Methods

iconDoService Pass the HTTP request to the static control code.
iconEquals (inherited from Object)Determines whether the specified Object is equal to the current Object.
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.
iconGetType (inherited from Object)Gets the Type of the current instance.
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

Interpreter Class | com.plumtree.uiinfrastructure.interpreter Namespace