Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%CSP] >  [Login]
Private  Storage   

class %CSP.Login extends %CSP.Page

Provide a default login and security-token pages for CSP applications. User can override the look of this page by creating a subclass and overriding the DrawTitle method and the LOGINTITLE parameters.

CORS processing for CSP pages that do not inherit from %CSP.REST is also provided here. To turn on CORS assign the application's login page to be a subclass %CSP.Login that has the HandleCorsRequest parameter = 1. In addition, OnHandleCorsRequest and/or OnHandleOptionsRequest methods may be overridden in order to override the default behavior for the application.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 18


Summary

Methods
%ClassIsLatestVersion %ClassName %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Extends %GetParameter %IsA
%New %OriginalNamespace %PackageName %SetModified
ConvertParameter Decrypt DrawCSS3STYLE DrawHEAD
DrawSTHEAD DrawSTTitle DrawSTYLE DrawTitle
DrawTitleSection Encrypt EscapeHTML EscapeURL
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate Link OnErrorSetup
OnHTTPHeader OnHandleCorsRequest OnHandleOptionsRequest OnLoginPage
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent OnSecurityTokenPage Page
QuoteJS RewriteURL ShowError StartTimer
StopTimer SupportedVerbs ThrowError UnescapeHTML
UnescapeURL

Subclasses
%CSP.PasswordChange %CSP.REST %OAuth2.Login

Parameters

• parameter DOMAIN = "%UtilityLogin";
Login page localization domain
• parameter FAVORITEICON = "$$$ISCFAVORITEICON";
Home favorite icon.
• parameter HandleCorsRequest;
This parameter influences the CORS support for the CSP application that has this login page assigned. If set to true (1) then CORS processing is ON. Otherwise CORS processing is OFF.
• parameter LOGINTITLE = "Login Page";
Title displayed for login page.
Users can override this value to customize the login page.
• parameter STYLESHEET;
Name of stylesheet used for login page.
Not used by default page: styles come from the DrawSTYLE method.

Methods

• classmethod DrawCSS3STYLE()
Draw the style definitions for the login page.
Users can override this method to customize the login page.
• classmethod DrawHEAD(pTitle="")
Draw the HEAD section of the login page.
Users can override this method to customize the login page.
• classmethod DrawSTHEAD()
Draw the HEAD section of the security token page.
Users can override this method to customize the security token page.
• classmethod DrawSTTitle(pTitle As %String)
Draw the title section of the security token page.
pTitle is the title for the page.
Users can override this method to customize the security token page.
• classmethod DrawSTYLE()
Draw the style definitions for the login page.
Users can override this method to customize the login page.
• classmethod DrawTitle(pTitle As %String)
Draw the title section of the login page.
pTitle is the title for the page.
Users can override this method to customize the login page.
• classmethod DrawTitleSection(ByRef msgs As %String)
Draw the title section of the page.
pTitle is the title for the page.
Users can override this method to customize the page title section.
• classmethod OnErrorSetup(ByRef skipheader As %Boolean) as %Boolean
• classmethod OnHandleCorsRequest(url As %String) as %Status
This is the CORS request handler. User should override this method in their login page if they don't want the default behavior.
• classmethod OnHandleOptionsRequest(url As %String) as %Status
This methods provides handling of the options request for this CSP application. Note carefully: If authentication is required then this method will be called before login and as such will have only limited privileges.
• classmethod OnLoginPage() as %Status
• classmethod OnPage() as %Status
Output the default login page as HTML
• classmethod OnPreHTTP() as %Boolean
Determine if we need login CSRF tokens and if so add them. If a login page subclass overrides this method it should call this implementation to ensure we set the login CSRF tokens if needed.
• classmethod OnSecurityTokenPage() as %Status
• classmethod SupportedVerbs(url, Output verbs As %String) as %Status
By default all methods are supported.


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