Home > Class Reference > ENSLIB namespace > Ens.Config.Credentials

Ens.Config.Credentials

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

SQL Table Name: Ens_Config.Credentials

Contains the authorization information needed to use a remote system.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DOMAIN = Ensemble;
Use our own domain for localization

Properties (Including Private)

property BusinessPartner as %String (CAPTION = "@Ensemble:BusinessPartner@BusinessPartner", MAXLEN = 255, XMLPROJECTION = "ATTRIBUTE");
Name of Business Partner Profile associated with this item.
Property methods: BusinessPartnerDisplayToLogical(), BusinessPartnerGet(), BusinessPartnerGetStored(), BusinessPartnerIsValid(), BusinessPartnerLogicalToDisplay(), BusinessPartnerLogicalToOdbc(), BusinessPartnerNormalize(), BusinessPartnerSet()
property Password as %CSP.Util.Passwd (CAPTION = "@Ensemble:Password@Password", MAXLEN = 200, XMLPROJECTION = "ATTRIBUTE") [ SqlFieldName = PasswordObject ];
Property methods: PasswordDisplayToLogical(), PasswordGet(), PasswordGetStored(), PasswordIsValid(), PasswordLogicalToDisplay(), PasswordLogicalToOdbc(), PasswordNormalize(), PasswordSQLCompute(), PasswordSQLDisplayToLogical(), PasswordSQLGet(), PasswordSQLIsValid(), PasswordSQLLogicalToDisplay(), PasswordSQLLogicalToOdbc(), PasswordSQLNormalize(), PasswordSQLSQLCompute(), PasswordSet()
property PasswordSQL as %String (MAXLEN = 200, XMLPROJECTION = "NONE") [ Calculated , SqlFieldName = Password ];
Property methods: PasswordSQLCompute(), PasswordSQLDisplayToLogical(), PasswordSQLGet(), PasswordSQLIsValid(), PasswordSQLLogicalToDisplay(), PasswordSQLLogicalToOdbc(), PasswordSQLNormalize(), PasswordSQLSQLCompute()
property SystemName as %String (CAPTION = "@Ensemble:SystemNameID@ID", XMLPROJECTION = "ATTRIBUTE") [ Required ];
Property methods: SystemNameCheck(), SystemNameDelete(), SystemNameDisplayToLogical(), SystemNameExists(), SystemNameGet(), SystemNameGetStored(), SystemNameIsValid(), SystemNameLogicalToDisplay(), SystemNameLogicalToOdbc(), SystemNameNormalize(), SystemNameOpen(), SystemNameSQLCheckUnique(), SystemNameSQLExists(), SystemNameSQLFindPKeyByConstraint(), SystemNameSQLFindRowIDByConstraint(), SystemNameSet()
property Username as %String (CAPTION = "@Ensemble:Username@Username", MAXLEN = 200, XMLPROJECTION = "ATTRIBUTE");
Property methods: UsernameDisplayToLogical(), UsernameGet(), UsernameGetStored(), UsernameIsValid(), UsernameLogicalToDisplay(), UsernameLogicalToOdbc(), UsernameNormalize(), UsernameSet()

Methods (Including Private)

private method %OnAddToSaveSet(depth As %Integer = 3, insert As %Integer = 0, callcount As %Integer = 0) as %Status [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
Clean up password if credentials object not saved but we already saved the password
private classmethod %OnDelete(oid As %ObjectIdentity) as %Status [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
Inherited description: 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 [ Language = objectscript ]
classmethod GetValue(pCredentialsID As %String, pCredentialName As %String) as %String [ Language = objectscript ]
method PasswordGet() as %CSP.Util.Passwd [ Language = objectscript ]
method PasswordSet(Arg As %CSP.Util.Passwd) as %Status [ Language = objectscript ]
classmethod SetCredential(pName As %String, pUsername As %String, pPassword As %String, pOverwrite As %Boolean = 0) as %Status [ Language = objectscript ]
Classmethod to create a new credential

Queries

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

Indexes

index (SystemName on SystemName) [IdKey, PrimaryKey, Type = key];
Index methods: SystemNameCheck(), SystemNameDelete(), SystemNameDisplayToLogical(), SystemNameExists(), SystemNameGet(), SystemNameGetStored(), SystemNameIsValid(), SystemNameLogicalToDisplay(), SystemNameLogicalToOdbc(), SystemNameNormalize(), SystemNameOpen(), SystemNameSQLCheckUnique(), SystemNameSQLExists(), SystemNameSQLFindPKeyByConstraint(), SystemNameSQLFindRowIDByConstraint(), SystemNameSet()

Triggers

trigger OnDelete (BEFORE event DELETE);

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: Storage (Ens.Config.Credentials)

^Ens.Conf.CredentialsD(ID)
=
%%CLASSNAME
Password
Username
BusinessPartner
PasswordSQL
Feedback