Skip to main content

%CSP.Broker

Class %CSP.Broker Extends %CSP.Page [ Abstract, System = 3 ]

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

The %CSP.Broker object serves as an event handler for CSP requests.

Parameters​

CHARSET​

Parameter CHARSET [ Internal ] = "utf-8";

Default result to be written in UTF-8.

Methods​

OnPreHTTP​

ClassMethod OnPreHTTP() As %Boolean [ Internal ]

OnPreHTTP to setup response headers.

callPreHyperEvent​

ClassMethod callPreHyperEvent(class As %String, cls As %String, method As %String) [ Internal, Private, ProcedureBlock = 0 ]

OnPage​

ClassMethod OnPage() As %Status [ Internal ]

Compute and serve the hyperevent response.

OnPostHTTP​

ClassMethod OnPostHTTP() [ Internal ]

Signal trapped error

GetEvent​

ClassMethod GetEvent(event As %String, ByRef cls As %String, ByRef member As %String) As %Status [ Internal, Private ]

Parse the request event.

XecuteStr​

ClassMethod XecuteStr(event, ByRef code As %String, wantreturnval As %Boolean) As %String [ Internal, Private ]

String to execute to run the desired method.

CSPEvent​

ClassMethod CSPEvent(%class As %String, %method As %String) As %Status [ Internal, Private, PublicList = rs ]

Handles events generated by the Java CSPBroker.class. Input parameters can be found in the %request object (an instance of %CSP.Request), as follows:

WEVENT class.method Invoke 'method' of 'class'
WARGC integer Number of arguments
WARG_1..WARG_n value Value of argument 'n'

Output is written back to the [HTML/HTTP] stream, as follows:

WEBCHD Session handle
#status Status code (see below)
[error msg] Error message (if status contains 'E')
javascript output Zero or more lines of Javascript output
...
[return value] Return value of event function (if present)
Valid status codes are:

E Error condidition follows
R Last line contains return value

CSPJSEvent​

ClassMethod CSPJSEvent(%class As %String, %method As %String) As %Status [ Internal, Private ]

Handles events generated by the JavaScript event IFrame method. Input parameters can be found in the %request object (an instance of %CSP.Request), as follows:

WJSEVENT class.method Invoke 'method' of 'class'
WARGC integer Number of arguments
WARG_1..WARG_n value Value of argument 'n'

Output is written back to the [HTML/HTTP] stream as a JavaScript document. The variable CSPPage refers to the page that called this method.

InsertErrorHeader​

ClassMethod InsertErrorHeader() [ Internal ]

Output the beginning of an error response

InsertErrorEnd​

ClassMethod InsertErrorEnd() [ Internal ]

Output the end of an error response