Class %CSP.UI.Portal.SSL

class %CSP.UI.Portal.SSL extends %CSP.UI.Portal.Template

Zen page for System Management Portal - Edit SSL/TLS configuration

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
7	9	22

Summary

This is a Zen Page class. It belongs to the application %CSP.UI.Portal.Application.

Properties
%condition	%import	%includeFiles	%page
%resource	AllowTest	CipherDefault	FirstFailed
HelpAddress	ISREADONLY	InvalidParam	IsEMSReadOnly
IsEditForm	LocatorHeader	Max	Min
OnclickArray	PID	ParentURL	StdTitle
ValidationErrorMsg	aboutPage	align	aux
backgroundTimerInterval	cellAlign	cellSize	cellStyle
cellVAlign	children	composite	contactPage
containerStyle	cssLevel	currSortMode	currStep
currViewMode	disabled	dragAndDrop	dragEnabled
dropEnabled	enableAutoRefresh	enclosingClass	enclosingStyle
error	groupClass	groupStyle	height
hidden	hint	hintClass	hintStyle
home	homePage	id	index
isMirror	isNew	label	labelClass
labelDisabledClass	labelPosition	labelStyle	layout
lblTitle	limitPopups	name	onafterdrag
onbeforedrag	onclick	ondrag	ondrop
onhide	onrefresh	onshow	onupdate
pageModified	parent	pwModified	searchKey
showLabel	slice	title	tuple
useSVG	useSoftModals	valign	visible
width	window	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddLocatorLinks	%AddToSaveSet	%ApplyURLParms
%Attr	%BindExport	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%DrawAutoLogout	%DrawClassDefinitions	%DrawComponentHTML	%DrawHTML
%DrawHTMLPage	%DrawJSStrings	%DrawObjectDefinitions	%EnclosingDivId
%EndBackgroundMethod	%EndScript	%Eval	%EvalC
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetHomePage
%GetHomeParam	%GetLinks	%GetLocatorLinks	%GetPageName
%GetParameter	%GetProductName	%GetValueById	%GetValueByName
%GetXMLName	%IsA	%IsModified	%Link
%LinkCSS	%LinkScript	%MakeId	%New
%NormalizeObject	%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore
%OnAfterCreatePage	%OnBeforeCreatePage	%OnCreateApplication	%OnCreatePage
%OnDetermineCSSLevel	%OnDrawEnclosingDiv	%OnDrawHTMLBody	%OnDrawHTMLHead
%OnDrawHTMLMeta	%OnDrawObjectProperties	%OnFinishBackgroundTask	%OnGetPageName
%OnGetProductName	%OnGetSmallMenu	%OnGetTitle	%OnMonitorBackgroundTask
%OnMutateChildren	%OnObjectSynch	%OnPreHTTP	%OnSubmit
%OnUseSoftModals	%OnZENDeserialize	%OriginalNamespace	%PackageName
%QuoteValue	%QuoteValueL10N	%Register	%RemoveChild
%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet	%RunBackgroundMethod
%Self	%SerializeObject	%SetBackgroundMethodStatus	%SetErrorById
%SetErrorByName	%SetModified	%SetValueById	%SetValueByName
%SetValuesByName	%StartScript	%ValidateObject	%ZENVersion
BuildMenu	CheckAllBlanks	CheckContextLinks	CheckEnterpriseManager
ConvertParameter	Decrypt	DoLogout	DrawLocator
DrawRibbon	DrawTitle	Encrypt	EscapeHTML
EscapeURL	EvalResult	GetCSPURL	GetContextLinks
GetDocURL	GetHomePage	GetNewURL	GetQuickLinks
HyperEventCall	HyperEventHead	Include	InsertHiddenField
InsertHiddenFields	IsPrivate	JavaInstalled	Link
LoadData	OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	QuoteJS
RegisterRecent	RewriteURL	SaveData	ShowError
StartTimer	StopTimer	ThrowError	UnescapeHTML
UnescapeURL	XMLDTD	XMLExport	XMLExportToStream
XMLExportToString	XMLNew	XMLSchema	XMLSchemaNamespace
XMLSchemaType	addChild	addChildAfter	addChildBefore
afterSave	afterValidate	browseSelect	cancelPopup
changePW	changePassword	changePeer	changeType
changeVersion	changedCAFile	changedFile	childrenMutated
correctIELayering	createComponent	createComponentNS	deleteComponent
disableCommandButton	doCancel	doFinish	doModified
doSave	dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	dropHandler	dropStartHandler	enableCommandButton
endModal	exposeComponent	findElement	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getEnclosingDiv	getHidden
getHintElement	getLabelElement	getOpener	getPageTitle
getProperty	getSettings	getTitleAreaHeight	getType
getVersion	goHome	goMenu	gotoNamespace
gotoPage	hideCommandButton	invokeSuper	isButtonDisabled
isOfType	launchPopupWindow	logout	makeId
navigate	onCreate	onDelete	onDisplayHandler
onEndModalHandler	onPopupAction	onRefreshContents	onSerialize
onServerMethodCall	onServerMethodError	onServerMethodReturn	onStartModalHandler
ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler
onlayoutHandler	onloadHandler	onlogoutHandler	onoverlayHandler
onresizeHandler	onunloadHandler	onupdateHandler	popupActionHandler
refreshContents	removeChild	render	renderContents
renderSVG	resetMsg	searchBlur	searchBoxHandler
searchFocus	searchKeyDown	searchKeyPress	setComponentId
setConnectivityStatusMsg	setHidden	setModified	setOverlayMode
setPageTitle	setProperty	setPropertyAll	setSortMode
setSortModeHandler	setTraceOption	setViewMode	setViewModeHandler
showAbout	showCommandButton	showContact	showDocumentation
showHelp	showMsg	startModal	startProgressBar
stopProgressBar	switchNamespace	testButtons	toggleOCSP
togglePW	trimSpace	validateRequired

Parameters

• parameter AUTONS = 0;

Do not switch namespace for this page: it needs to stay in %SYS

• parameter CSPURL = "/csp/sys/sec/%CSP.UI.Portal.SSL.zen";

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 HELPADDRESS = "System Administration,Security,SSL/TLS Configurations";

Each SMP page should set this link which points to the documentation anchor name.

• parameter PAGENAME = "SSL/TLS Configuration";

Displayed name of this page.

• parameter PARENTPAGE = "/csp/sys/sec/%CSP.UI.Portal.SSLList.zen";

This parameter defines the parent page for this page.
If the name ends in .csp, then the parent is assumed to be an autopage-enabled CSP page.
If the name ends in .cls, then the parent is assumed to be a Zen page.
This is used to automate the construction of the locator bar for this page and to build the index between portal pages and documentation.
The %GetLocatorInfo method is used to get this information.

• parameter RECENT = 0;

If true, register visits to this page in the recent list.

• parameter RESOURCE = "%Admin_Secure";

Security requirement

Properties

• property AllowTest as %Integer [ InitialExpression = 1 ];

Flag to indicate what to do with the Test and Save button. -1 = Both disabled; 0 = Test disabled; -10 = Test hidden; 1 = Test enabled

• property CipherDefault as %String;

Default Ciphersuites value

• property IsEditForm as %Boolean [ InitialExpression = 1 ];

If set to 1 then the generic Save and Cancel button will be shown on the ribbon bar.

• property Max as %String;

Keep TLSMinVersion

• property Min as %String;

Keep TLSMinVersion

• property PID as %String(ZENURL="PID");

ID for edit. Null if adding new configuration.

• property isMirror as %ZEN.Datatype.boolean(ZENURL="isMirror") [ InitialExpression = "0" ];

isMirror is 1 if this window is called from Mirroring Settings

• property isNew as %ZEN.Datatype.boolean(ZENURL="isNew") [ InitialExpression = "0" ];

• property pwModified as %ZEN.Datatype.boolean [ InitialExpression = "0" ];

Indicate if password is modified. If pwModified is 0 then at save time we won't save password.

Methods

• method %GetLocatorLinks(Output pLink) as %Status

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)

• method %OnAfterCreatePage() as %Status

Be sure to do ##super() when overriding.

• method %OnGetPageName() as %String

Get the (localized) name of the page. This should be implemented in a subclass.

• method LoadData(PID As %String) as %Status

Used when Editing an existing SSL/TLS configuration. Load previously defined values into fields.

• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status

Get information to display in the ribbon bar.

• classmethod SaveData(PID, isTest, Name, Description, Enabled, Type, VerifyPeer, CAFile, CRLFile, CertificateFile, PrivateKeyFile, PrivateKeyType, PrivateKeyPassword, CipherList, Ciphersuites, TLSMinVersion, TLSMaxVersion, TestHost, TestPort, pwModified, PWOptions, OCSP, OCSPIssuer, OCSPResp, OCSPTimeout, DHBits) as %ZEN.proxyObject [ ZenMethod ]

Save general association data to server Test can only be done for client, not server.

• method browseSelect(name, wildcard) [ Language = javascript ]

User clicked one of the Browse buttons. Save the name of the textfield so that when you return you know which textfield to update.

• method changePW() [ Language = javascript ]

User changed password. Update flag.

• method changePeer() [ Language = javascript ]

User changed Peer certificate verification level. If this is Type Server, and the Peer level is None then disable CAFile field. OW enable.

• method changeType() [ Language = javascript ]

User changed Type. Show/hide client/server credentials related fields.

• method changeVersion(MinVersion) [ Language = javascript ]

Change Min or Max Version

• method changedCAFile() [ Language = javascript ]

User changed CAFile. If not null, enable CRL file. OW, disable

• method changedFile() [ Language = javascript ]

User changed CertificateFile. If not null, enable Private password fields. OW, disable

• method doFinish() [ Language = javascript ]

End Add/Edit and return to list page. If this page is called from Mirror then close window.

• method doSave(isTest) [ Language = javascript ]

Get user input and send to server to save settings. If isTest is 1, user clicked the Test button. Then after saving, we'll do a TestConnection.

• method getPageTitle() as %String [ Language = javascript ]

Get the title string to add to the locator row.

• method getVersion(value) [ Language = javascript ]

• method onPopupAction(popupName, action, value) [ Language = javascript ]

This client event, if present, is fired when the a popup page launched from this page fires an action.

• method onloadHandler() [ Language = javascript ]

Set focus to the Name field.

• method testButtons() [ Language = javascript ]

-1 = Both disabled; 0 = Test disabled; -10 = Test hidden; 1 = Test enabled

• method toggleOCSP() [ Language = javascript ]

User changed OCSP option.

• method togglePW() [ Language = javascript ]

User changed PWOptions option. If they want to enter new password, show password fields. Otherwise hide them.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search