Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [Ens] >  [Config] >  [Credentials]
Private  Storage   

persistent class Ens.Config.Credentials extends %Persistent, %XML.Adaptor

Contains the authorization information needed to use a remote system.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 8 10 1 1 1


Summary

Properties
%Concurrency BusinessPartner Password PasswordSQL
SystemName Username

Methods
%%OIDGet %1Check %AddJrnObjToSyncSet %AddToSaveSet
%AddToSyncSet %BMEBuilt %BindExport %BuildIndices
%BuildIndicesAsync %BuildIndicesAsyncResponse %BuildIndicesSegment %BuildObjectGraph
%CheckConstraints %CheckConstraintsForExtent %ClassIsLatestVersion %ClassName
%Close %ComposeOid %ConstructClone %Delete
%DeleteExtent %DeleteId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DowngradeConcurrency %ExecuteAfterTriggers %ExecuteBeforeTriggers
%Exists %ExistsId %Extends %FileIndices
%FileIndicesBuffered %GUID %GUIDSet %GetLock
%GetParameter %GetSwizzleObject %Id %IncrementCount
%InsertBatch %IsA %IsModified %IsNull
%JournalObject %KillExtent %KillExtentData %LoadFromMemory
%LockExtent %LockId %New %NormalizeObject
%ObjectIsNull %ObjectModified %Oid %OnBeforeAddToSync
%OnDetermineClass %Open %OpenId %OriginalNamespace
%PackageName %PhysicalAddress %PurgeIndices %Reload
%RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack %SQLAcquireLock
%SQLAcquireTableLock %SQLAfterTriggers %SQLBeforeTriggers %SQLBuildIndices
%SQLBuildPurgeIndexForRow %SQLBuildPurgeIndices %SQLCheckUnique %SQLCheckUniqueIndices
%SQLCheckUniqueKeys %SQLCopyIcolIntoName %SQLCopyNameIntoIcol %SQLCreateInsDelTables
%SQLDefineiDjVars %SQLDelete %SQLDeleteChildren %SQLDeleteTempStreams
%SQLEExit %SQLExists %SQLFKeyDelLock %SQLFastInsert
%SQLFieldValidate %SQLGetLock %SQLGetOld %SQLGetOldAll
%SQLGetOldIndex %SQLInsert %SQLInsertComputes %SQLInsertStreams
%SQLInvalid %SQLInvalid2 %SQLMVDelete %SQLMVIndexDelete
%SQLMVIndexInsert %SQLMVIndexUpdate %SQLMVInsert %SQLMVUpdate
%SQLMissing %SQLNormalizeCompFields %SQLNormalizeFields %SQLPurgeIndices
%SQLQuickBulkInsert %SQLQuickBulkLoad %SQLQuickBulkSave %SQLQuickBulkUpdate
%SQLQuickDelete %SQLQuickDeleteChildren %SQLQuickFindPKeyByRowID %SQLQuickFindRowIDByPKey
%SQLQuickInsert %SQLQuickLoad %SQLQuickLoadChildren %SQLQuickLogicalToOdbc
%SQLQuickOdbcToLogical %SQLQuickUpdate %SQLReleaseLock %SQLReleaseTableLock
%SQLStorageValidation %SQLTrigDelTab %SQLTrigInsTab %SQLUnlock
%SQLUnlock2 %SQLUnlockError %SQLUnlockRef %SQLUpdate
%SQLUpdateComputes %SQLUpdateStreams %SQLValidateCompFields %SQLValidateFields
%SQLicompView %SQLnBuild %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %UpgradeConcurrency %ValidateIndices %ValidateObject
%XMLGenerate GetCredentialsObj GetValue PasswordGet
PasswordSet SetCredential XMLAfterExport XMLBeforeExport
XMLDTD XMLExport XMLExportInternal XMLExportToStream
XMLExportToString XMLGetSchemaImports XMLImport XMLImportInternal
XMLIsObjectEmpty XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Parameters

• parameter DOMAIN = "Ensemble";
Use our own domain for localization

Properties

• property BusinessPartner as %String(CAPTION="@Ensemble:BusinessPartner@BusinessPartner",MAXLEN=255,XMLPROJECTION="ATTRIBUTE");
Name of Business Partner Profile associated with this item.
• property Password as %CSP.Util.Passwd(CAPTION="@Ensemble:Password@Password",MAXLEN=200,XMLPROJECTION="ATTRIBUTE") [ SqlFieldName = PasswordObject ];
• property PasswordSQL as %String(MAXLEN=200,XMLPROJECTION="NONE") [ Calculated,SqlFieldName = Password ];
• property SystemName as %String(CAPTION="@Ensemble:SystemNameID@ID",XMLPROJECTION="ATTRIBUTE");
• property Username as %String(CAPTION="@Ensemble:Username@Username",MAXLEN=200,XMLPROJECTION="ATTRIBUTE");
• property modifiedPwd as %Boolean [ Private,InitialExpression = 0,Transient ];
• property statusPwdGet as %Status [ Private,InitialExpression = 1,Transient ];
• property statusPwdSet as %Status [ Private,InitialExpression = 1,Transient ];

Methods

• private method %OnAddToSaveSet(depth As %Integer = 3, insert As %Integer = 0, callcount As %Integer = 0) as %Status
This callback method is invoked when the current object is added to the SaveSet, either because %Save() was invoked on this object or on an object that references this object. %OnAddToSaveSet can modify the current object. It can also add other objects to the current SaveSet by invoking %AddToSaveSet or remove objects by calling %RemoveFromSaveSet.

If this method returns an error status then %Save() will fail and the transaction will be rolled back.

• private method %OnBeforeSave(insert As %Boolean) as %Status
This callback method is invoked by the %Save method to provide notification that the object is being saved. It is called before any data is written to disk.

insert will be set to 1 if this object is being saved for the first time.

If this method returns an error then the call to %Save will fail.

• private method %OnClose() as %Status
Clean up password if credentials object not saved but we already saved the password
• private classmethod %OnDelete(oid As %ObjectIdentity) as %Status
This callback method is invoked by the %Delete method to provide notification that the object specified by oid is being deleted.

If this method returns an error then the object will not be deleted.

• private method %OnOpen() as %Status
This callback method is invoked by the %Open method to provide notification that the object specified by oid is being opened.

If this method returns an error then the object will not be opened.

• classmethod GetCredentialsObj(Output pCredObj As Ens.Config.Credentials, pCallerClassname As %String, pCredClassname As %String, pCredentialsID As %String) as %Status
• classmethod GetValue(pCredentialsID As %String, pCredentialName As %String) as %String
• method PasswordGet() as %CSP.Util.Passwd
This is a Get accessor method for the Password property.
• method PasswordSet(Arg As %CSP.Util.Passwd) as %Status
This is a Set accessor method for the Password property.
• classmethod SetCredential(pName As %String, pUsername As %String, pPassword As %String, pOverwrite As %Boolean = 0) as %Status
Classmethod to create a new credential

Queries

• query List()
SQL Query :
Select ID,Username,'xxx' as Password,BusinessPartner from Ens_Config.Credentials

Indices

•index (SystemName on SystemName) [IdKey,PrimaryKey];

Triggers

•trigger OnDelete (BEFORE event DELETE)


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