Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%XML] >  [Utils] >  [SchemaServer]
Private  Storage   

class %XML.Utils.SchemaServer extends %CSP.Page

Serves the XML schema for a class via an HTTP request.
The CLASS parameter contains the name of the class to serve the schema for. The FILE parameter contains the file path for the schema file.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 5


Summary

Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%New %OriginalNamespace %PackageName %SetModified
AddStyleSheet ConvertParameter Decrypt Encrypt
EscapeHTML EscapeURL GetEncoding HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL


Parameters

• parameter CHARSET = "UTF-8";
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 = "text/xml";
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.
• parameter DOMAIN = "%Utility";
Default Localization Domain
• parameter SECURITYRESOURCE = "%Development:USE";
Require USE permissions on the %Development resource for access to this page.

Methods

• classmethod AddStyleSheet(stream As %Stream.Object = "") as %Stream.Object
• classmethod GetEncoding(stream As %Stream.Object = "") as %String
• classmethod OnPage() as %Status
Event handler for PAGE event: this is invoked in order to generate the content of a csp page.
• classmethod OnPreHTTP() as %Boolean
Event handler for PreHTTP event: this is invoked before the HTTP headers for a CSP page have been sent. All changes to the %CSP.Response class, such as adding cookies, HTTP headers, setting the content type etc. must be made from within the OnPreHTTP() method. Also changes to the state of the CSP application such as changing %session.EndSession or %session.AppTimeout must be made within the OnPreHTTP() method. It is prefered that changes to %session.Preserve are also made in the OnPreHTTP() method as this is more efficient, although it is supported in any section of the page. Return 0 to prevent OnPage from being called.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.