S/Web Objects - Session

S/Web Objects

Links on this page:

Properties
Methods

Session

This object handles information relating to the current S/WEB session

Properties:

Property	Get/Set	Description
ENCRYPTCOOKIES	Get/Set	Flag indicating whether cookies are encrypted before sending back to the client
EXECUTIONTIME	Get	Returns how long, in seconds, this server has been running.
FILEID	Get/Set	The ID of the request file passed to the server.
INITPROC	Get/Set	Name of a function to call to initialize any session-specific details
LOGINDOCUMENTID	Get/Set	String to insert into a document to identify it to the system as a login document so that security is not invoked. May be multi-valued to identify other documents served by S/Web that do not require security.
LOGINPROC	Get/set	Name of a function to call to deal with login procedures
LOGINRESOURCEID	Get/Set	String to use for identifying login resources during login requests
OICGI	Get/Set	Indicates if the server is operating in OICGI compatibility mode.
RESOURCEID	Get	String to identify resource keys during requests
SECURITYPROC	Get/Set	Name of a function to call to deal with security checks on each request
STDERRDOC	Get/Set	Contains the name of the document to use for error reporting
STDERRMSG	Get/Set	Contains the name of the msg to execute for error reporting
STDERRPROC	Get /Set	Contains the name of the proc to execute for error reporting
SWAPLIST	Get/Set	Contains the application string swap list
TIMESTAMP		Not implemented
TRACKEXCEPTIONS		Not implemented
TRACKIPS		Not implemented
TRACKREQUESTS	Get/Set	TRUE to track ALL requests to the WWW_REQUEST and WWW_REQUEST_CONTENT tables.
TRACKSECURITY	Get/Set	TRUE if we log unauthorized exceptions to the WWW_UNAUTHORIZED table
XVERSION	Get	Returns the current version of S/Web

Methods:

call www_Exec_Method( "SESSION", method, param1, param2, param3, param4, param5 )

Method	Description
CREATE	This method creates a new session object
DESTROY	This method destroys the current session object.
EXECUTE	This method executes the actual requests
GET	This method retrieves properties of the session object
SET	This method sets properties of the session object
STDERR	This method handles standard error reporting.

[top]

CREATE method

This method creates a new session object using the Request file name passed in Param1. Should not be used by end users.

Argument	Description
param1	Name of Request OS Header file.
param2	Not used.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

This method should not be called by the end-user and is only documented for completeness.

[top]

DESTROY method

This method destroys the current session. It effectively destroys both the REQUEST and RESPONSE objects associated with either session.

Argument	Description
param1	Not used.
param2	Not used.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

This method should not be called by the end-user and is only documented for completeness.

[top]

EXECUTE method

Used to process the current set of request files.

Argument	Description
param1	Not used.
param2	Not used.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

This method should not be called by the end-user and is only documented for completeness.

[top]

GET method

This method retrieves properties of the session object

Argument	Description
param1	Property to retrieve - can be @Rm delimited to retrieve multiple properties.
param2	Property values returned.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

Example:

   declare function www_Exec_Method, www_Get_Status, www_Set_Status
   $insert www_Status_Equates
   $insert logical
   Properties =   "OICGI"
   if www_Exec_Method( "SESSION", "GET", Properties, RetVals, "", "", "", "", errorText ) then
      OpenEngine    = Field( RetVals, @RM, 1 )
      * Finish processing
   end else
      abort = TRUE$
   end

[top]

SET method

This method sets properties of the SESSION object.

Argument	Description
param1	Properties to set, @Rm delimited
param2	Values to set, @Rm delimited
param3	Previous values returned, @Rm delimited
param4	Not used.
param5	Not used.
param6	Not used.

Example:

   declare function www_Exec_Method, www_Get_Status, www_Set_Status
   $insert www_Status_Equates
   $insert logical
   Properties =   "OICGI"
   Values =   True$
   if www_Exec_Method( "SESSION", "SET", Properties, Values, RetVals, "", "", "", errorText ) then
      * Finish processing
   end else
      abort = TRUE$
   end

[top]

STDERROR method

This method provides a standardised way of reporting errors to the client. The routine will first look for an error handling procedure, if that fails it will try to use the standard error handling document. If that fails it will try to use the standard error message and if that fails it will generate it's own error message.

Argument	Description
param1	Error text to return to client.
param2	If TRUE$ ignores standard error procedures et al and just generates own error message.
param3	Not used.
param4	Not used.
param5	Not used.
param6	Not used.

Example:

   declare function www_Exec_Method, www_Get_Status, www_Set_Status
   $insert www_Status_Equates
   $insert logical
   ErrorText =   "No bank records on file for you - sorry!"

   if www_Exec_Method( "SESSION", "STDERROR", ErrorText, "", "", "", "", "", errorText ) then
      * Finish processing
   end else
      abort = TRUE$
   end

[top]