Home > Class Reference > ENSLIB namespace > %CSP.Page


abstract class %CSP.Page extends %Library.Base

The %CSP.Page object serves as an event handler for CSP requests. All .csp pages by default derive from %CSP.Page, although you can override this using the <CSP:CLASS> tag. CSP Servlets can be created by deriving a class from %CSP.Page, see %CSP.StreamServer as an example.

Method Inventory (Including Private)


parameter CHARSET;
Specifies the default character set for the page. This can be overriden using the <CSP:CONTENT CHARSET=> tag, or by setting the %response.CharSet property in the OnPreHTTP() method. If this parameter is not specified, then for the default charset is utf-8.
parameter CONTENTTYPE;
Specifies the default content type for the page. This can be overriden using the <CSP:CONTENT TYPE=> tag, or by setting the %response.ContentType property in the OnPreHTTP() method. The default value if this parameter is not set is text/html.
Specifies if input %request.Content or %request.MimeData values are converted from their original character set on input. By default (0) we do not modify these and receive them as a binary stream which may need to be converted manually later. If 1 then if there is a 'charset' value in the request Content-Type or mime section we will convert from this charset when the input data is text based. For either json or xml data with no charset this will convert from utf-8 or honor the BOM if one is present.
parameter CSPFILE;
If this page was compiled from a .csp file, then this parameter contains the filename used for compilation.
parameter CSPSTRICT;
The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this is a strict or frameset XHTML or HTML 4 page.
parameter CSPURL;
This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter CSPXHTML;
The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this is an XHTML page.
parameter DOMAIN;
The default domain for csp:text, span and div tags. This parameter is used to specify the subset of localized messages to be used on this page.
parameter ENCODED = 0;
Controls how the query parameters for this page are passed, it can be set to one of the following:

  • ENCODED=0 - Query parameters are not encrypted
  • ENCODED=1 - Query parameters are encrypted and passed within CSPToken
  • ENCODED=2 - Same as '1' except any unencrypted parameters are removed from the %request object before calling the Page() method. This ensures that only encrypted parameter are available in the %CSP.Request object.
parameter ERRORPAGE;
Specify a custom error page to call if there are any problems with generating this page. If this is not specified it will use the default error page specified for this CSP application, and if this is not specified it will use the system default error page. For example this could be set to '/csp/samples/error.csp' to display the sample error page.
parameter EXPIRES = -1;
Specified the default value for the %response.Expires.
It can be set to one of the following values:
  • -1: Expire immediately, this is the default for a CSP page
  • "": Never expire (no HTTP Expires header is sent)
  • nnnnn: Number of seconds from now when the object should expire
  • Thu, 29 Oct 1998 17:04:19 GMT: Absolute time at which the object should expire
  • ddddd,sssss: Absolute time the object should expire in $ZTimeStamp format. Note that this must be specified in the GMT timezone
Note that setting this header also effects the 'Cache-Control' and 'Pragma' headers. If the page is set to expire immediately then it will send a 'Cache-Control: no-cache' and 'Pragma: no-cache' to prevent any caches from storing the page. If the page is set to never expires then it will not send any 'Cache-Control' or 'Pragma' headers. If you set an expires date then it will not modify the 'Cache-Control' or 'Pragma' headers so if they are set they will be sent as specified and if you did not set them then nothing will be sent for these headers.
Specifies if we wish to turn off charset conversion for this page. Normally CSP uses the tables built into Cache to convert between different charset's, however if you do not have a charset available you may wish to turn this off to avoid getting the error page saying that this charset is not installed. Then the data will be output and read in using RAW mode. This can be overridden using the <CSP:CONTENT NOCHARSETCONVERT=1> tag, or by setting the %response.NoCharSetConvert property in the OnPreHTTP() method.
parameter PAGETIMING = 0;
If this parameter is true then we automatically record timing statistics of how long it takes to produce this page. It is off by default.
parameter PRIVATE = 0;
Controls the access to the page, it can be set to one of the following:

  • PRIVATE=0 - Page can be linked to/bookmarked
  • PRIVATE=1 - Can only be referenced from another CSP page
The user needs initially to enter the site through a PUBLIC page.
This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on all of the specified resources in order to view this page.
The format of each item in the list should be as follows:
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE. You can also specify or grouping using the '|' character, so 'R1,R2|R3,R3|R4' means you must have resource R1 and one of R2 or R3 and one of R3 or R4. So if you have R1,R3 it will pass, if you have R1,R4 it will not as it does not meet the R2|R3 condition. So the '|' or condition takes precedence over the ',' and condition.
parameter TIMINGSLOTS = 48;
Used by the timing to decide how many slots a day should be divided up into. The default is to record the timings over half an hour (48 slots per day). If you need more detail you can modify this value in the superclass.
parameter UseSession = 1;
This parameter controls the CSP session support. By default CSP will use a persistent session which holds a license until the session is ended or times out. If you override this then this CSP page will use a transient session which is never persisted.

Methods (Including Private)

classmethod ConvertParameter(url As %String, ByRef name As %String, ByRef value As %String) as %Status
You pass this the url of the page you are going to and a name and value parameter and it will return the name and value encrypted if the target page is encoded.
classmethod Decrypt(data As %String) as %Binary
Decrypts the input string using the %session.Key value that is unique to this user session. The input string is the string provided by the Encrypt() method, the output is the decoded string.
classmethod Encrypt(data As %Binary) as %String
Encrypts the input string using the %session.Key value that is unique to this user session. The output string is a string that can be included in HTML and in URLs as it does not contain any characters that need to be escaped in these environments. It can be decrypted with the