Class EnsLib.LDAP.Adapter.Outbound

class EnsLib.LDAP.Adapter.Outbound extends Ens.OutboundAdapter, EnsLib.LDAP.Adapter.Common

Ensemble LDAP Outbound Adapter that replaces deprecated EnsLib.LDAP.OutboundAdapter

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	2	2

Summary

Properties
%CredentialsObj	%CurrentCredentialsObject	%LDAPSession	%SASLServerCredentials
%WarnedLatest	Authenticated	BaseDN	BusinessHost
Connected	Credentials	CredentialsUsernameIsDN	IdleReconnectInterval
KeepaliveInterval	LDAPCACertFile	LDAPPort	LDAPSSLPort
LDAPServer	RegistryID	SASLPrivateKeyFile	SASLPublicKeyFile
SearchSizeLimit	SearchTimeout	StayConnected	ThoughtToBeConnected
UseSASLAuthentication	UseSSL	WindowsActiveDirectoryServer

Methods
%AddToSaveSet	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified
%DispatchSetMultidimProperty	%DispatchSetProperty	%Extends
%GetParameter	%IsA	%IsModified
%New	%NormalizeObject	%ObjectModified
%OriginalNamespace	%PackageName	%RemoveFromSaveSet
%SerializeObject	%SetModified	%ValidateObject
AddLDAPEntry	AddNewEntry	AddNewEntryParmArray
AssignOneSetting	Authenticate	Binds
ClearAllAppData	ClearRuntimeAppData	ClearStaticAppData
CompareCurrentLDAPEntryAttributeValue	CompareLDAPEntryAttributeValue	Connect
ConnectedSet	ConnectionIsValid	CountResults
CreateResultsArray	CreateStatusArray	CredentialsSet
DeleteCurrentLDAPEntry	DeleteLDAPEntry	Disconnect
EnumerateSettingsClose	EnumerateSettingsExecute	EnumerateSettingsFetch
FirstEntryDN	GetSettings	GetValues
HaveConnected	InitializeConnection	ModifyCurrent
ModifyCurrentParmArray	ModifyEntry	ModifyEntryParmArray
ModifyLDAPEntry	NextEntryDN	OnInit
OnKeepalive	OnTearDown	RenameCurrentLDAPEntry
RenameLDAPEntry	SASLBinds	Search
SearchWithPages	SessionHandleIsValid	SimpleBinds

Parameters

• parameter SETTINGS = "LDAPServer:Basic,Credentials:Basic:credentialsSelector,LDAPPort:Basic,LDAPSSLPort:Basic,UseSSL:Basic,UseSASLAuthentication:SASL,SASLPublicKeyFile:SASL,SASLPrivateKeyFile:SASL,BaseDN:LDAP,SearchTimeout:LDAP,SearchSizeLimit:LDAP,WindowsActiveDirectoryServer:LDAP,CredentialsUsernameIsDN:LDAP,LDAPCACertFile:LDAP,StayConnected:Connection,IdleReconnectInterval:Connection";

List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

• property IdleReconnectInterval as %Numeric(MINVAL=0) [ InitialExpression = 0 ];

How long of an idle period in seconds before disconnecting and reconnecting.
If StayConnected is 0 or positive then this value is ignored if it is less than StayConnected value.
This setting is intended to be used where the server has a configured user idle time or network appliances close inactive connections.
An IdleReconnectInterval of 0 means no checking of idle period for reconnection.

• property StayConnected as %Numeric(MINVAL=-1) [ InitialExpression = -1 ];

Stay connected to the remote system between handling Requests until idle for this number of seconds.
A value of -1 means maintain a connection. This is the default setting.
Reconnection during the Stay Connection period is based on the IdleReconnectInterval

Methods

• method OnInit() as %Status

Adapter code

• method OnKeepalive(pUnused As %Status) as %Status

This method is called from the Host.OnTask() method. It will be called within KeepaliveInterval of the last return from OnTask() or OnKeepalive().

Class Reference IRIS for UNIX 2024.1.2
Documentation Search