Provide a default login and security-token pages for CSP applications. More...

Inheritance diagram for Login:

[legend]

Collaboration diagram for Login:

[legend]

Static Public Member Functions
	DrawCSS3STYLE ()
	Draw the style definitions for the login page. More...

	DrawHEAD (pTitle)
	Draw the HEAD section of the login page. More...

	DrawSTHEAD ()
	Draw the HEAD section of the security token page. More...

	DrawSTTitle (_.Library.String pTitle)
	Draw the title section of the security token page. More...

	DrawSTYLE ()
	Draw the style definitions for the login page. More...

	DrawTitle (_.Library.String pTitle)
	Draw the title section of the login page. More...

	DrawTitleSection (_.Library.String msgs)
	Draw the title section of the page. More...

_.Library.Status	OnHandleCorsRequest (_.Library.String url)
	This is the CORS request handler. More...

_.Library.Status	OnHandleOptionsRequest (_.Library.String url)
	This methods provides handling of the options request for this CSP application. More...

_.Library.Status	OnPage ()
	Output the default login page as HTML.

_.Library.Boolean	OnPreHTTP ()
	Determine if we need login CSRF tokens and if so add them. More...

_.Library.Status	SupportedVerbs (url, _.Library.String verbs)
	By default all methods are supported.

Static Public Member Functions inherited from Page
_.Library.Status	ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value)
	You pass this the <parameter>url</parameter> of the page you are going to and a. More...

_.Library.Binary	Decrypt (_.Library.String data)
	Decrypts the input string using the session.Key value that is unique to. More...

_.Library.String	Encrypt (_.Library.Binary data)
	Encrypts the input string using the session.Key value that is unique to this. More...

_.Library.String	EscapeHTML (in)
	This method converts input HTML text into Escaped HTML text.

_.Library.String	EscapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in input URL string into Escaped URL string. More...

_.Library.String	HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile)
	This method returns the string that needs to be written to the current. More...

_.Library.String	HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker)
	This method returns the string that needs to be written to the current. More...

	Include (_.Library.String url)
	Include another csp page or file in the output at this point. More...

_.Library.String	InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra)
	Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More...

_.Library.String	InsertHiddenFields (_.Library.String url, _.Library.String query)
	Return the string containing the hidden form tags. More...

_.Library.Boolean	IsPrivate ()
	Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>).

_.Library.String	Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ)
	Tranforms the link specified by link into a URL and returns it as a string. More...

_.Library.Status	OnHTTPHeader (_.Library.Boolean OutputBody)
	Event handler for PAGE event: this is invoked in order to More...

	OnPageError (_.Library.Status sc)
	Event handler for any error that occurs on the page. More...

	OnPostHTTP ()
	Event handler for POSTPAGE event: this is invoked after the data. More...

_.Library.Status	OnPostHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked after a hyperevent method is called on this page.

_.Library.Status	OnPreHyperEvent (_.Library.String class, _.Library.String method)
	Event handler which is invoked before a hyperevent method is called on this page. More...

_.Library.Status	Page (_.Library.Boolean skipheader)
	Process a request to serve a CSPPage. More...

_.Library.String	QuoteJS (in)
	This method converts input string into quoted JavaScript literal.

_.Library.String	RewriteURL (_.Library.String url)
	This method will rewrite a URL to use #url()# if needed.

	ShowError (_.Library.Status sc)
	Display a <class>Status</class> error code to the CSP Page.

	StartTimer (_.Library.String name)
	Used to get performance information on your CSP pages. More...

	StopTimer (_.Library.String name)
	Used to time performance information on your CSP pages. More...

	ThrowError (_.Library.Status sc)
	Passed a <class>Status</class> code this goes to the error page passing this status code.

_.Library.String	UnescapeHTML (in)
	This method converts Escaped HTML text into normal HTML text.

_.Library.String	UnescapeURL (_.Library.String in, _.Library.String charset)
	This method converts the in Escaped URL string back to its original form. More...

Static Public Attributes
	DOMAIN = None
	Provide a default login and security-token pages for CSP applications. More...

	FAVORITEICON = None
	Home favorite icon.

	HandleCorsRequest = None
	This parameter influences the CORS support for the CSP application that has this login page assigned. More...

	LOGINTITLE = None
	Title displayed for login page. More...

	STYLESHEET = None
	Name of stylesheet used for login page. More...

Static Public Attributes inherited from Page
	CHARSET = None
	The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More...

	CONTENTTYPE = None
	Specifies the default content type for the page. More...

	CONVERTINPUTSTREAM = None
	Specifies if input request.Content or request.MimeData values are converted from their. More...

	CSPFILE = None
	If this page was compiled from a .csp file, then this parameter contains the. More...

	CSPSTRICT = None
	The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More...

	CSPURL = None
	This parameter is used to make sure that if multiple. More...

	CSPXHTML = None
	The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More...

	DOMAIN = None
	The default domain for csp:text, span and div tags. More...

	ENCODED = None
	Controls how the query parameters for this page are passed, it can. More...

	ERRORPAGE = None
	Specify a custom error page to call if there are any problems with generating this page. More...

	EXPIRES = None
	Specified the default value for the response.Expires. More...

	NOCHARSETCONVERT = None
	Specifies if we wish to turn off charset conversion for this page. More...

	PAGETIMING = None
	If this parameter is true then we automatically record timing statistics of how long it takes to. More...

	PRIVATE = None
	Controls the access to the page, it can be set to one of the following: More...

	SECURITYRESOURCE = None
	This is a comma-delimited list of system Resources and associated. More...

	TIMINGSLOTS = None
	Used by the timing to decide how many slots a day should be divided up into. More...

	UseSession = None
	This parameter controls the CSP session support. More...

Detailed Description

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.

Member Function Documentation

◆ DrawCSS3STYLE()

DrawCSS3STYLE ( )

static

Draw the style definitions for the login page.

Users can override this method to customize the login page.

◆ DrawHEAD()

DrawHEAD ( pTitle )

static

Draw the HEAD section of the login page.

Users can override this method to customize the login page.

◆ DrawSTHEAD()

DrawSTHEAD ( )

static

Draw the HEAD section of the security token page.

Users can override this method to customize the security token page.

◆ DrawSTTitle()

DrawSTTitle ( _.Library.String pTitle )

static

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.

◆ DrawSTYLE()

DrawSTYLE ( )

static

Draw the style definitions for the login page.

Users can override this method to customize the login page.

◆ DrawTitle()

DrawTitle ( _.Library.String pTitle )

static

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.

◆ DrawTitleSection()

DrawTitleSection ( _.Library.String msgs )

static

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.

◆ OnHandleCorsRequest()

_.Library.Status OnHandleCorsRequest ( _.Library.String url )

static

This is the CORS request handler.

User should override this method in their login page

if they don't want the default behavior.

◆ OnHandleOptionsRequest()

_.Library.Status OnHandleOptionsRequest ( _.Library.String url )

static

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.

◆ OnPreHTTP()

_.Library.Boolean OnPreHTTP ( )

static

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.

Reimplemented from Page.

Member Data Documentation

◆ DOMAIN

DOMAIN = None

static

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.

Login page localization domain

◆ HandleCorsRequest

HandleCorsRequest = None

static

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.

◆ LOGINTITLE

LOGINTITLE = None

static

Title displayed for login page.

Users can override this value to customize the login page.

◆ STYLESHEET

STYLESHEET = None

static

Name of stylesheet used for login page.

Not used by default page: styles come from the DrawSTYLE method.

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ DrawCSS3STYLE()

◆ DrawHEAD()

◆ DrawSTHEAD()

◆ DrawSTTitle()

◆ DrawSTYLE()

◆ DrawTitle()

◆ DrawTitleSection()

◆ OnHandleCorsRequest()

◆ OnHandleOptionsRequest()

◆ OnPreHTTP()

Member Data Documentation

◆ DOMAIN

◆ HandleCorsRequest

◆ LOGINTITLE

◆ STYLESHEET